[jvm]\
-constructor(sdk_key: String, base_uri: String, use_relay_proxy: Boolean = true, ssl: HttpClientSSLConfig? = null)
+constructor(sdk_key: String, base_uri: String, use_relay_proxy: Boolean = true, ssl: HttpClientSSLConfig? = null, event_capacity: Int = DEFAULT_CAPACITY)
diff --git a/0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/event_capacity/index.html b/0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/event_capacity/index.html new file mode 100644 index 0000000000..15a899b7cc --- /dev/null +++ b/0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/event_capacity/index.html @@ -0,0 +1,1170 @@ + + + + + + + + + + + + + + + + + + + + + + +//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/event_capacity
+[jvm]\ +val event_capacity: Int
+ + + + + + + + + + + + + + + + +//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig
[jvm]\ -data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val use_relay_proxy: Boolean = true, val ssl: HttpClientSSLConfig? = null) : Config
+data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val use_relay_proxy: Boolean = true, val ssl: HttpClientSSLConfig? = null, val event_capacity: Int = DEFAULT_CAPACITY) : Config[jvm]\
-constructor(sdk_key: String, base_uri: String, ssl: HttpClientSSLConfig? = null, offline: Boolean = false)
+constructor(sdk_key: String, base_uri: String, ssl: HttpClientSSLConfig? = null, offline: Boolean = false, event_capacity: Int = DEFAULT_CAPACITY)
diff --git a/0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/event_capacity/index.html b/0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/event_capacity/index.html new file mode 100644 index 0000000000..fb0715b6b9 --- /dev/null +++ b/0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/event_capacity/index.html @@ -0,0 +1,1170 @@ + + + + + + + + + + + + + + + + + + + + + + +//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/event_capacity
+[jvm]\ +val event_capacity: Int
+ + + + + + + + + + + + + + + + +//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig
[jvm]\ -data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val ssl: HttpClientSSLConfig? = null, val offline: Boolean = false) : Config
+data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val ssl: HttpClientSSLConfig? = null, val offline: Boolean = false, val event_capacity: Int = DEFAULT_CAPACITY) : ConfigReleases
Documentation
Related
Misk (Microservice Container in Kotlin) is an open source microservice container from Cash App. It allows you to quickly create a microservice in Kotlin or Java, and provides libraries for common concerns like serving endpoints, caching, queueing, persistence, distributed leasing and clustering. It also includes the Wisp library, which is a collection of Kotlin modules providing various features and utilities, including config, logging, feature flags and more.
It has been powering hundreds of microservices within Cash App since 2018.
"},{"location":"#a-tour-of-features","title":"A Tour of Features","text":"Want to jump right into it? Check out our Getting Started Guide.
What to know more about each module, see Developer Guide.
"},{"location":"actions/","title":"Actions","text":"Actions are Misk\u2019s unit for an endpoint. Misk lets you make HTTP actions, and gRPC actions via Wire.
"},{"location":"actions/#web-actions","title":"Web Actions","text":"Below are some example Web action declarations. Note that many of the annotations are optional.
Calls are authenticated at the service-level (service is listed in the @Authenticated annotation) or at the user-level (user has at least one of the capabilities listed in the @Authenticated annotation).
GET:
@Singleton\nclass HelloWebAction @Inject constructor() : WebAction {\n @Get(\"/hello/{name}\") // Enclose path parameters in {}\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n @Authenticated(services = [\"my-other-app\"], capabilities = [\"my-app_owners\"])\n fun hello(\n // Use @PathParam with the name of the param. Required if there's a param in the path pattern.\n @PathParam name: String,\n // RequestHeaders is optional:\n @RequestHeaders headers: Headers,\n // QueryParams are optional:\n @QueryParam nickName: String?, // e.g. /hello/abc?nickName=def\n @QueryParam greetings: List<String>? // e.g. /hello/abc?greetings=def&greetings=ghi\n ): HelloResponse {\n return HelloResponse(name)\n }\n}\nPOST:
@Singleton\nclass HelloWebPostAction @Inject constructor() : WebAction {\n @Post(\"/hello/{name}\")\n @RequestContentType(MediaTypes.APPLICATION_JSON)\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n @Authenticated(services = [\"my-other-app\"], capabilities = [\"my-app_owners\"])\n fun hello(\n @PathParam name: String, \n // RequestBody is optional, and is automatically deserialized to the provided type.\n @RequestBody body: PostBody\n ): HelloPostResponse {\n return HelloPostResponse(body.greeting, name)\n }\n}\n\ndata class HelloPostResponse(val greeting: String, val name: String)\n\ndata class PostBody(val greeting: String)\nInstall the action into a module:
class HelloModule : KAbstractModule() {\n override fun configure() {\n install(WebActionModule.create<HelloWebAction>())\n install(WebActionModule.create<HelloWebPostAction>())\n }\n}\nAnd then put that module onto the top level MiskApplication.
fun main(args: Array<String>) {\n MiskApplication(\n // ...\n HelloModule(), // new!\n ).run(args)\n}\nIf you change the action\u2019s response type to Response<T>, it gives you better control over the response status code and headers.
@Singleton\nclass HelloWebResponseAction @Inject constructor() : WebAction {\n @Get(\"/hello_but_203/{name}\")\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n fun hello(@PathParam name: String): Response<HelloResponse> = Response(\n statusCode = 203,\n headers = headersOf(),\n body = HelloResponse()\n )\n}\nIt\u2019s also possible to throw exceptions that are mapped to status codes.
@Singleton\nclass HelloWebResponseAction @Inject constructor() : WebAction {\n @Get(\"/no_access/{name}\")\n fun hello(@PathParam name: String): HelloResponse {\n throw UnauthenticatedException()\n }\n}\nMisk has support for gRPC actions via the Wire protocol buffer (protobuf) library.
To create a gRPC action, first define the relevant protos for your service. Let\u2019s say we\u2019re creating a GreeterService that exposes one API, Hello. Create this file in src/main/proto/hello.proto:
syntax = \"proto2\";\npackage squareup.cash.hello;\n\noption java_package = \"com.squareup.protos.cash.hello\";\n\nmessage HelloRequest {\n optional string message = 1;\n}\n\nmessage HelloResponse {\n optional string message = 1;\n}\n\nservice GreeterService {\n rpc Hello(HelloRequest) returns (HelloResponse) {}\n}\nNext, in your project\u2019s build file (for this example, build.gradle.kts), add a dependency on the wire plugin:
plugins {\n id(\"com.squareup.wire\")\n}\nAdd the following configuration to generate the gRPC interfaces for your service:
wire {\n sourcePath {\n srcDir(\"src/main/proto\")\n }\n\n kotlin {\n include(\"squareup.cash.hello.GreeterService\")\n rpcCallStyle = \"blocking\"\n rpcRole = \"server\"\n singleMethodServices = true\n }\n\n java {\n }\n}\nFinally, implement and bind your gRPC action. GreeterServiceHelloBlockingServer is generated by Wire.
@Singleton\nclass HelloGrpcAction @Inject internal constructor()\n : GreeterServiceHelloBlockingServer, WebAction {\n\n @Unauthorized\n override fun Hello(request: HelloRequest): HelloResponse {\n return HelloResponse(\"message\")\n }\n}\n\n// This module binds HelloGrpcAction.\nclass GreeterActionModule : KAbstractModule() {\n override fun configure() {\n install(WebActionModule.create<HelloGrpcAction>())\n }\n}\nCreating a gRPC action automatically creates a JSON endpoint with all of the same annotations in the path defined by the ...BlockingServer, typically /<package>.<service name>/<rpc name>.
You can also create a second class that extends WebAction to customize this further. Read more about HTTP actions in Web Actions. If you\u2019re building both a gRPC and a HTTP action, a common pattern is to have them both use a common dependency:
@Singleton\nclass HelloGrpcAction @Inject constructor(val greeter: Greeter)\n : GreeterServiceHelloBlockingServer, WebAction {\n @Unauthorized override fun hello() = HelloResponse(greeter.greet())\n}\n\n@Singleton\nclass HelloWebAction @Inject constructor(val greeter: Greeter) : WebAction {\n @Unauthorized\n @Get(\"/hello\")\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n fun hello() = HelloResponse(greeter.greet())\n}\n\n@Singleton\nclass Greeter @Inject constructor() {\n fun greet() = \"Hello world\"\n}\nActionScoped gives an action access to context produced by the action\u2019s interceptors.
Misk has a few ActionScoped items built in:
MiskCaller - access derived authorization detailsHttpCall - access lower level HTTP details, e.g. request headersUse tests annotated with @MiskTest to perform tests. There are two common patterns to testing actions:
Make sure that the module under test contains a Guice binding for the action and its dependencies, then inject your action.
class MyModule : KAbstractModule() {\n override fun configure() {\n install(WebActionModule.create<HelloWebAction>())\n // Alternatively, a direct or just-in-time binding might be sufficient.\n }\n}\n\n@MiskTest class MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var action: HelloWebAction\n\n // use action...\n}\nActionScoped","text":"Use @WithMiskCaller for ActionScoped<MiskCaller>:
@MiskTest\n@WithMiskCaller(user = \"test-user\") // or @WithMiskCaller(service = \"test-service\")\nclass MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var action: HelloWebAction // or any other class that injects ActionScoped<MiskCaller>\n\n // use action...\n}\nFor types other than MiskCaller, use ActionScope directly either within your setup and teardown test methods:
@MiskTest\nclass MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var actionScope: ActionScope\n @Inject lateinit var action: HelloWebAction // or any other class that injects ActionScoped<MyScopedObject>\n\n @BeforeEach fun setUp() {\n actionScope.create(\n mapOf(\n keyOf<MyScopedObject>() to MyScopedObject()\n )\n ).enter()\n }\n\n @AfterEach fun tearDown() {\n actionScope.close()\n }\n\n @Test fun test() {\n // use action...\n }\n}\n\u2026or within the test itself:
@MiskTest\nclass MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var actionScope: ActionScope\n @Inject lateinit var action: HelloWebAction\n\n @Test fun test() {\n actionScope.create(\n mapOf(\n keyOf<MyScopedObject>() to MyScopedObject()\n )\n ).inScope {\n // use action or class which injects ActionScoped<MyScopedObject>...\n }\n }\n}\nIt\u2019s possible to perform tests terminating at the app\u2019s HTTP/gRPC interface.
The module under test should include WebServerTestingModule so that Misk stands up a server during tests:
class MyModule : KAbstractModule() {\n override fun configure(){\n install(WebServerTestingModule())\n // install other modules...\n }\n}\nThen test HTTP requests using WebTestClient (assertions here were made using Kotest):
@MiskTest(startService = true)\nclass HelloWebIntegrationTest {\n @Suppress(\"unused\")\n @MiskTestModule val module = MyModule()\n\n @Inject lateinit var webTestClient: WebTestClient\n\n @Test\n fun `makes a call to the service`() {\n val response = webTestClient.post(\"/hello\", HelloRequest(\"world\"))\n response.response.code shouldBe 200\n response.parseJson<HelloResponse>() shouldBe HelloResponse(\"hello world\")\n }\n}\nTest gRPC requests by setting up a gRPC client pointing to the running app:
class MyServerModule : KAbstractModule() {\n override fun configure() {\n install(WebServerTestingModule())\n // Assume RobotLocatorWebAction is a gRPC action.\n install(WebActionModule.create<RobotLocatorWebAction>())\n }\n}\n\nclass MyClientModule(val jetty: JettyService): KAbstractModule() {\n override fun configure() {\n // Assume RobotLocator was generated via Wire.\n install(GrpcClientModule.create<RobotLocator, GrpcRobotLocator>(\"robots\"))\n }\n\n @Provides\n @Singleton\n fun provideHttpClientConfig(): HttpClientsConfig {\n return HttpClientsConfig(\n endpoints = mapOf(\n \"robots\" to HttpClientEndpointConfig(jetty.httpServerUrl.toString())\n )\n )\n }\n}\n\n@MiskTest(startService = true)\nclass RobotLocatorIntegrationTest {\n @Suppress(\"unused\")\n @MiskTestModule val module = MyServerModule()\n\n @Inject lateinit var jettyService: JettyService\n\n @Test \n fun `makes a call to the service`() {\n val robotLocator = Guice.createInjector(MyClientModule(jettyService))\n .getInstance<RobotLocator>()\n\n robotLocator.SayHello().executeBlocking(HelloRequest.builder().name(\"world\").build()) shouldBe \n HelloReply.Builder().message(\"hello world\").build()\n }\n}\nMisk releases since 2023-05-27 have been automatically published to Maven on PR merge to master.
The Changelog consequently will not be updated regularly since releases only include the changes of the last PR so the Changelog is now equivalent to the git commit history.
Major and breaking changes will still be documented in the Changelog.
"},{"location":"changelog/#2024-q2-summary","title":"2024 Q2 Summary","text":"Misk had a busy quarter with 98 PRs merged (over one per day!) from over 30 contributors.
From their efforts, numerous bug fixes, API improvements, and net-new functionality is now available to the growing community of developers building services with Misk.
"},{"location":"changelog/#thank-you-misk-contributors","title":"Thank you Misk Contributors!","text":"Misk has an active community of contributors giving back by upstreaming improvements, often motivated by their own experience building and operating Misk services.
Thanks to all who made Misk a better framework this quarter!
"},{"location":"changelog/#showcase-the-new-misk-ui-stack","title":"Showcase: The New Misk UI Stack","text":"Over the past year, the Misk admin dashboard has migrated to a new UI stack: kotlinx.html, Hotwire, and Tailwind UI.
This stack doesn\u2019t have a dedicated web build (ie. npm node modules, webpack\u2026) and has proven to be a lightweight, developer friendly stack for quickly shipping and maintaining simple UI from your Misk service. Builds are automatically part of your usual Gradle Misk Kotlin build which makes local development and CI builds fast and simple.
\u201cHaving a quick and easy way (for a backend eng \ud83d\ude05) to create custom UI is a power tool in your toolkit! It has helped us to creates internal utilities that makes operating and validate our services a walk in the park. I was able to successfully ship some new UI in one morning!\u201d \u2013 @frojasg
Developers have been surprised how fast they can ramp up and ship UI from their service, on the order of a few hours one morning, instead of a few weeks (or months) to build a full JS frontend app.
See the Exemplar service code in the repo for full examples of the new UI stack in use for building dedicated frontend apps, admin dashboard tabs, and more.
"},{"location":"changelog/#showcase-new-schema-migrator-gradle-plugin","title":"Showcase: New Schema Migrator Gradle Plugin","text":"Misk has shipped with a performant database schema migrator for years. It \u201cjust works\u201d ensuring table schemas are up to date and running migrations in local develompent and test environments.
Now, the Misk Schema Migrator is available as a standalone Gradle plugin for use without running the service or test suite. For some services previously forced to rely on a more complex plugin like Flyway to use libraries like jOOQ, the new Schema Migrator Gradle Plugin provides a simple way to get that functionality without new non-Misk dependencies. Additionally, the Schema Migrator Gradle Plugin is compatible with the Gradle config cache for optimal performance.
Check out the simple syntax and user docs here and try it for yourself today.
"},{"location":"changelog/#showcase-new-metadata-tab-in-the-misk-admin-dashboard","title":"Showcase: New Metadata tab in the Misk admin dashboard","text":"The new Metadata tab makes it easy to expose information from all parts of your running service. Find it at /_admin/metadata/!
The Metadata tab already includes the following information:
If you want to expose more metadata from Misk or your internal library or service, see the Exemplar service code.
"},{"location":"changelog/#showcase-new-requirerequest-utility-apis","title":"Showcase: New requireRequest utility APIs","text":"A common pattern in request validation is ensuring non-null request fields and throwing a BadRequestException otherwise. The new requireRequestNotNull utility API does this in a single line, reducing boilerplate and making the code more readable.
Before
requireRequest(request.parameter != null) { \"parameter must not be null\" }\n\n// later, safe do because of previous null check\nrequest.parameter!!\nAfter
requireRequestNotNull(request.parameter) { \"parameter must not be null\" }\n\n// later - no need for !!\nrequest.parameter\nMisk is open for PRs if there are other broad usage utility functions which would be beneficial to offer to all users of Misk.
"},{"location":"changelog/#version-20240709","title":"Version 2024.07.09","text":"Breaking changes:
@AllowAnyService annotation (which has been deprecated for months, was rarely used, and has no more internal usage), use @Authenticated(allowAnyService = true) instead. @Authenticated annotation, explicit passing of non-empty parameters capabilities, users, allowAnyUser, or allowAnyService is now required. Instead of the existing soft-failure error log behavior, an IllegalArgumentException will be thrown if the annotation constructor is empty.@Authenticated (empty constructor).Breaking changes:
@ExperimentalMiskApi to TaggedLogger. Any code that uses this class will need to @OptIn(ExperimentalMiskApi::class).Breaking changes:
BETA_PREFIX val which was used to gate development of the new v2 admin dashboard. It has been deprecated since 2023-06-30 when the v2 admin dashboard was promoted to /_admin/.Breaking changes:
Breaking changes:
New features and fixes:
Thank you to all the contributors, as always.
Breaking changes:
New features:
Fixes:
List<Client*Interceptor> to be bound when using TypedClientFactory stand-alone (#2218)Breaking changes:
/error action is no longer installed by default (#2190)New features and fixes:
Public release.
"},{"location":"changelog/#version-0200-2021-08-31","title":"Version 0.20.0 (2021-08-31)","text":"Breaking changes:
New features and fixes:
Public release.
"},{"location":"changelog/#version-0180-2021-06-28","title":"Version 0.18.0 (2021-06-28)","text":"Public release.
"},{"location":"changelog/#version-0171-2021-04-29","title":"Version 0.17.1 (2021-04-29)","text":"Public release.
"},{"location":"changelog/#version-0170-2021-04-28","title":"Version 0.17.0 (2021-04-28)","text":"Public release.
"},{"location":"changelog/#version-0160-2020-12-17","title":"Version 0.16.0 (2020-12-17)","text":"Public release.
"},{"location":"changelog/#version-0150-2020-12-03","title":"Version 0.15.0 (2020-12-03)","text":"Public release.
"},{"location":"changelog/#version-0140-2020-11-12","title":"Version 0.14.0 (2020-11-12)","text":"Public release.
"},{"location":"changelog/#version-0130-2020-07-16","title":"Version 0.13.0 (2020-07-16)","text":"Public release.
"},{"location":"changelog/#version-0120-2020-05-06","title":"Version 0.12.0 (2020-05-06)","text":"Public release.
"},{"location":"changelog/#version-0110-2020-02-25","title":"Version 0.11.0 (2020-02-25)","text":"Public release.
"},{"location":"changelog/#version-0100-2019-01-21","title":"Version 0.10.0 (2019-01-21)","text":"Public release.
"},{"location":"changelog/#version-090-2019-12-06","title":"Version 0.9.0 (2019-12-06)","text":"Public release.
"},{"location":"changelog/#version-080-2019-10-22","title":"Version 0.8.0 (2019-10-22)","text":"Public release.
"},{"location":"changelog/#version-070-2019-08-26","title":"Version 0.7.0 (2019-08-26)","text":"Public release.
"},{"location":"changelog/#version-025-2018-06-11","title":"Version 0.2.5 (2018-06-11)","text":""},{"location":"changelog/#new","title":"New","text":"Initial release.
"},{"location":"clients/","title":"Clients","text":"Misk provides configurable HTTP clients built on top of OkHttp and Retrofit, and gRPC clients built on top of Wire.
"},{"location":"clients/#http-clients","title":"HTTP Clients","text":""},{"location":"clients/#config","title":"Config","text":"Set up a Config object (and use MiskConfig.load to load config from a YAML file):
data class MyServiceConfig(\n val http_clients: HttpClientsConfig,\n // ...\n) : Config\nIn the configuration YAML, specify the target service\u2019s address:
http_clients:\n ...\n endpoints:\n ...\n greeter: { url: \"https://hello.example.com\" }\nUse HttpClientModule:
class MyClientModule : KAbstractModule() {\n override fun configure() {\n install(HttpClientModule(\n // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n name = \"greeter\",\n // Optional annotation to define how you inject your client dependency\n annotation = Names.named(\"greeterHttp\")\n ))\n }\n}\nThis binds an OkHttpClient that you can inject:
class MyClient @Inject constructor(@Named(\"greeterHttp\") val client: OkHttpClient) {\n fun callGreeter() {\n val response = client.newCall(\n Request.Builder()\n .url(\"http://localhost:8080/hello\")\n .build()\n ).execute()\n }\n}\nFirst, create a Retrofit interface. See the Retrofit docs for more details.
interface GreeterApi {\n @POST(\"/hello\")\n @Headers(value = [\"accept: application/json\"])\n fun hello(\n @Body request: HelloRequest\n ): Call<HelloResponse>\n}\nNext, install a TypedHttpClientModule with this interface.
class HelloClientModule : KAbstractModule() {\n override fun configure() {\n install(\n TypedHttpClientModule(\n GreeterApi::class, \n // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n name = \"greeter\", \n // Optional annotation to define how you inject your client dependency\n annotation = Names.named(\"greeterApi\")\n )\n )\n }\n}\nNow you can inject an implementation of this client:
@Singleton class MyApiClient @Inject constructor(\n @Named(\"greeterApi\") private val api: GreeterApi\n) {\n fun hello(message: String): String {\n val response = api.hello(\n HelloRequest(\n message = message\n )\n ).execute()\n }\n}\nFirst, include the auto-generated gRPC client code at the caller module using the Wire Gradle plugin.
plugins {\n id(\"com.squareup.wire\")\n}\n\nwire {\n sourcePath {\n srcDir(\"src/main/proto\")\n }\n\n // Generate Kotlin for the gRPC client API.\n kotlin {\n // Set this to false if you're generating client and server interfaces in one module\n exclusive = false\n includes (\"squareup.cash.hello.GreeterService\")\n rpcRole = \"client\"\n }\n\n java {\n }\n}\nNext, bind your client in code in a similar fashion to an HTTP client. Set up client configuration, as described in Config. Then, bind a GrpcClientModule:
class GreeterClientModule : KAbstractModule() {\n override fun configure() {\n install(GrpcClientModule.create<GreeterServiceClient, GrpcGreeterServiceClient>(\n // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n name = \"greeter\",\n // Optional annotation to define how you inject your client dependency\n annotation = Names.named(\"greeterGrpc\")\n ))\n }\n}\nWith this all setup, you can now inject your client in source code and connect via gRPC:
internal class GrpcGreeterServiceClient @Inject internal constructor(\n @Named(\"greeterGrpc\") private val greeterGrpc: GreeterServiceClient\n) {\n fun get(message: String) {\n val response = greeterGrpc.Hello().executeBlocking(HelloRequest(message))\n\n // ... do something with the response here\n }\n}\nIf you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA).
"},{"location":"contributing/#building-misk-locally","title":"Building Misk locally","text":"Install and activate hermit: https://cashapp.github.io/hermit/
Use gradle to run all Kotlin tests locally:
gradle build\nmisk-hibernate tests expect a mysql server running on localhost:3306 with no password set on the root user. You might stand up a server with a docker image, e.g.
docker run -d --rm --name \"mysql-57\" -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=true -e MYSQL_LOG_CONSOLE=true mysql:5.7 --sql-mode=\"\"\nMisk may download these Docker images as part of its tests. Because tests can time out, pre-downloading these can help resolve timeouts.
alpine:latest\namazon/dynamodb-local:latest\ncockroachdb/cockroach\ngcr.io/cloud-spanner-emulator/emulator\npingcap/tidb\npostgres\nredis:6.2-alpine\nsoftwaremill/elasticmq\nvitess/base\nNote: Remember to document breaking changes in CHANGELOG.md.
We integrate Kotlin Binary Compatibility Validator into our build pipeline to automatically detect breaking changes that could affect existing clients.
"},{"location":"contributing/#kotlin-binary-compatibility-validator","title":"Kotlin Binary Compatibility Validator","text":"This tool checks for changes to the public binary API. The plugin generates a dump of the current API and compares it to the previous version. If a binary incompatibility is detected, the build will fail.
If the change is intentional, you can run the :apiDump task and commit the resulting changes to the .api files. .api files should not have removals and additions in the same change so that downstream apps do not immediately run into backwards-compatibility issues.
This runs as part of gradle check task, or you can call directly with gradle apiCheck.
Actions are Misk\u2019s unit for an endpoint. Misk lets you make HTTP actions, and gRPC actions via Wire.
Learn more about Misk actions
"},{"location":"developer-guide/#interceptors","title":"Interceptors","text":"Misk uses interceptors (middleware) to observe and potentially transform HTTP messages. The pattern is borrowed from OkHttp Interceptors.
Learn more about Misk interceptors
"},{"location":"developer-guide/#clients","title":"Clients","text":"Misk provides configurable HTTP clients built on top of OkHttp and Retrofit, and gRPC clients built on top of Wire.
Learn more about how to create, configure and test HTTP clients or gRPC clients within a Misk application here.
"},{"location":"developer-guide/#tests","title":"Tests","text":"Misk provides a few ways to streamline testing with JUnit.
Learn more about Misk tests
"},{"location":"developer-guide/#modules","title":"Modules","text":"Misk provides dozens of modules to facilitate the development and deployment of applications, and the integration with clouds and various common technologies.
Learn more about Misk modules
"},{"location":"developer-guide/#wisp","title":"Wisp","text":"Wisp is a collection of kotlin modules providing various features and utilities, including config, logging, feature flags and more. It is basically extracted Misk functionality without Dependency Injection (i.e., no Guice).
Learn more about Wisp.
"},{"location":"getting-started/","title":"Getting Started","text":"The easiest way to get started is to copy the Misk exemplar project. This exemplar contains a Misk web app with the requisite dependencies.
"},{"location":"getting-started/#prerequisites","title":"Prerequisites","text":"Misk relies on hermit to install tools required to develop and run the service. Please follow this to install and activate hermit.
Misk uses Gradle to build and run test locally.
"},{"location":"getting-started/#start-the-service","title":"Start the service","text":"Run ExemplarService#main from your IDE, or use gradle to run:
gradle run\nA Misk application is wired together using Guice. Features of Misk are managed by Guava Services, provided by Guice Modules, and configured using Misk Configs. For example, if your application needs a Redis cache, you would install RedisModule, and add a corresponding RedisConfig to your application\u2019s config YAML.
Misk is unopinionated about which of its features your application chooses to use, and offers multiple alternatives for some common concerns.
"},{"location":"getting-started/#the-main-function","title":"The main function","text":"The entry point to every Misk application is MiskApplication:
fun main(args: Array<String>) {\n val environment = Environment.fromEnvironmentVariable()\n val env = Env(environment.name)\n val config = MiskConfig.load<ExemplarConfig>(\"exemplar\", env)\n\n MiskApplication(\n MiskRealServiceModule(),\n MiskWebModule(config.web),\n ExemplarAccessModule(),\n ExemplarWebActionsModule(),\n\n // e.g. to add an admin dashboard:\n AdminDashboardModule(isDevelopment = true)\n ).run(args)\n}\nEvery Misk application has a top-level class that implements the Config marker interface. This Config encapsulates all of the configuration for the app.
By default, configs are loaded from YAML files at the app\u2019s resources root. Each value in the config must have a corresponding entry in the YAML file.
Modules in Misk that require configuration usually have their own Config objects. If you want to use the Module in your app, you should add them as properties of your app\u2019s Config object, for example:
data class MyAppConfig(\n val my_config_value: String,\n val http_clients: HttpClientsConfig\n) : Config\nThis then corresponds to a YAML file:
my_config_value: \"this value\"\n\nhttp_clients:\n # ... config\nConfigs are loaded using the app\u2019s resource loader. The config loader looks for files in the following order by default:
$SERVICE_NAME-common.yaml$SERVICE_NAME-$ENVIRONMENT.yamlAt least one of $SERVICE_NAME-common.yaml or $SERVICE_NAME-$ENVIRONMENT.yaml must exist.
Values from later files take precedence.
"},{"location":"getting-started/#write-an-endpoint","title":"Write an endpoint","text":"Actions are Misk\u2019s unit for an endpoint.
Actions inherit from WebAction and have a @Get/@Post annotation:
@Singleton\nclass HelloWebAction @Inject constructor() : WebAction {\n @Get(\"/hello/{name}\")\n @Unauthenticated\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n fun hello(\n @PathParam name: String,\n ): HelloResponse {\n return HelloResponse(name)\n }\n}\n\ndata class HelloResponse(val name: String)\nRead more about this in Actions.
"},{"location":"getting-started/#test-the-endpoint","title":"Test the endpoint","text":"You can unit test directly:
class HelloWebActionTest {\n @Test\n fun `tests the unit`() {\n assertThat(HelloWebAction().hello(\"sandy\", headersOf(), null, null))\n .isEqualTo(HelloResponse(\"sandy\"))\n }\n}\nIntegration tests set up a module for you, and adds an injector to the test class.
You can use WebServerTestingModule to set up a running web server and make WebTestClient available.
@MiskTest(startService = true)\nclass HelloWebActionTest {\n @MiskTestModule val module = TestModule()\n\n @Inject private lateinit var webTestClient: WebTestClient\n\n @Test\n fun `tests a request being made`() {\n val hello = webTestClient.get(\"/hello/sandy\")\n assertThat(hello.response.code).isEqualTo(200)\n assertThat(hello.parseJson<HelloResponse>())\n .isEqualTo(HelloResponse(\"sandy\"))\n }\n\n class TestModule : KAbstractModule() {\n override fun configure() {\n install(WebServerTestingModule())\n install(HelloModule())\n }\n }\n}\nRead more about this in Actions
"},{"location":"getting-started/#create-services","title":"Create services","text":"The main function is just an entry point for wiring together components of Misk. Long-running threads that do the real work are written as Services using Guava\u2019s Service Framework.
A Service is bound by installing a ServiceModule, for example:
class MyServiceModule : KAbstractModule() {\n override fun configure() {\n install(ServiceModule<MyService>())\n }\n}\nNotice that in this example we use KAbstractModule(), Misk\u2019s Kotlin wrapper for AbstractModule, as our base Module class.
MiskApplication will start all services installed by a ServiceModule.
If there is a Service that must be run after a other set of Services have started, the service dependency graph should be specified at the installation site.
For example, if you are operating a movie service, which needs a database:
class MovieServiceModule : KAbstractModule() {\n override fun configure() {\n // Note that DatabaseService does not have to be installed here.\n // It could be installed in another KAbstractModule if preferred.\n install(ServiceModule<DatabaseService>())\n\n // Multiple dependencies can be added by chaining calls to `dependsOn`.\n install(ServiceModule<MovieService>()\n .dependsOn<DatabaseService>())\n }\n}\nServiceModule for more details about the service graph. When writing Services, always prefer to inherit from one of the common base classes: AbstractIdleService, AbstractScheduledService, or AbstractExecutionThreadService. See Services Explained for details. If your service is can make use of exponential backoff and scheduling, take a look at using RepeatedTaskQueue.
Misk has interceptors (middleware) to observe & potentially transform HTTP messages. The pattern borrows from OkHttp Interceptors.
Interceptors can be for inbound calls to Misk\u2019s Jetty webserver from an external client, or outbound calls from Misk\u2019s OkHttpClient to an external service.
Interceptors can be network interceptors that operate on the encoded HTTP messages, or application interceptors that operate on decoded value objects.
Misk has both built-in interceptors and user-provided interceptors. In all cases, interceptors must be registered with a Guice multibinding.
"},{"location":"interceptors/#inbound-network-interceptors","title":"Inbound Network Interceptors","text":"These run for inbound HTTP calls into Misk.
They may short-circuit the inbound calls, preventing the calls from ever reaching the destination action. For example, the concurrency limiting (ie. load shedding) interceptor short-circuits inbound calls when it predicts a timeout. Inbound calls may also be short-circuited if authentication headers are absent or inadequate.
/** This sample interceptor decompresses the inbound request body. */\nclass GunzipRequestBodyInterceptor : NetworkInterceptor {\n override fun intercept(chain: NetworkChain) {\n val httpCall = chain.httpCall\n val contentEncoding = httpCall.requestHeaders[CONTENT_ENCODING]\n ?: return chain.proceed(httpCall)\n if (contentEncoding.lowercase() == GZIP) {\n httpCall.takeRequestBody()?.let {\n httpCall.putRequestBody(GzipSource(it).buffer())\n }\n }\n chain.proceed(httpCall)\n }\n}\nThough inbound interceptors may rewrite the inbound request, they generally run too late to rewrite the outbound response. In particular, by the time the proceed() call returns, the outbound HTTP response has already been encoded and transmitted.
The built-in inbound network interceptors are:
Multibind these with NetworkInterceptor.Factory.
These run after the network interceptors, and after the request body has been decoded into the type specified by the target action.
class RequestBodyLoggingInterceptor: ApplicationInterceptor {\n override fun intercept(chain: Chain): Any {\n val result = chain.proceed(chain.args)\n log(\"Request arguments: ${chain.args}, response value: $result\")\n return result\n }\n}\nWorking in this layer is convenient because the chain argument has the action, its args, its function, and its HttpCall. Because the action is already selected and its arguments are already decoded, this layer cannot be used to rewrite the bytes of the request! But it can change the arguments to the function (in a type-safe way).
The built-in inbound application interceptors are:
Multibind these with ApplicationInterceptor.Factory.
On inbound calls, network interceptors run before application interceptors. On outbound calls, the ordering is reversed: application interceptors run first.
Outbound application interceptors use OkHttp\u2019s Interceptor type for calls. Multibind these using ClientApplicationInterceptorFactory.
class LoggingInterceptor : Interceptor {\n\n override fun intercept(chain: Interceptor.Chain): Response {\n val response = chain.proceed(chain.request())\n log(\"Call to ${targetName(chain)} returned ${response.code}\")\n return response\n }\n\n private fun targetName(chain: Interceptor.Chain): String? {\n val invocation = chain.request().tag(Invocation::class.java)\n if (invocation != null) return \"$clientName.${invocation.method().name}\"\n\n val grpcMethod = chain.request().tag(GrpcMethod::class.java)\n if (grpcMethod != null) return \"$clientName.${grpcMethod.path.substringAfterLast(\"/\")}\"\n\n return null\n }\n}\nCalls made via Retrofit or the Wire gRPC client have metadata objects available as tags on the HTTP request. You can use these to find out which Retrofit method was called (and its arguments), or which gRPC method was called.
In these interceptors it\u2019s possible to rewrite the request body, request URL, and request headers. It\u2019s also possible to rewrite the returned response body, headers, or status code. You might do this to inject a missing response header or remove one.
The built-in outbound application interceptors are:
Multibind these with ClientApplicationInterceptorFactory.
These run on outbound calls after the outbound application interceptors. These run after the socket connection to the remote HTTP server has been established.
class LoggingInterceptor : ClientNetworkInterceptor {\n override fun intercept(chain: ClientNetworkChain): Response {\n log(\"executing ${chain.action}\")\n return chain.proceed(chain.request)\n }\n}\nNetwork interceptors cannot rewrite the destination hostname or URL. They can rewrite outbound request bodies and request headers. They can also rewrite returned status codes, bodies and headers.
Misk has no built-in network interceptors.
Multibind these with ClientNetworkInterceptor.Factory.
Misk is split into many Gradle subprojects to organize functionality and create smaller dependencies for downstream users. Integrations with external libraries (like DynamoDB, Hibernate, etc.) should each live in their own module.
Misk uses the Gradle test fixtures plugin to colocate production code with any relevant test helper classes. However, there are some *-testing modules that haven\u2019t yet been migrated to test fixtures.
Most of the implementation of Misk\u2019s web server components.
This is the original monolithic module. Pieces are being extracted into new modules to align with the smaller module strategy.
"},{"location":"modules/#misk-actions","title":"misk-actions","text":"The core annotations and interfaces necessary to define actions that can be hosted in Misk. This package has no dependency on the enclosing container (Misk!) and so your actions can be used in other environments without any heavy dependencies.
Actions should extend WebAction, be annotated with a HTTP method like @Post, accept a request object and return a response object. Throw an exception like BadRequestException to fail the request without much boilerplate.
High level interfaces and data classes which are implemented by both misk and wisp modules. This module is agnostic to implementation details.
"},{"location":"modules/#misk-aws","title":"misk-aws","text":"Integrate with Amazon Web Services, and includes packages to integrate with S3 and SQS.
"},{"location":"modules/#misk-aws-dynamodb","title":"misk-aws-dynamodb","text":"Integrate with AWS DynamoDb using AWS SDK for Java 1.x. It should be safe to install side-by-side with misk-aws2-dynamodb if you need to use features in both.
Integrate with this package to write tests for code that interacts with DynamoDb. Exposes APIs via AWS SDK for Java 1.x. Use alongside with misk-aws-dynamodb.
Installing InProcessDynamoDbModule runs a DynamoDb Local instance in memory for your tests to run against. This module is recommended over DockerDynamoDbModule because there is less overhead in test execution performance.
Installing DockerDynamoDbModule runs a DynamoDB Local instance in Docker for your tests to execute against.
Integrate with AWS DynamoDb using AWS SDK for Java 2.x. It should be safe to install side-by-side with misk-aws-dynamodb if you need to use features in both.
Please read the AWS SDK for Java 2.x Migration Guide for more details.
"},{"location":"modules/#misk-aws2-dynamodb-testing","title":"misk-aws2-dynamodb-testing","text":"Integrate with this package to write tests for code that interacts with DynamoDb. Exposes APIs via AWS SDK for Java 2.x. Use alongside with misk-aws2-dynamodb.
Installing InProcessDynamoDbModule runs a DynamoDb Local instance in memory for your tests to run against. This module is recommended over DockerDynamoDbModule because there is less overhead in test execution performance.
Installing DockerDynamoDbModule runs a DynamoDB Local instance in Docker for your tests to execute against.
A collection of utility functions and interfaces that are used in many places.
"},{"location":"modules/#misk-service","title":"misk-service","text":"Bind Guava services with inter-service dependencies.
Any service can depend on any other service. ServiceManager won\u2019t start a service until the services it depends on are running.
"},{"location":"modules/#misk-inject","title":"misk-inject","text":"Integrates Guice with Kotlin.
Extending KAbstractModule instead of Guice\u2019s AbstractModule lets you use KClass instead of java.lang.Class and other conveniences.
Runtime feature flags. misk-launchdarkly is the reference implementation.
A job queue with a high quality fake. AwsSqsJobQueueModule from misk-aws is the reference implementation.
An event publisher + consumer. There is no open source reference implementation at this time.
"},{"location":"modules/#wisp","title":"wisp.*","text":"These modules were created to extract specific pieces of functionality out of the misk* modules into new, low-dependency modules. They were especially focused on having no Guice dependencies. Some of these modules duplicate existing Misk functionality, but over time implementations will be deduplicated as part of broader code cleanup efforts.
Our release process is designed to be hands-off and automatic. This document aims to provide an understanding of the automated workflow we use to release new versions of Misk repository, along with insights into how to troubleshoot potential publishing issues.
"},{"location":"releasing/#prerequisites","title":"Prerequisites","text":"Before proceeding with the release process, ensure the following: - You have read CONTRIBUTING.md - build.gradle.kts is properly configured with the correct publishing configurations and publishing plugin is applied - If you are changing the publication details, it is recommended that you have the necessary permissions and credentials to publish artifacts to Sonatype Nexus Repository (OSSRH)
This repository is set up with an automated workflow using GitHub Actions. - The workflow is triggered as soon as a pull request is merged into the master branch. - A version number is dynamically generated and assigned to the release - The artifacts are published to Sonatype Nexus to a staging repository - Sonatype performs various checks and validations on the artifacts - Once verified, these artifacts are promoted and eventually synchronized to Maven Central - Public builds can be found here
While our release process is designed to be seamless, occasionally, issues may arise that require attention. Here are some tips to help diagnose:
Misk provides a few ways to streamline testing with JUnit.
Without Misk, you would instantiate units under test and their dependencies:
class FeatureWithoutMiskTest {\n @Test \n fun `tests something`() {\n val repository = MyRepository()\n val handler = MyHandler(repository)\n\n // ... perform assertions\n }\n}\n@MiskTest","text":"@MiskTest will stand up a Misk app given a provided module and then inject members onto the test class. For instance, with a test that looks like this:
@MiskTest(startService = true)\nclass HelloWebIntegrationTest {\n @MiskTestModule val module = MyTestingModule()\n\n @Inject lateinit var myHandler: MyHandler\n\n @Test\n fun `makes a call to the service`() {\n // use myHandler...\n }\n}\n\nclass MyTestingModule : KAbstractModule() {\n override fun configure() {\n // add modules, declare bindings...\n }\n}\n@MiskTest signals to JUnit to honour the other annotations.@MiskTestModule declares which module to use to perform the tests in this class. This module (or a sub-module under it) should have a binding for MyHandler, which gets injected in the test class.Some common domains to test:
//bucket4j
"},{"location":"0.x/bucket4j/#bucket4j","title":"bucket4j","text":""},{"location":"0.x/bucket4j/#packages","title":"Packages","text":"Name wisp.ratelimiting.bucket4j"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/","title":"Package-level declarations - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/#types","title":"Types","text":"Name Summary Bucket4jPruner [jvm]abstract class Bucket4jPruner : RateLimitPruner Bucket4jRateLimiter [jvm]class Bucket4jRateLimiter@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter ClockTimeMeter [jvm]class ClockTimeMeter(clock: Clock) : TimeMeter"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/","title":"Bucket4jPruner - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#bucket4jpruner","title":"Bucket4jPruner","text":"[jvm]\\ abstract class Bucket4jPruner : RateLimitPruner
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#constructors","title":"Constructors","text":"Bucket4jPruner [jvm]constructor()"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]abstract val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]abstract fun prune()"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/-bucket4j-pruner/","title":"Bucket4jPruner - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner/Bucket4jPruner
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/-bucket4j-pruner/#bucket4jpruner","title":"Bucket4jPruner","text":"[jvm]\\ constructor()
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner/clockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"[jvm]\\ abstract val clockTimeMeter: ClockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/","title":"Bucket4jRateLimiter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#bucket4jratelimiter","title":"Bucket4jRateLimiter","text":"[jvm]\\ class Bucket4jRateLimiter@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#constructors","title":"Constructors","text":"Bucket4jRateLimiter [jvm]@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#functions","title":"Functions","text":"Name Summary availableTokens [jvm]open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long consumeToken [jvm]open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData releaseToken [jvm]open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long) resetBucket [jvm]open override fun resetBucket(key: String, configuration: RateLimitConfiguration) testConsumptionAttempt [jvm]open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult withToken [jvm]open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/-bucket4j-rate-limiter/","title":"Bucket4jRateLimiter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/Bucket4jRateLimiter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/-bucket4j-rate-limiter/#bucket4jratelimiter","title":"Bucket4jRateLimiter","text":"[jvm]\\
@JvmOverloads
constructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/available-tokens/","title":"availableTokens - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/availableTokens
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/available-tokens/#availabletokens","title":"availableTokens","text":"[jvm]\\ open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/consume-token/","title":"consumeToken - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/consumeToken
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/consume-token/#consumetoken","title":"consumeToken","text":"[jvm]\\ open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/release-token/","title":"releaseToken - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/releaseToken
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/release-token/#releasetoken","title":"releaseToken","text":"[jvm]\\ open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/reset-bucket/","title":"resetBucket - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/resetBucket
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/reset-bucket/#resetbucket","title":"resetBucket","text":"[jvm]\\ open override fun resetBucket(key: String, configuration: RateLimitConfiguration)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/test-consumption-attempt/","title":"testConsumptionAttempt - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/testConsumptionAttempt
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/test-consumption-attempt/#testconsumptionattempt","title":"testConsumptionAttempt","text":"[jvm]\\ open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/","title":"ClockTimeMeter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#clocktimemeter","title":"ClockTimeMeter","text":"[jvm]\\ class ClockTimeMeter(clock: Clock) : TimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#constructors","title":"Constructors","text":"ClockTimeMeter [jvm]constructor(clock: Clock)"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#functions","title":"Functions","text":"Name Summary currentTimeNanos [jvm]open override fun currentTimeNanos(): Long isWallClockBased [jvm]open override fun isWallClockBased(): Boolean"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/-clock-time-meter/","title":"ClockTimeMeter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/ClockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/-clock-time-meter/#clocktimemeter","title":"ClockTimeMeter","text":"[jvm]\\ constructor(clock: Clock)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/current-time-nanos/","title":"currentTimeNanos - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/currentTimeNanos
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/current-time-nanos/#currenttimenanos","title":"currentTimeNanos","text":"[jvm]\\ open override fun currentTimeNanos(): Long
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/is-wall-clock-based/","title":"isWallClockBased - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/isWallClockBased
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/is-wall-clock-based/#iswallclockbased","title":"isWallClockBased","text":"[jvm]\\ open override fun isWallClockBased(): Boolean
"},{"location":"0.x/detektive/","title":"detektive - Misk","text":"//detektive
"},{"location":"0.x/detektive/#detektive","title":"detektive","text":""},{"location":"0.x/detektive/#packages","title":"Packages","text":"Name cash.detektive cash.detektive.javacompat"},{"location":"0.x/detektive/detektive/cash.detektive/","title":"Package-level declarations - Misk","text":"//detektive/cash.detektive
"},{"location":"0.x/detektive/detektive/cash.detektive/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/detektive/detektive/cash.detektive/#types","title":"Types","text":"Name Summary DetektiveRuleSetProvider [jvm]class DetektiveRuleSetProvider : RuleSetProvider"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/","title":"DetektiveRuleSetProvider - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#detektiverulesetprovider","title":"DetektiveRuleSetProvider","text":"[jvm]\\ class DetektiveRuleSetProvider : RuleSetProvider
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#constructors","title":"Constructors","text":"DetektiveRuleSetProvider [jvm]constructor()"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#properties","title":"Properties","text":"Name Summary ruleSetId [jvm]open override val ruleSetId: String"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#functions","title":"Functions","text":"Name Summary instance [jvm]open override fun instance(config: Config): RuleSet"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/-detektive-rule-set-provider/","title":"DetektiveRuleSetProvider - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider/DetektiveRuleSetProvider
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/-detektive-rule-set-provider/#detektiverulesetprovider","title":"DetektiveRuleSetProvider","text":"[jvm]\\ constructor()
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/instance/","title":"instance - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider/instance
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/instance/#instance","title":"instance","text":"[jvm]\\ open override fun instance(config: Config): RuleSet
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/rule-set-id/","title":"ruleSetId - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider/ruleSetId
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/rule-set-id/#rulesetid","title":"ruleSetId","text":"[jvm]\\ open override val ruleSetId: String
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/","title":"Package-level declarations - Misk","text":"//detektive/cash.detektive.javacompat
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/#types","title":"Types","text":"Name Summary AnnotatePublicApisWithJvmOverloads [jvm]class AnnotatePublicApisWithJvmOverloads(config: Config) : Rule"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/","title":"AnnotatePublicApisWithJvmOverloads - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#annotatepublicapiswithjvmoverloads","title":"AnnotatePublicApisWithJvmOverloads","text":"[jvm]\\ class AnnotatePublicApisWithJvmOverloads(config: Config) : Rule
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#constructors","title":"Constructors","text":"AnnotatePublicApisWithJvmOverloads [jvm]constructor(config: Config)"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#types","title":"Types","text":"Name Summary ElementType [jvm]enum ElementType : Enum<AnnotatePublicApisWithJvmOverloads.ElementType>"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#properties","title":"Properties","text":"Name Summary active [jvm]open val active: Boolean aliases [jvm]val aliases: Set<String> autoCorrect [jvm]open val autoCorrect: Boolean bindingContext [jvm]var bindingContext: BindingContext compilerResources [jvm]var compilerResources: CompilerResources? defaultRuleIdAliases [jvm]open val defaultRuleIdAliases: Set<String> filters [jvm]open val filters: PathFilters? findings [jvm]open override val findings: List<Finding> issue [jvm]open override val issue: Issue parentPath [jvm]open val parentPath: String? ruleId [jvm]override val ruleId: RuleId ruleSetConfig [jvm]open override val ruleSetConfig: Config"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#functions","title":"Functions","text":"Name Summary clearFindings [jvm]open override fun clearFindings() report [jvm]open override fun report(finding: Finding, aliases: Set<String>, ruleSetId: RuleSetId?)open override fun report(findings: List<Finding>, aliases: Set<String>, ruleSetId: RuleSetId?)fun report(finding: Finding)fun report(findings: List<Finding>) subConfig [jvm]open override fun subConfig(key: String): Config valueOrDefault [jvm]open override fun <T : Any> valueOrDefault(key: String, default: T): T valueOrNull [jvm]open override fun <T : Any> valueOrNull(key: String): T? visit [jvm]open fun visit(root: KtFile) visitAnnotatedExpression [jvm]open fun visitAnnotatedExpression(@NotNullp0: KtAnnotatedExpression)override fun visitAnnotatedExpression(@NotNullp0: KtAnnotatedExpression, p1: Void): Void visitAnnotation [jvm]open fun visitAnnotation(@NotNullp0: KtAnnotation)override fun visitAnnotation(@NotNullp0: KtAnnotation, p1: Void): Void visitAnnotationEntry [jvm]open fun visitAnnotationEntry(@NotNullp0: KtAnnotationEntry)override fun visitAnnotationEntry(@NotNullp0: KtAnnotationEntry, p1: Void): Void visitAnnotationUseSiteTarget [jvm]open fun visitAnnotationUseSiteTarget(@NotNullp0: KtAnnotationUseSiteTarget, p1: Void): Void visitAnonymousInitializer [jvm]open fun visitAnonymousInitializer(@NotNullp0: KtAnonymousInitializer)override fun visitAnonymousInitializer(@NotNullp0: KtAnonymousInitializer, p1: Void): Void visitArgument [jvm]open fun visitArgument(@NotNullp0: KtValueArgument)override fun visitArgument(@NotNullp0: KtValueArgument, p1: Void): Void visitArrayAccessExpression [jvm]open fun visitArrayAccessExpression(@NotNullp0: KtArrayAccessExpression)override fun visitArrayAccessExpression(@NotNullp0: KtArrayAccessExpression, p1: Void): Void visitBackingField [jvm]open fun visitBackingField(@NotNullp0: KtBackingField, p1: Void): Void visitBinaryExpression [jvm]open fun visitBinaryExpression(@NotNullp0: KtBinaryExpression)override fun visitBinaryExpression(@NotNullp0: KtBinaryExpression, p1: Void): Void visitBinaryFile [jvm]open fun visitBinaryFile(@NotNullp0: @NotNullPsiBinaryFile) visitBinaryWithTypeRHSExpression [jvm]open fun visitBinaryWithTypeRHSExpression(@NotNullp0: KtBinaryExpressionWithTypeRHS)override fun visitBinaryWithTypeRHSExpression(@NotNullp0: KtBinaryExpressionWithTypeRHS, p1: Void): Void visitBlockExpression [jvm]open fun visitBlockExpression(@NotNullp0: KtBlockExpression)override fun visitBlockExpression(@NotNullp0: KtBlockExpression, p1: Void): Void visitBlockStringTemplateEntry [jvm]open fun visitBlockStringTemplateEntry(@NotNullp0: KtBlockStringTemplateEntry)override fun visitBlockStringTemplateEntry(@NotNullp0: KtBlockStringTemplateEntry, p1: Void): Void visitBreakExpression [jvm]open fun visitBreakExpression(@NotNullp0: KtBreakExpression)override fun visitBreakExpression(@NotNullp0: KtBreakExpression, p1: Void): Void visitCallableReferenceExpression [jvm]open fun visitCallableReferenceExpression(@NotNullp0: KtCallableReferenceExpression)override fun visitCallableReferenceExpression(@NotNullp0: KtCallableReferenceExpression, p1: Void): Void visitCallExpression [jvm]open fun visitCallExpression(@NotNullp0: KtCallExpression)override fun visitCallExpression(@NotNullp0: KtCallExpression, p1: Void): Void visitCatchSection [jvm]open fun visitCatchSection(@NotNullp0: KtCatchClause)override fun visitCatchSection(@NotNullp0: KtCatchClause, p1: Void): Void visitClass [jvm]open fun visitClass(@NotNullp0: KtClass)override fun visitClass(@NotNullp0: KtClass, p1: Void): Void visitClassBody [jvm]open fun visitClassBody(@NotNullp0: KtClassBody)override fun visitClassBody(@NotNullp0: KtClassBody, p1: Void): Void visitClassInitializer [jvm]open fun visitClassInitializer(@NotNullp0: KtClassInitializer)open override fun visitClassInitializer(@NotNullp0: KtClassInitializer, p1: Void): Void visitClassLiteralExpression [jvm]open fun visitClassLiteralExpression(@NotNullp0: KtClassLiteralExpression)override fun visitClassLiteralExpression(@NotNullp0: KtClassLiteralExpression, p1: Void): Void visitClassOrObject [jvm]open fun visitClassOrObject(@NotNullp0: KtClassOrObject)override fun visitClassOrObject(@NotNullp0: KtClassOrObject, p1: Void): Void visitCollectionLiteralExpression [jvm]open fun visitCollectionLiteralExpression(@NotNullp0: KtCollectionLiteralExpression)override fun visitCollectionLiteralExpression(@NotNullp0: KtCollectionLiteralExpression, p1: Void): Void visitComment [jvm]open fun visitComment(@NotNullp0: @NotNullPsiComment) visitCondition [jvm]open override fun visitCondition(root: KtFile): Boolean visitConstantExpression [jvm]open fun visitConstantExpression(@NotNullp0: KtConstantExpression)override fun visitConstantExpression(@NotNullp0: KtConstantExpression, p1: Void): Void visitConstructorCalleeExpression [jvm]open fun visitConstructorCalleeExpression(@NotNullp0: KtConstructorCalleeExpression)override fun visitConstructorCalleeExpression(@NotNullp0: KtConstructorCalleeExpression, p1: Void): Void visitConstructorDelegationCall [jvm]open fun visitConstructorDelegationCall(@NotNullp0: KtConstructorDelegationCall)override fun visitConstructorDelegationCall(@NotNullp0: KtConstructorDelegationCall, p1: Void): Void visitContextReceiverList [jvm]open fun visitContextReceiverList(@NotNullp0: KtContextReceiverList, p1: Void): Voidopen fun visitContextReceiverList(@NotNullp0: KtContextReceiverList) visitContinueExpression [jvm]open fun visitContinueExpression(@NotNullp0: KtContinueExpression)override fun visitContinueExpression(@NotNullp0: KtContinueExpression, p1: Void): Void visitDeclaration [jvm]open fun visitDeclaration(@NotNullp0: KtDeclaration)override fun visitDeclaration(@NotNullp0: KtDeclaration, p1: Void): Void visitDelegatedSuperTypeEntry [jvm]open fun visitDelegatedSuperTypeEntry(@NotNullp0: KtDelegatedSuperTypeEntry)override fun visitDelegatedSuperTypeEntry(@NotNullp0: KtDelegatedSuperTypeEntry, p1: Void): Void visitDestructuringDeclaration [jvm]open fun visitDestructuringDeclaration(@NotNullp0: KtDestructuringDeclaration)override fun visitDestructuringDeclaration(@NotNullp0: KtDestructuringDeclaration, p1: Void): Void visitDestructuringDeclarationEntry [jvm]open fun visitDestructuringDeclarationEntry(@NotNullp0: KtDestructuringDeclarationEntry)override fun visitDestructuringDeclarationEntry(@NotNullp0: KtDestructuringDeclarationEntry, p1: Void): Void visitDirectory [jvm]open fun visitDirectory(@NotNullp0: @NotNullPsiDirectory) visitDotQualifiedExpression [jvm]open fun visitDotQualifiedExpression(@NotNullp0: KtDotQualifiedExpression)override fun visitDotQualifiedExpression(@NotNullp0: KtDotQualifiedExpression, p1: Void): Void visitDoubleColonExpression [jvm]open fun visitDoubleColonExpression(@NotNullp0: KtDoubleColonExpression)override fun visitDoubleColonExpression(@NotNullp0: KtDoubleColonExpression, p1: Void): Void visitDoWhileExpression [jvm]open fun visitDoWhileExpression(@NotNullp0: KtDoWhileExpression)override fun visitDoWhileExpression(@NotNullp0: KtDoWhileExpression, p1: Void): Void visitDynamicType [jvm]open fun visitDynamicType(@NotNullp0: KtDynamicType)open override fun visitDynamicType(@NotNullp0: KtDynamicType, p1: Void): Void visitElement [jvm]open override fun visitElement(@NotNullp0: PsiElement) visitEnumEntry [jvm]open fun visitEnumEntry(@NotNullp0: KtEnumEntry)override fun visitEnumEntry(@NotNullp0: KtEnumEntry, p1: Void): Void visitErrorElement [jvm]open fun visitErrorElement(@NotNullp0: @NotNullPsiErrorElement) visitEscapeStringTemplateEntry [jvm]open fun visitEscapeStringTemplateEntry(@NotNullp0: KtEscapeStringTemplateEntry)override fun visitEscapeStringTemplateEntry(@NotNullp0: KtEscapeStringTemplateEntry, p1: Void): Void visitExpression [jvm]open fun visitExpression(@NotNullp0: KtExpression)override fun visitExpression(@NotNullp0: KtExpression, p1: Void): Void visitExpressionWithLabel [jvm]open fun visitExpressionWithLabel(@NotNullp0: KtExpressionWithLabel)override fun visitExpressionWithLabel(@NotNullp0: KtExpressionWithLabel, p1: Void): Void visitFile [jvm]fun visitFile(root: KtFile, bindingContext: BindingContext, compilerResources: CompilerResources?)open fun visitFile(@NotNullp0: @NotNullPsiFile) visitFileAnnotationList [jvm]open fun visitFileAnnotationList(@NotNullp0: KtFileAnnotationList, p1: Void): Void visitFinallySection [jvm]open fun visitFinallySection(@NotNullp0: KtFinallySection)override fun visitFinallySection(@NotNullp0: KtFinallySection, p1: Void): Void visitForExpression [jvm]open fun visitForExpression(@NotNullp0: KtForExpression)override fun visitForExpression(@NotNullp0: KtForExpression, p1: Void): Void visitFunctionType [jvm]open fun visitFunctionType(@NotNullp0: KtFunctionType)override fun visitFunctionType(@NotNullp0: KtFunctionType, p1: Void): Void visitIfExpression [jvm]open fun visitIfExpression(@NotNullp0: KtIfExpression)override fun visitIfExpression(@NotNullp0: KtIfExpression, p1: Void): Void visitImportAlias [jvm]open fun visitImportAlias(@NotNullp0: KtImportAlias, p1: Void): Voidopen fun visitImportAlias(@NotNullp0: KtImportAlias) visitImportDirective [jvm]open fun visitImportDirective(@NotNullp0: KtImportDirective)override fun visitImportDirective(@NotNullp0: KtImportDirective, p1: Void): Void visitImportList [jvm]open fun visitImportList(@NotNullp0: KtImportList)override fun visitImportList(@NotNullp0: KtImportList, p1: Void): Void visitInitializerList [jvm]open fun visitInitializerList(@NotNullp0: KtInitializerList)override fun visitInitializerList(@NotNullp0: KtInitializerList, p1: Void): Void visitIntersectionType [jvm]open fun visitIntersectionType(@NotNullp0: KtIntersectionType)open override fun visitIntersectionType(@NotNullp0: KtIntersectionType, p1: Void): Void visitIsExpression [jvm]open fun visitIsExpression(@NotNullp0: KtIsExpression)override fun visitIsExpression(@NotNullp0: KtIsExpression, p1: Void): Void visitKtElement [jvm]open fun visitKtElement(@NotNullp0: KtElement)override fun visitKtElement(@NotNullp0: KtElement, p1: Void): Void visitKtFile [jvm]open fun visitKtFile(@NotNullp0: KtFile)override fun visitKtFile(@NotNullp0: KtFile, p1: Void): Void visitLabeledExpression [jvm]open fun visitLabeledExpression(@NotNullp0: KtLabeledExpression)override fun visitLabeledExpression(@NotNullp0: KtLabeledExpression, p1: Void): Void visitLambdaExpression [jvm]open fun visitLambdaExpression(@NotNullp0: KtLambdaExpression)override fun visitLambdaExpression(@NotNullp0: KtLambdaExpression, p1: Void): Void visitLiteralStringTemplateEntry [jvm]open fun visitLiteralStringTemplateEntry(@NotNullp0: KtLiteralStringTemplateEntry)override fun visitLiteralStringTemplateEntry(@NotNullp0: KtLiteralStringTemplateEntry, p1: Void): Void visitLoopExpression [jvm]open fun visitLoopExpression(@NotNullp0: KtLoopExpression)override fun visitLoopExpression(@NotNullp0: KtLoopExpression, p1: Void): Void visitModifierList [jvm]open fun visitModifierList(@NotNullp0: KtModifierList)override fun visitModifierList(@NotNullp0: KtModifierList, p1: Void): Void visitNamedDeclaration [jvm]open fun visitNamedDeclaration(@NotNullp0: KtNamedDeclaration)override fun visitNamedDeclaration(@NotNullp0: KtNamedDeclaration, p1: Void): Void visitNamedFunction [jvm]open override fun visitNamedFunction(function: KtNamedFunction)override fun visitNamedFunction(@NotNullp0: KtNamedFunction, p1: Void): Void visitNullableType [jvm]open fun visitNullableType(@NotNullp0: KtNullableType)override fun visitNullableType(@NotNullp0: KtNullableType, p1: Void): Void visitObjectDeclaration [jvm]open fun visitObjectDeclaration(@NotNullp0: KtObjectDeclaration)override fun visitObjectDeclaration(@NotNullp0: KtObjectDeclaration, p1: Void): Void visitObjectLiteralExpression [jvm]open fun visitObjectLiteralExpression(@NotNullp0: KtObjectLiteralExpression)override fun visitObjectLiteralExpression(@NotNullp0: KtObjectLiteralExpression, p1: Void): Void visitOuterLanguageElement [jvm]open fun visitOuterLanguageElement(@NotNullp0: @NotNullOuterLanguageElement) visitPackageDirective [jvm]open fun visitPackageDirective(@NotNullp0: KtPackageDirective)open override fun visitPackageDirective(@NotNullp0: KtPackageDirective, p1: Void): Void visitParameter [jvm]open fun visitParameter(@NotNullp0: KtParameter)override fun visitParameter(@NotNullp0: KtParameter, p1: Void): Void visitParameterList [jvm]open fun visitParameterList(@NotNullp0: KtParameterList)override fun visitParameterList(@NotNullp0: KtParameterList, p1: Void): Void visitParenthesizedExpression [jvm]open fun visitParenthesizedExpression(@NotNullp0: KtParenthesizedExpression)override fun visitParenthesizedExpression(@NotNullp0: KtParenthesizedExpression, p1: Void): Void visitPlainText [jvm]open fun visitPlainText(@NotNullp0: @NotNullPsiPlainText) visitPlainTextFile [jvm]open fun visitPlainTextFile(@NotNullp0: @NotNullPsiPlainTextFile) visitPostfixExpression [jvm]open fun visitPostfixExpression(@NotNullp0: KtPostfixExpression)override fun visitPostfixExpression(@NotNullp0: KtPostfixExpression, p1: Void): Void visitPrefixExpression [jvm]open fun visitPrefixExpression(@NotNullp0: KtPrefixExpression)override fun visitPrefixExpression(@NotNullp0: KtPrefixExpression, p1: Void): Void visitPrimaryConstructor [jvm]open override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)override fun visitPrimaryConstructor(@NotNullp0: KtPrimaryConstructor, p1: Void): Void visitProperty [jvm]open fun visitProperty(@NotNullp0: KtProperty)override fun visitProperty(@NotNullp0: KtProperty, p1: Void): Void visitPropertyAccessor [jvm]open fun visitPropertyAccessor(@NotNullp0: KtPropertyAccessor)override fun visitPropertyAccessor(@NotNullp0: KtPropertyAccessor, p1: Void): Void visitPropertyDelegate [jvm]open fun visitPropertyDelegate(@NotNullp0: KtPropertyDelegate)override fun visitPropertyDelegate(@NotNullp0: KtPropertyDelegate, p1: Void): Void visitQualifiedExpression [jvm]open fun visitQualifiedExpression(@NotNullp0: KtQualifiedExpression)override fun visitQualifiedExpression(@NotNullp0: KtQualifiedExpression, p1: Void): Void visitReferenceExpression [jvm]open fun visitReferenceExpression(@NotNullp0: KtReferenceExpression)override fun visitReferenceExpression(@NotNullp0: KtReferenceExpression, p1: Void): Void visitReturnExpression [jvm]open fun visitReturnExpression(@NotNullp0: KtReturnExpression)override fun visitReturnExpression(@NotNullp0: KtReturnExpression, p1: Void): Void visitSafeQualifiedExpression [jvm]open fun visitSafeQualifiedExpression(@NotNullp0: KtSafeQualifiedExpression)override fun visitSafeQualifiedExpression(@NotNullp0: KtSafeQualifiedExpression, p1: Void): Void visitScript [jvm]open fun visitScript(@NotNullp0: KtScript)override fun visitScript(@NotNullp0: KtScript, p1: Void): Void visitScriptInitializer [jvm]open fun visitScriptInitializer(@NotNullp0: KtScriptInitializer)open override fun visitScriptInitializer(@NotNullp0: KtScriptInitializer, p1: Void): Void visitSecondaryConstructor [jvm]open fun visitSecondaryConstructor(@NotNullp0: KtSecondaryConstructor)override fun visitSecondaryConstructor(@NotNullp0: KtSecondaryConstructor, p1: Void): Void visitSelfType [jvm]open fun visitSelfType(@NotNullp0: KtSelfType)override fun visitSelfType(@NotNullp0: KtSelfType, p1: Void): Void visitSimpleNameExpression [jvm]open fun visitSimpleNameExpression(@NotNullp0: KtSimpleNameExpression)override fun visitSimpleNameExpression(@NotNullp0: KtSimpleNameExpression, p1: Void): Void visitSimpleNameStringTemplateEntry [jvm]open fun visitSimpleNameStringTemplateEntry(@NotNullp0: KtSimpleNameStringTemplateEntry)override fun visitSimpleNameStringTemplateEntry(@NotNullp0: KtSimpleNameStringTemplateEntry, p1: Void): Void visitStringTemplateEntry [jvm]open fun visitStringTemplateEntry(@NotNullp0: KtStringTemplateEntry)override fun visitStringTemplateEntry(@NotNullp0: KtStringTemplateEntry, p1: Void): Void visitStringTemplateEntryWithExpression [jvm]open fun visitStringTemplateEntryWithExpression(@NotNullp0: KtStringTemplateEntryWithExpression)override fun visitStringTemplateEntryWithExpression(@NotNullp0: KtStringTemplateEntryWithExpression, p1: Void): Void visitStringTemplateExpression [jvm]open fun visitStringTemplateExpression(@NotNullp0: KtStringTemplateExpression)override fun visitStringTemplateExpression(@NotNullp0: KtStringTemplateExpression, p1: Void): Void visitSuperExpression [jvm]open fun visitSuperExpression(@NotNullp0: KtSuperExpression)override fun visitSuperExpression(@NotNullp0: KtSuperExpression, p1: Void): Void visitSuperTypeCallEntry [jvm]open fun visitSuperTypeCallEntry(@NotNullp0: KtSuperTypeCallEntry)override fun visitSuperTypeCallEntry(@NotNullp0: KtSuperTypeCallEntry, p1: Void): Void visitSuperTypeEntry [jvm]open fun visitSuperTypeEntry(@NotNullp0: KtSuperTypeEntry)override fun visitSuperTypeEntry(@NotNullp0: KtSuperTypeEntry, p1: Void): Void visitSuperTypeList [jvm]open fun visitSuperTypeList(@NotNullp0: KtSuperTypeList)override fun visitSuperTypeList(@NotNullp0: KtSuperTypeList, p1: Void): Void visitSuperTypeListEntry [jvm]open fun visitSuperTypeListEntry(@NotNullp0: KtSuperTypeListEntry)override fun visitSuperTypeListEntry(@NotNullp0: KtSuperTypeListEntry, p1: Void): Void visitThisExpression [jvm]open fun visitThisExpression(@NotNullp0: KtThisExpression)override fun visitThisExpression(@NotNullp0: KtThisExpression, p1: Void): Void visitThrowExpression [jvm]open fun visitThrowExpression(@NotNullp0: KtThrowExpression)override fun visitThrowExpression(@NotNullp0: KtThrowExpression, p1: Void): Void visitTryExpression [jvm]open fun visitTryExpression(@NotNullp0: KtTryExpression)override fun visitTryExpression(@NotNullp0: KtTryExpression, p1: Void): Void visitTypeAlias [jvm]open fun visitTypeAlias(@NotNullp0: KtTypeAlias)override fun visitTypeAlias(@NotNullp0: KtTypeAlias, p1: Void): Void visitTypeArgumentList [jvm]open fun visitTypeArgumentList(@NotNullp0: KtTypeArgumentList)override fun visitTypeArgumentList(@NotNullp0: KtTypeArgumentList, p1: Void): Void visitTypeConstraint [jvm]open fun visitTypeConstraint(@NotNullp0: KtTypeConstraint)override fun visitTypeConstraint(@NotNullp0: KtTypeConstraint, p1: Void): Void visitTypeConstraintList [jvm]open fun visitTypeConstraintList(@NotNullp0: KtTypeConstraintList)override fun visitTypeConstraintList(@NotNullp0: KtTypeConstraintList, p1: Void): Void visitTypeParameter [jvm]open fun visitTypeParameter(@NotNullp0: KtTypeParameter)override fun visitTypeParameter(@NotNullp0: KtTypeParameter, p1: Void): Void visitTypeParameterList [jvm]open fun visitTypeParameterList(@NotNullp0: KtTypeParameterList)override fun visitTypeParameterList(@NotNullp0: KtTypeParameterList, p1: Void): Void visitTypeProjection [jvm]open fun visitTypeProjection(@NotNullp0: KtTypeProjection)override fun visitTypeProjection(@NotNullp0: KtTypeProjection, p1: Void): Void visitTypeReference [jvm]open fun visitTypeReference(@NotNullp0: KtTypeReference)override fun visitTypeReference(@NotNullp0: KtTypeReference, p1: Void): Void visitUnaryExpression [jvm]open fun visitUnaryExpression(@NotNullp0: KtUnaryExpression)override fun visitUnaryExpression(@NotNullp0: KtUnaryExpression, p1: Void): Void visitUserType [jvm]open fun visitUserType(@NotNullp0: KtUserType)override fun visitUserType(@NotNullp0: KtUserType, p1: Void): Void visitValueArgumentList [jvm]open fun visitValueArgumentList(@NotNullp0: KtValueArgumentList)override fun visitValueArgumentList(@NotNullp0: KtValueArgumentList, p1: Void): Void visitWhenConditionInRange [jvm]open fun visitWhenConditionInRange(@NotNullp0: KtWhenConditionInRange)override fun visitWhenConditionInRange(@NotNullp0: KtWhenConditionInRange, p1: Void): Void visitWhenConditionIsPattern [jvm]open fun visitWhenConditionIsPattern(@NotNullp0: KtWhenConditionIsPattern)override fun visitWhenConditionIsPattern(@NotNullp0: KtWhenConditionIsPattern, p1: Void): Void visitWhenConditionWithExpression [jvm]open fun visitWhenConditionWithExpression(@NotNullp0: KtWhenConditionWithExpression)override fun visitWhenConditionWithExpression(@NotNullp0: KtWhenConditionWithExpression, p1: Void): Void visitWhenEntry [jvm]open fun visitWhenEntry(@NotNullp0: KtWhenEntry)override fun visitWhenEntry(@NotNullp0: KtWhenEntry, p1: Void): Void visitWhenExpression [jvm]open fun visitWhenExpression(@NotNullp0: KtWhenExpression)override fun visitWhenExpression(@NotNullp0: KtWhenExpression, p1: Void): Void visitWhileExpression [jvm]open fun visitWhileExpression(@NotNullp0: KtWhileExpression)override fun visitWhileExpression(@NotNullp0: KtWhileExpression, p1: Void): Void visitWhiteSpace [jvm]open fun visitWhiteSpace(@NotNullp0: @NotNullPsiWhiteSpace) withAutoCorrect [jvm]open fun withAutoCorrect(block: () -> Unit)"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-annotate-public-apis-with-jvm-overloads/","title":"AnnotatePublicApisWithJvmOverloads - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/AnnotatePublicApisWithJvmOverloads
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-annotate-public-apis-with-jvm-overloads/#annotatepublicapiswithjvmoverloads","title":"AnnotatePublicApisWithJvmOverloads","text":"[jvm]\\ constructor(config: Config)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/issue/","title":"issue - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/issue
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/issue/#issue","title":"issue","text":"[jvm]\\ open override val issue: Issue
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-named-function/","title":"visitNamedFunction - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/visitNamedFunction
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-named-function/#visitnamedfunction","title":"visitNamedFunction","text":"[jvm]\\ open override fun visitNamedFunction(function: KtNamedFunction)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-primary-constructor/","title":"visitPrimaryConstructor - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/visitPrimaryConstructor
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-primary-constructor/#visitprimaryconstructor","title":"visitPrimaryConstructor","text":"[jvm]\\ open override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/","title":"ElementType - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#elementtype","title":"ElementType","text":"[jvm]\\ enum ElementType : Enum<AnnotatePublicApisWithJvmOverloads.ElementType>
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#entries","title":"Entries","text":"FUNCTION [jvm]FUNCTION CONSTRUCTOR [jvm]CONSTRUCTOR"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AnnotatePublicApisWithJvmOverloads.ElementType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AnnotatePublicApisWithJvmOverloads.ElementTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AnnotatePublicApisWithJvmOverloads.ElementType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/entries/","title":"entries - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/entries
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AnnotatePublicApisWithJvmOverloads.ElementType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/","title":"valueOf - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/valueOf
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AnnotatePublicApisWithJvmOverloads.ElementType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/values/","title":"values - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/values
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AnnotatePublicApisWithJvmOverloads.ElementType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/","title":"CONSTRUCTOR - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/CONSTRUCTOR
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/#constructor","title":"CONSTRUCTOR","text":"[jvm]\\ CONSTRUCTOR
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/","title":"FUNCTION - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/FUNCTION
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/#function","title":"FUNCTION","text":"[jvm]\\ FUNCTION
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/exemplar/","title":"exemplar - Misk","text":"//exemplar
"},{"location":"0.x/exemplar/#exemplar","title":"exemplar","text":""},{"location":"0.x/exemplar/#packages","title":"Packages","text":"Name com.squareup.exemplar com.squareup.exemplar.actions com.squareup.exemplar.dashboard com.squareup.exemplar.dashboard.admin com.squareup.exemplar.dashboard.frontend com.squareup.exemplar.dashboard.support"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#types","title":"Types","text":"Name Summary AnotherServiceImpl [jvm]class AnotherServiceImpl : Service DinoMetadata [jvm]data class DinoMetadata(val dinos: List<String>) : Metadata DinoMetadataProvider [jvm]class DinoMetadataProvider : MetadataProvider<Metadata> ExemplarAccessModule [jvm]class ExemplarAccessModule : KAbstractModule ExemplarConfig [jvm]data class ExemplarConfig(val apiKey: Secret<String>, val web: WebConfig, val prometheus: PrometheusConfig, val redacted: String) : Config ExemplarCronModule [jvm]class ExemplarCronModule : KAbstractModule ExemplarGuiceBindingsModule [jvm]class ExemplarGuiceBindingsModule : KAbstractModule ExemplarJavaApp [jvm]open class ExemplarJavaApp ExemplarJavaConfig [jvm]open class ExemplarJavaConfig : Config ExemplarJavaModule [jvm]open class ExemplarJavaModule : AbstractModule ExemplarLogging [jvm]object ExemplarLogging ExemplarMetadataModule [jvm]class ExemplarMetadataModule : KAbstractModule ExemplarWebActionsModule [jvm]class ExemplarWebActionsModule : KAbstractModule HelloJavaAction [jvm]@Singletonopen class HelloJavaAction : WebAction Service [jvm]interface Service ServiceImpl [jvm]class ServiceImpl : Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#functions","title":"Functions","text":"Name Summary main [jvm]fun main(args: Array<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/main/","title":"main - Misk","text":"//exemplar/com.squareup.exemplar/main
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/main/#main","title":"main","text":"[jvm]\\ fun main(args: Array<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/","title":"AnotherServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/AnotherServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#anotherserviceimpl","title":"AnotherServiceImpl","text":"[jvm]\\ class AnotherServiceImpl : Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#constructors","title":"Constructors","text":"AnotherServiceImpl [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/-another-service-impl/","title":"AnotherServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/AnotherServiceImpl/AnotherServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/-another-service-impl/#anotherserviceimpl","title":"AnotherServiceImpl","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/execute/","title":"execute - Misk","text":"//exemplar/com.squareup.exemplar/AnotherServiceImpl/execute
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/","title":"DinoMetadata - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#dinometadata","title":"DinoMetadata","text":"[jvm]\\ data class DinoMetadata(val dinos: List<String>) : Metadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#constructors","title":"Constructors","text":"DinoMetadata [jvm]constructor(dinos: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String dinos [jvm]val dinos: List<String> metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open override fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/-dino-metadata/","title":"DinoMetadata - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata/DinoMetadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/-dino-metadata/#dinometadata","title":"DinoMetadata","text":"[jvm]\\ constructor(dinos: List<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/content-block/","title":"contentBlock - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata/contentBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/content-block/#contentblock","title":"contentBlock","text":"[jvm]\\ open override fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/dinos/","title":"dinos - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata/dinos
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/dinos/#dinos","title":"dinos","text":"[jvm]\\ val dinos: List<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/","title":"DinoMetadataProvider - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#dinometadataprovider","title":"DinoMetadataProvider","text":"[jvm]\\ class DinoMetadataProvider : MetadataProvider<Metadata>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#constructors","title":"Constructors","text":"DinoMetadataProvider [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DinoMetadata"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/-dino-metadata-provider/","title":"DinoMetadataProvider - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider/DinoMetadataProvider
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/-dino-metadata-provider/#dinometadataprovider","title":"DinoMetadataProvider","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DinoMetadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/id/","title":"id - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider/id
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/id/#id","title":"id","text":"[jvm]\\ open override val id: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/","title":"ExemplarAccessModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarAccessModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#exemplaraccessmodule","title":"ExemplarAccessModule","text":"[jvm]\\ class ExemplarAccessModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#constructors","title":"Constructors","text":"ExemplarAccessModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/-exemplar-access-module/","title":"ExemplarAccessModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarAccessModule/ExemplarAccessModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/-exemplar-access-module/#exemplaraccessmodule","title":"ExemplarAccessModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/","title":"ExemplarConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#exemplarconfig","title":"ExemplarConfig","text":"[jvm]\\ data class ExemplarConfig(val apiKey: Secret<String>, val web: WebConfig, val prometheus: PrometheusConfig, val redacted: String) : Config
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#constructors","title":"Constructors","text":"ExemplarConfig [jvm]constructor(apiKey: Secret<String>, web: WebConfig, prometheus: PrometheusConfig, redacted: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#properties","title":"Properties","text":"Name Summary apiKey [jvm]val apiKey: Secret<String> prometheus [jvm]val prometheus: PrometheusConfig redacted [jvm]val redacted: String web [jvm]val web: WebConfig"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/-exemplar-config/","title":"ExemplarConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/ExemplarConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/-exemplar-config/#exemplarconfig","title":"ExemplarConfig","text":"[jvm]\\ constructor(apiKey: Secret<String>, web: WebConfig, prometheus: PrometheusConfig, redacted: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/api-key/","title":"apiKey - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/apiKey
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/api-key/#apikey","title":"apiKey","text":"[jvm]\\ val apiKey: Secret<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/prometheus/","title":"prometheus - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/prometheus
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/prometheus/#prometheus","title":"prometheus","text":"[jvm]\\ val prometheus: PrometheusConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/redacted/","title":"redacted - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/redacted
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/redacted/#redacted","title":"redacted","text":"[jvm]\\ val redacted: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/web/","title":"web - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/web
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/web/#web","title":"web","text":"[jvm]\\ val web: WebConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/","title":"ExemplarCronModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#exemplarcronmodule","title":"ExemplarCronModule","text":"[jvm]\\ class ExemplarCronModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#constructors","title":"Constructors","text":"ExemplarCronModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#types","title":"Types","text":"Name Summary MinuteCron [jvm]@Singletonclass MinuteCron@Injectconstructor : Runnable"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-exemplar-cron-module/","title":"ExemplarCronModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/ExemplarCronModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-exemplar-cron-module/#exemplarcronmodule","title":"ExemplarCronModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/","title":"MinuteCron - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#minutecron","title":"MinuteCron","text":"[jvm]\\ @Singleton
class MinuteCron@Injectconstructor : Runnable
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#constructors","title":"Constructors","text":"MinuteCron [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#properties","title":"Properties","text":"Name Summary counter [jvm]var counter: Int"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#functions","title":"Functions","text":"Name Summary run [jvm]open override fun run()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-minute-cron/","title":"MinuteCron - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/MinuteCron
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-minute-cron/#minutecron","title":"MinuteCron","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/counter/","title":"counter - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/counter
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/counter/#counter","title":"counter","text":"[jvm]\\ var counter: Int
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/run/","title":"run - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/run
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/run/#run","title":"run","text":"[jvm]\\ open override fun run()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/log/","title":"log - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/Companion/log
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/","title":"ExemplarGuiceBindingsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#exemplarguicebindingsmodule","title":"ExemplarGuiceBindingsModule","text":"[jvm]\\ class ExemplarGuiceBindingsModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#constructors","title":"Constructors","text":"ExemplarGuiceBindingsModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideYetAnotherService [jvm]@Providesfun provideYetAnotherService(): Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-exemplar-guice-bindings-module/","title":"ExemplarGuiceBindingsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/ExemplarGuiceBindingsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-exemplar-guice-bindings-module/#exemplarguicebindingsmodule","title":"ExemplarGuiceBindingsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/provide-yet-another-service/","title":"provideYetAnotherService - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/provideYetAnotherService
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/provide-yet-another-service/#provideyetanotherservice","title":"provideYetAnotherService","text":"[jvm]\\
@Provides
fun provideYetAnotherService(): Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/","title":"ExemplarJavaApp - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaApp
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#exemplarjavaapp","title":"ExemplarJavaApp","text":"[jvm]\\ open class ExemplarJavaApp
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#constructors","title":"Constructors","text":"ExemplarJavaApp [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#functions","title":"Functions","text":"Name Summary main [jvm]open fun main(args: Array<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/-exemplar-java-app/","title":"ExemplarJavaApp - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaApp/ExemplarJavaApp
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/-exemplar-java-app/#exemplarjavaapp","title":"ExemplarJavaApp","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/main/","title":"main - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaApp/main
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/main/#main","title":"main","text":"[jvm]\\ open fun main(args: Array<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/","title":"ExemplarJavaConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#exemplarjavaconfig","title":"ExemplarJavaConfig","text":"[jvm]\\ open class ExemplarJavaConfig : Config
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#constructors","title":"Constructors","text":"ExemplarJavaConfig [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#properties","title":"Properties","text":"Name Summary web [jvm]open var web: WebConfig"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/-exemplar-java-config/","title":"ExemplarJavaConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaConfig/ExemplarJavaConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/-exemplar-java-config/#exemplarjavaconfig","title":"ExemplarJavaConfig","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/web/","title":"web - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaConfig/web
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/web/#web","title":"web","text":"[jvm]\\ open var web: WebConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/","title":"ExemplarJavaModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#exemplarjavamodule","title":"ExemplarJavaModule","text":"[jvm]\\ open class ExemplarJavaModule : AbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#constructors","title":"Constructors","text":"ExemplarJavaModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/-exemplar-java-module/","title":"ExemplarJavaModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaModule/ExemplarJavaModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/-exemplar-java-module/#exemplarjavamodule","title":"ExemplarJavaModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/","title":"ExemplarLogging - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarLogging
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/#exemplarlogging","title":"ExemplarLogging","text":"[jvm]\\ object ExemplarLogging
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/configure/","title":"configure - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarLogging/configure
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/configure/#configure","title":"configure","text":"[jvm]\\ fun configure()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/","title":"ExemplarMetadataModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarMetadataModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#exemplarmetadatamodule","title":"ExemplarMetadataModule","text":"[jvm]\\ class ExemplarMetadataModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#constructors","title":"Constructors","text":"ExemplarMetadataModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/-exemplar-metadata-module/","title":"ExemplarMetadataModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarMetadataModule/ExemplarMetadataModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/-exemplar-metadata-module/#exemplarmetadatamodule","title":"ExemplarMetadataModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/","title":"ExemplarWebActionsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarWebActionsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#exemplarwebactionsmodule","title":"ExemplarWebActionsModule","text":"[jvm]\\ class ExemplarWebActionsModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#constructors","title":"Constructors","text":"ExemplarWebActionsModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/-exemplar-web-actions-module/","title":"ExemplarWebActionsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarWebActionsModule/ExemplarWebActionsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/-exemplar-web-actions-module/#exemplarwebactionsmodule","title":"ExemplarWebActionsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/","title":"HelloJavaAction - Misk","text":"//exemplar/com.squareup.exemplar/HelloJavaAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#hellojavaaction","title":"HelloJavaAction","text":"[jvm]\\ @Singleton
open class HelloJavaAction : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#constructors","title":"Constructors","text":"HelloJavaAction [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#functions","title":"Functions","text":"Name Summary hello [jvm]open fun hello(name: String, headers: Headers): HelloJavaAction.HelloJavaResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/-hello-java-action/","title":"HelloJavaAction - Misk","text":"//exemplar/com.squareup.exemplar/HelloJavaAction/HelloJavaAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/-hello-java-action/#hellojavaaction","title":"HelloJavaAction","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar/HelloJavaAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/hello/#hello","title":"hello","text":"[jvm]\\ open fun hello(name: String, headers: Headers): HelloJavaAction.HelloJavaResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/","title":"Service - Misk","text":"//exemplar/com.squareup.exemplar/Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#service","title":"Service","text":"interface Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#inheritors","title":"Inheritors","text":"ServiceImpl AnotherServiceImpl"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#functions","title":"Functions","text":"Name Summary execute [jvm]abstract fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/execute/","title":"execute - Misk","text":"//exemplar/com.squareup.exemplar/Service/execute
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/execute/#execute","title":"execute","text":"[jvm]\\ abstract fun execute(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/","title":"ServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/ServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#serviceimpl","title":"ServiceImpl","text":"[jvm]\\ class ServiceImpl : Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#constructors","title":"Constructors","text":"ServiceImpl [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/-service-impl/","title":"ServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/ServiceImpl/ServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/-service-impl/#serviceimpl","title":"ServiceImpl","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/execute/","title":"execute - Misk","text":"//exemplar/com.squareup.exemplar/ServiceImpl/execute
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.actions
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/#types","title":"Types","text":"Name Summary DownloadAFileWebAction [jvm]@Singletonclass DownloadAFileWebAction@Injectconstructor : WebAction EchoFormAction [jvm]@Singletonclass EchoFormAction@Injectconstructor : WebAction ExampleRateLimitConfiguration [jvm]object ExampleRateLimitConfiguration : RateLimitConfiguration HelloPostResponse [jvm]data class HelloPostResponse(val greeting: String, val name: String) HelloResponse [jvm]data class HelloResponse(val greeting: String, val name: String) HelloWebAction [jvm]@Singletonclass HelloWebAction@Injectconstructor(tokenGenerator: TokenGenerator) : WebAction HelloWebPostAction [jvm]@Singletonclass HelloWebPostAction@Injectconstructor : WebAction HelloWebProtoAction [jvm]class HelloWebProtoAction@Injectconstructor : WebAction PostBody [jvm]data class PostBody(val greeting: String) RateLimitedAction [jvm]@Singletonclass RateLimitedAction@Injectconstructor(rateLimiter: RateLimiter) RateLimitedExampleResponse [jvm]data class RateLimitedExampleResponse(val number: Long)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/","title":"DownloadAFileWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#downloadafilewebaction","title":"DownloadAFileWebAction","text":"[jvm]\\ @Singleton
class DownloadAFileWebAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#constructors","title":"Constructors","text":"DownloadAFileWebAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#functions","title":"Functions","text":"Name Summary download [jvm]fun download(name: String): Response<String>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/-download-a-file-web-action/","title":"DownloadAFileWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction/DownloadAFileWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/-download-a-file-web-action/#downloadafilewebaction","title":"DownloadAFileWebAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/download/","title":"download - Misk","text":"//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction/download
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/download/#download","title":"download","text":"[jvm]\\ fun download(name: String): Response<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/","title":"EchoFormAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#echoformaction","title":"EchoFormAction","text":"[jvm]\\ @Singleton
class EchoFormAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#constructors","title":"Constructors","text":"EchoFormAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#types","title":"Types","text":"Name Summary Form [jvm]data class Form(val string: String, val int: Int, val nullable: String?, val optional: String = \"optional\", val list: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#functions","title":"Functions","text":"Name Summary echo [jvm]fun echo(form: EchoFormAction.Form): EchoFormAction.Form"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-echo-form-action/","title":"EchoFormAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/EchoFormAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-echo-form-action/#echoformaction","title":"EchoFormAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/echo/","title":"echo - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/echo
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/echo/#echo","title":"echo","text":"[jvm]\\ fun echo(form: EchoFormAction.Form): EchoFormAction.Form
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/","title":"Form - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#form","title":"Form","text":"[jvm]\\ data class Form(val string: String, val int: Int, val nullable: String?, val optional: String = \"optional\", val list: List<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#constructors","title":"Constructors","text":"Form [jvm]constructor(string: String, int: Int, nullable: String?, optional: String = \"optional\", list: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#properties","title":"Properties","text":"Name Summary int [jvm]val int: Int list [jvm]val list: List<String> nullable [jvm]val nullable: String? optional [jvm]val optional: String string [jvm]val string: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/-form/","title":"Form - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/Form
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/-form/#form","title":"Form","text":"[jvm]\\ constructor(string: String, int: Int, nullable: String?, optional: String = \"optional\", list: List<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/int/","title":"int - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/int
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/int/#int","title":"int","text":"[jvm]\\ val int: Int
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/list/","title":"list - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/list
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/list/#list","title":"list","text":"[jvm]\\ val list: List<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/nullable/","title":"nullable - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/nullable
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/nullable/#nullable","title":"nullable","text":"[jvm]\\ val nullable: String?
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/optional/","title":"optional - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/optional
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/optional/#optional","title":"optional","text":"[jvm]\\ val optional: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/string/","title":"string - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/string
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/string/#string","title":"string","text":"[jvm]\\ val string: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/","title":"ExampleRateLimitConfiguration - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/#exampleratelimitconfiguration","title":"ExampleRateLimitConfiguration","text":"[jvm]\\ object ExampleRateLimitConfiguration : RateLimitConfiguration
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/#properties","title":"Properties","text":"Name Summary capacity [jvm]open override val capacity: Long = 10 name [jvm]open override val name: String refillAmount [jvm]open override val refillAmount: Long = 10 refillPeriod [jvm]open override val refillPeriod: Duration"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/capacity/","title":"capacity - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/capacity
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/capacity/#capacity","title":"capacity","text":"[jvm]\\ open override val capacity: Long = 10
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/name/","title":"name - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/name
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/name/#name","title":"name","text":"[jvm]\\ open override val name: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-amount/","title":"refillAmount - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/refillAmount
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-amount/#refillamount","title":"refillAmount","text":"[jvm]\\ open override val refillAmount: Long = 10
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-period/","title":"refillPeriod - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/refillPeriod
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-period/#refillperiod","title":"refillPeriod","text":"[jvm]\\ open override val refillPeriod: Duration
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/","title":"HelloPostResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#hellopostresponse","title":"HelloPostResponse","text":"[jvm]\\ data class HelloPostResponse(val greeting: String, val name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#constructors","title":"Constructors","text":"HelloPostResponse [jvm]constructor(greeting: String, name: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String name [jvm]val name: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/-hello-post-response/","title":"HelloPostResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse/HelloPostResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/-hello-post-response/#hellopostresponse","title":"HelloPostResponse","text":"[jvm]\\ constructor(greeting: String, name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/greeting/","title":"greeting - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse/greeting
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/greeting/#greeting","title":"greeting","text":"[jvm]\\ val greeting: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/name/","title":"name - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse/name
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/","title":"HelloResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#helloresponse","title":"HelloResponse","text":"[jvm]\\ data class HelloResponse(val greeting: String, val name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#constructors","title":"Constructors","text":"HelloResponse [jvm]constructor(greeting: String, name: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String name [jvm]val name: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/-hello-response/","title":"HelloResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse/HelloResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/-hello-response/#helloresponse","title":"HelloResponse","text":"[jvm]\\ constructor(greeting: String, name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/greeting/","title":"greeting - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse/greeting
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/greeting/#greeting","title":"greeting","text":"[jvm]\\ val greeting: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/name/","title":"name - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse/name
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/","title":"HelloWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#hellowebaction","title":"HelloWebAction","text":"[jvm]\\ @Singleton
class HelloWebAction@Injectconstructor(tokenGenerator: TokenGenerator) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#constructors","title":"Constructors","text":"HelloWebAction [jvm]@Injectconstructor(tokenGenerator: TokenGenerator)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(name: String, headers: Headers, nickName: String?, greetings: List<String>?): HelloResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/-hello-web-action/","title":"HelloWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebAction/HelloWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/-hello-web-action/#hellowebaction","title":"HelloWebAction","text":"[jvm]\\
@Inject
constructor(tokenGenerator: TokenGenerator)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/hello/#hello","title":"hello","text":"[jvm]\\ fun hello(name: String, headers: Headers, nickName: String?, greetings: List<String>?): HelloResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/","title":"HelloWebPostAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebPostAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#hellowebpostaction","title":"HelloWebPostAction","text":"[jvm]\\ @Singleton
class HelloWebPostAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#constructors","title":"Constructors","text":"HelloWebPostAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(name: String, body: PostBody): HelloPostResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/-hello-web-post-action/","title":"HelloWebPostAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebPostAction/HelloWebPostAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/-hello-web-post-action/#hellowebpostaction","title":"HelloWebPostAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebPostAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/hello/#hello","title":"hello","text":"[jvm]\\ fun hello(name: String, body: PostBody): HelloPostResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/","title":"HelloWebProtoAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#hellowebprotoaction","title":"HelloWebProtoAction","text":"[jvm]\\ class HelloWebProtoAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#constructors","title":"Constructors","text":"HelloWebProtoAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(request: HelloWebRequest): Response<HelloWebResponse>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/-hello-web-proto-action/","title":"HelloWebProtoAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction/HelloWebProtoAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/-hello-web-proto-action/#hellowebprotoaction","title":"HelloWebProtoAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/hello/#hello","title":"hello","text":"[jvm]\\ fun hello(request: HelloWebRequest): Response<HelloWebResponse>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/","title":"PostBody - Misk","text":"//exemplar/com.squareup.exemplar.actions/PostBody
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#postbody","title":"PostBody","text":"[jvm]\\ data class PostBody(val greeting: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#constructors","title":"Constructors","text":"PostBody [jvm]constructor(greeting: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/-post-body/","title":"PostBody - Misk","text":"//exemplar/com.squareup.exemplar.actions/PostBody/PostBody
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/-post-body/#postbody","title":"PostBody","text":"[jvm]\\ constructor(greeting: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/greeting/","title":"greeting - Misk","text":"//exemplar/com.squareup.exemplar.actions/PostBody/greeting
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/greeting/#greeting","title":"greeting","text":"[jvm]\\ val greeting: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/","title":"RateLimitedAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#ratelimitedaction","title":"RateLimitedAction","text":"[jvm]\\ @Singleton
class RateLimitedAction@Injectconstructor(rateLimiter: RateLimiter)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#constructors","title":"Constructors","text":"RateLimitedAction [jvm]@Injectconstructor(rateLimiter: RateLimiter)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#functions","title":"Functions","text":"Name Summary rateLimitedExample [jvm]fun rateLimitedExample(): RateLimitedExampleResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/-rate-limited-action/","title":"RateLimitedAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedAction/RateLimitedAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/-rate-limited-action/#ratelimitedaction","title":"RateLimitedAction","text":"[jvm]\\
@Inject
constructor(rateLimiter: RateLimiter)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/rate-limited-example/","title":"rateLimitedExample - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedAction/rateLimitedExample
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/rate-limited-example/#ratelimitedexample","title":"rateLimitedExample","text":"[jvm]\\ fun rateLimitedExample(): RateLimitedExampleResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/","title":"RateLimitedExampleResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#ratelimitedexampleresponse","title":"RateLimitedExampleResponse","text":"[jvm]\\ data class RateLimitedExampleResponse(val number: Long)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#constructors","title":"Constructors","text":"RateLimitedExampleResponse [jvm]constructor(number: Long)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#properties","title":"Properties","text":"Name Summary number [jvm]val number: Long"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/-rate-limited-example-response/","title":"RateLimitedExampleResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse/RateLimitedExampleResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/-rate-limited-example-response/#ratelimitedexampleresponse","title":"RateLimitedExampleResponse","text":"[jvm]\\ constructor(number: Long)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/number/","title":"number - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse/number
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/number/#number","title":"number","text":"[jvm]\\ val number: Long
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/#types","title":"Types","text":"Name Summary ExemplarDashboardModule [jvm]class ExemplarDashboardModule : KAbstractModule SupportDashboard [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class SupportDashboardDashboard Annotation used for all tabs bound in the Exemplar service support dashboard. SupportDashboardAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class SupportDashboardAccessAccess for the support dashboard."},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/","title":"ExemplarDashboardModule - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/ExemplarDashboardModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#exemplardashboardmodule","title":"ExemplarDashboardModule","text":"[jvm]\\ class ExemplarDashboardModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#constructors","title":"Constructors","text":"ExemplarDashboardModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/-exemplar-dashboard-module/","title":"ExemplarDashboardModule - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/ExemplarDashboardModule/ExemplarDashboardModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/-exemplar-dashboard-module/#exemplardashboardmodule","title":"ExemplarDashboardModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard/","title":"SupportDashboard - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/SupportDashboard
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard/#supportdashboard","title":"SupportDashboard","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])
annotation class SupportDashboard
Dashboard Annotation used for all tabs bound in the Exemplar service support dashboard.
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard-access/","title":"SupportDashboardAccess - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/SupportDashboardAccess
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard-access/#supportdashboardaccess","title":"SupportDashboardAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class SupportDashboardAccess
Access for the support dashboard.
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#types","title":"Types","text":"Name Summary AlphaIndexAction [jvm]@Singletonclass AlphaIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#properties","title":"Properties","text":"Name Summary dashboardIndexAccessBlock [jvm]val dashboardIndexAccessBlock: DashboardIndexAccessBlock dashboardIndexBlock1 [jvm]val dashboardIndexBlock1: DashboardIndexBlock dashboardIndexBlock2 [jvm]val dashboardIndexBlock2: DashboardIndexBlock"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-access-block/","title":"dashboardIndexAccessBlock - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexAccessBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-access-block/#dashboardindexaccessblock","title":"dashboardIndexAccessBlock","text":"[jvm]\\ val dashboardIndexAccessBlock: DashboardIndexAccessBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block1/","title":"dashboardIndexBlock1 - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexBlock1
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block1/#dashboardindexblock1","title":"dashboardIndexBlock1","text":"[jvm]\\ val dashboardIndexBlock1: DashboardIndexBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block2/","title":"dashboardIndexBlock2 - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexBlock2
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block2/#dashboardindexblock2","title":"dashboardIndexBlock2","text":"[jvm]\\ val dashboardIndexBlock2: DashboardIndexBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/","title":"AlphaIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#alphaindexaction","title":"AlphaIndexAction","text":"[jvm]\\ @Singleton
class AlphaIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#constructors","title":"Constructors","text":"AlphaIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-alpha-index-action/","title":"AlphaIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/AlphaIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-alpha-index-action/#alphaindexaction","title":"AlphaIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/#types","title":"Types","text":"Name Summary EcommerceLandingPage [jvm]@Singletonclass EcommerceLandingPage@Injectconstructor(appName: String, deployment: Deployment) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages GraphD3JsPage [jvm]@Singletonclass GraphD3JsPage@Injectconstructor : WebActionExample page that shows usage of D3.js graph library https://d3js.org/ IndexPage [jvm]@Singletonclass IndexPage@Injectconstructor(appName: String, deployment: Deployment) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages SimplePage [jvm]@Singletonclass SimplePage@Injectconstructor(appName: String) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/","title":"EcommerceLandingPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#ecommercelandingpage","title":"EcommerceLandingPage","text":"[jvm]\\ @Singleton
class EcommerceLandingPage@Injectconstructor(appName: String, deployment: Deployment) : WebAction
Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#constructors","title":"Constructors","text":"EcommerceLandingPage [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-ecommerce-landing-page/","title":"EcommerceLandingPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/EcommerceLandingPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-ecommerce-landing-page/#ecommercelandingpage","title":"EcommerceLandingPage","text":"[jvm]\\
@Inject
constructor(appName: String, deployment: Deployment)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/","title":"GraphD3JsPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#graphd3jspage","title":"GraphD3JsPage","text":"[jvm]\\ @Singleton
class GraphD3JsPage@Injectconstructor : WebAction
Example page that shows usage of D3.js graph library https://d3js.org/
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#constructors","title":"Constructors","text":"GraphD3JsPage [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-graph-d3-js-page/","title":"GraphD3JsPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/GraphD3JsPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-graph-d3-js-page/#graphd3jspage","title":"GraphD3JsPage","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/","title":"IndexPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#indexpage","title":"IndexPage","text":"[jvm]\\ @Singleton
class IndexPage@Injectconstructor(appName: String, deployment: Deployment) : WebAction
Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#constructors","title":"Constructors","text":"IndexPage [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/-index-page/","title":"IndexPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage/IndexPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/-index-page/#indexpage","title":"IndexPage","text":"[jvm]\\
@Inject
constructor(appName: String, deployment: Deployment)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/","title":"SimplePage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#simplepage","title":"SimplePage","text":"[jvm]\\ @Singleton
class SimplePage@Injectconstructor(appName: String) : WebAction
Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#constructors","title":"Constructors","text":"SimplePage [jvm]@Injectconstructor(appName: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-simple-page/","title":"SimplePage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/SimplePage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-simple-page/#simplepage","title":"SimplePage","text":"[jvm]\\
@Inject
constructor(appName: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/#types","title":"Types","text":"Name Summary SupportBravoIndexAction [jvm]@Singletonclass SupportBravoIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction SupportDashboardIndexAction [jvm]@Singletonclass SupportDashboardIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/","title":"SupportBravoIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#supportbravoindexaction","title":"SupportBravoIndexAction","text":"[jvm]\\ @Singleton
class SupportBravoIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#constructors","title":"Constructors","text":"SupportBravoIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/-support-bravo-index-action/","title":"SupportBravoIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction/SupportBravoIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/-support-bravo-index-action/#supportbravoindexaction","title":"SupportBravoIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/","title":"SupportDashboardIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#supportdashboardindexaction","title":"SupportDashboardIndexAction","text":"[jvm]\\ @Singleton
class SupportDashboardIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#constructors","title":"Constructors","text":"SupportDashboardIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/-support-dashboard-index-action/","title":"SupportDashboardIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction/SupportDashboardIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/-support-dashboard-index-action/#supportdashboardindexaction","title":"SupportDashboardIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplarchat/","title":"exemplarchat - Misk","text":"//exemplarchat
"},{"location":"0.x/exemplarchat/#exemplarchat","title":"exemplarchat","text":""},{"location":"0.x/exemplarchat/#packages","title":"Packages","text":"Name com.squareup.chat com.squareup.chat.actions com.squareup.chat.healthchecks"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/","title":"Package-level declarations - Misk","text":"//exemplarchat/com.squareup.chat
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#types","title":"Types","text":"Name Summary ChatConfig [jvm]data class ChatConfig(val web: WebConfig, val prometheus: PrometheusConfig, val kubernetes: KubernetesConfig = KubernetesConfig()) : Config ChatLogging [jvm]object ChatLogging ChatModule [jvm]class ChatModule : KAbstractModule"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#functions","title":"Functions","text":"Name Summary main [jvm]fun main(args: Array<String>)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/main/","title":"main - Misk","text":"//exemplarchat/com.squareup.chat/main
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/main/#main","title":"main","text":"[jvm]\\ fun main(args: Array<String>)
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/","title":"ChatConfig - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#chatconfig","title":"ChatConfig","text":"[jvm]\\ data class ChatConfig(val web: WebConfig, val prometheus: PrometheusConfig, val kubernetes: KubernetesConfig = KubernetesConfig()) : Config
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#constructors","title":"Constructors","text":"ChatConfig [jvm]constructor(web: WebConfig, prometheus: PrometheusConfig, kubernetes: KubernetesConfig = KubernetesConfig())"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#properties","title":"Properties","text":"Name Summary kubernetes [jvm]val kubernetes: KubernetesConfig prometheus [jvm]val prometheus: PrometheusConfig web [jvm]val web: WebConfig"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/-chat-config/","title":"ChatConfig - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/ChatConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/-chat-config/#chatconfig","title":"ChatConfig","text":"[jvm]\\ constructor(web: WebConfig, prometheus: PrometheusConfig, kubernetes: KubernetesConfig = KubernetesConfig())
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/kubernetes/","title":"kubernetes - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/kubernetes
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/kubernetes/#kubernetes","title":"kubernetes","text":"[jvm]\\ val kubernetes: KubernetesConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/prometheus/","title":"prometheus - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/prometheus
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/prometheus/#prometheus","title":"prometheus","text":"[jvm]\\ val prometheus: PrometheusConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/web/","title":"web - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/web
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/web/#web","title":"web","text":"[jvm]\\ val web: WebConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/","title":"ChatLogging - Misk","text":"//exemplarchat/com.squareup.chat/ChatLogging
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/#chatlogging","title":"ChatLogging","text":"[jvm]\\ object ChatLogging
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/configure/","title":"configure - Misk","text":"//exemplarchat/com.squareup.chat/ChatLogging/configure
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/configure/#configure","title":"configure","text":"[jvm]\\ fun configure()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/","title":"ChatModule - Misk","text":"//exemplarchat/com.squareup.chat/ChatModule
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#chatmodule","title":"ChatModule","text":"[jvm]\\ class ChatModule : KAbstractModule
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#constructors","title":"Constructors","text":"ChatModule [jvm]constructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/-chat-module/","title":"ChatModule - Misk","text":"//exemplarchat/com.squareup.chat/ChatModule/ChatModule
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/-chat-module/#chatmodule","title":"ChatModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/","title":"Package-level declarations - Misk","text":"//exemplarchat/com.squareup.chat.actions
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/#types","title":"Types","text":"Name Summary ChatWebSocketAction [jvm]@Singletonclass ChatWebSocketAction@Injectconstructor(redis: Redis) : WebActionChatWebSocketAction is a basic chat program which supports multiple chat rooms and their histories through web socket connections. ToggleManualHealthCheckAction [jvm]@Singletonclass ToggleManualHealthCheckAction@Injectconstructor : WebAction"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/","title":"ChatWebSocketAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#chatwebsocketaction","title":"ChatWebSocketAction","text":"[jvm]\\ @Singleton
class ChatWebSocketAction@Injectconstructor(redis: Redis) : WebAction
ChatWebSocketAction is a basic chat program which supports multiple chat rooms and their histories through web socket connections.
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#constructors","title":"Constructors","text":"ChatWebSocketAction [jvm]@Injectconstructor(redis: Redis)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#functions","title":"Functions","text":"Name Summary chat [jvm]fun chat(name: String, webSocket: WebSocket): WebSocketListener"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/-chat-web-socket-action/","title":"ChatWebSocketAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction/ChatWebSocketAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/-chat-web-socket-action/#chatwebsocketaction","title":"ChatWebSocketAction","text":"[jvm]\\
@Inject
constructor(redis: Redis)
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/chat/","title":"chat - Misk","text":"//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction/chat
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/chat/#chat","title":"chat","text":"[jvm]\\ fun chat(name: String, webSocket: WebSocket): WebSocketListener
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/","title":"ToggleManualHealthCheckAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#togglemanualhealthcheckaction","title":"ToggleManualHealthCheckAction","text":"[jvm]\\ @Singleton
class ToggleManualHealthCheckAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#constructors","title":"Constructors","text":"ToggleManualHealthCheckAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#properties","title":"Properties","text":"Name Summary manualHealthCheck [jvm]@Injectlateinit var manualHealthCheck: ManualHealthCheck"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#functions","title":"Functions","text":"Name Summary setManualHealthCheck [jvm]fun setManualHealthCheck(status: String?): Response<String>"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/-toggle-manual-health-check-action/","title":"ToggleManualHealthCheckAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/ToggleManualHealthCheckAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/-toggle-manual-health-check-action/#togglemanualhealthcheckaction","title":"ToggleManualHealthCheckAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/manual-health-check/","title":"manualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/manualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/manual-health-check/#manualhealthcheck","title":"manualHealthCheck","text":"[jvm]\\
@Inject
lateinit var manualHealthCheck: ManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/set-manual-health-check/","title":"setManualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/setManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/set-manual-health-check/#setmanualhealthcheck","title":"setManualHealthCheck","text":"[jvm]\\ fun setManualHealthCheck(status: String?): Response<String>
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/","title":"Package-level declarations - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/#types","title":"Types","text":"Name Summary ManualHealthCheck [jvm]@Singletonclass ManualHealthCheck : HealthCheck"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/","title":"ManualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#manualhealthcheck","title":"ManualHealthCheck","text":"[jvm]\\ @Singleton
class ManualHealthCheck : HealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#constructors","title":"Constructors","text":"ManualHealthCheck [jvm]constructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#functions","title":"Functions","text":"Name Summary setHealth [jvm]fun setHealth() setUnhealthy [jvm]fun setUnhealthy() status [jvm]open override fun status(): HealthStatus"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/-manual-health-check/","title":"ManualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/ManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/-manual-health-check/#manualhealthcheck","title":"ManualHealthCheck","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-health/","title":"setHealth - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/setHealth
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-health/#sethealth","title":"setHealth","text":"[jvm]\\ fun setHealth()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-unhealthy/","title":"setUnhealthy - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/setUnhealthy
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-unhealthy/#setunhealthy","title":"setUnhealthy","text":"[jvm]\\ fun setUnhealthy()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/status/","title":"status - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/status
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/status/#status","title":"status","text":"[jvm]\\ open override fun status(): HealthStatus
"},{"location":"0.x/misk/","title":"misk - Misk","text":"//misk
"},{"location":"0.x/misk/#misk","title":"misk","text":""},{"location":"0.x/misk/#packages","title":"Packages","text":"Name misk misk.client misk.concurrent misk.environment misk.grpc misk.io misk.jvm misk.logging misk.monitoring misk.moshi misk.moshi.adapters misk.moshi.okio misk.moshi.time misk.okio misk.perf misk.security.authz misk.security.cert misk.security.csp misk.security.keys misk.security.ssl misk.tasks misk.time misk.web misk.web.actions misk.web.concurrencylimits misk.web.exceptions misk.web.extractors misk.web.formatter misk.web.interceptors misk.web.jetty misk.web.marshal misk.web.mdc misk.web.metadata.guice misk.web.metadata.webaction misk.web.proxy misk.web.resources"},{"location":"0.x/misk/misk/misk/","title":"Package-level declarations - Misk","text":"//misk/misk
"},{"location":"0.x/misk/misk/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk/#types","title":"Types","text":"Name Summary Action [jvm]data class Action(val name: String, val function: KFunction<*>, val acceptedMediaRanges: List<MediaRange>, val responseContentType: MediaType?, val parameters: List<KParameter>, val returnType: KType, val dispatchMechanism: DispatchMechanism) ApplicationInterceptor [jvm]interface ApplicationInterceptor Chain [jvm]interface Chain MiskApplication [jvm]class MiskApplicationThe entry point for misk applications MiskCommand [jvm]abstract class MiskCommand(name: String, modules: List<Module>) : RunnableA command to run from the command line. Each command has an associated name and the list of modules to use in initializing the command. Commands can specify optional and required arguments via JCommander annotations. The command line will pick the appropriate command based on the name, create an injector based on that command\u2019s modules, use the injector to initialize the command, and then run the command. MiskCommonServiceModule [jvm]class MiskCommonServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModuleThis module has common bindings for all environments (both real and testing). MiskRealServiceModule [jvm]class MiskRealServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModuleInstall this module in real environments."},{"location":"0.x/misk/misk/misk/#functions","title":"Functions","text":"Name Summary asAction [jvm]fun KFunction<*>.asAction(dispatchMechanism: DispatchMechanism, responseContentType: MediaType? = singleOrNullResponseMediaType()): Action"},{"location":"0.x/misk/misk/misk/as-action/","title":"asAction - Misk","text":"//misk/misk/asAction
"},{"location":"0.x/misk/misk/misk/as-action/#asaction","title":"asAction","text":"[jvm]\\ fun KFunction<*>.asAction(dispatchMechanism: DispatchMechanism, responseContentType: MediaType? = singleOrNullResponseMediaType()): Action
"},{"location":"0.x/misk/misk/misk/-action/","title":"Action - Misk","text":"//misk/misk/Action
"},{"location":"0.x/misk/misk/misk/-action/#action","title":"Action","text":"[jvm]\\ data class Action(val name: String, val function: KFunction<*>, val acceptedMediaRanges: List<MediaRange>, val responseContentType: MediaType?, val parameters: List<KParameter>, val returnType: KType, val dispatchMechanism: DispatchMechanism)
"},{"location":"0.x/misk/misk/misk/-action/#constructors","title":"Constructors","text":"Action [jvm]constructor(name: String, function: KFunction<*>, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameters: List<KParameter>, returnType: KType, dispatchMechanism: DispatchMechanism)"},{"location":"0.x/misk/misk/misk/-action/#properties","title":"Properties","text":"Name Summary acceptedMediaRanges [jvm]val acceptedMediaRanges: List<MediaRange> dispatchMechanism [jvm]val dispatchMechanism: DispatchMechanism function [jvm]val function: KFunction<*> name [jvm]val name: String parameters [jvm]val parameters: List<KParameter> parameterTypes [jvm]val parameterTypes: List<KType>ParameterTypes and RequestType can differ because RequestType pertains only to the type of the request body, whereas ParameterTypes includes other parts of the request such as path params and query params. requestType [jvm]val requestType: KType? responseContentType [jvm]val responseContentType: MediaType? returnType [jvm]val returnType: KType"},{"location":"0.x/misk/misk/misk/-action/#functions","title":"Functions","text":"Name Summary hasReturnValue [jvm]fun hasReturnValue(): Boolean toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk/-action/-action/","title":"Action - Misk","text":"//misk/misk/Action/Action
"},{"location":"0.x/misk/misk/misk/-action/-action/#action","title":"Action","text":"[jvm]\\ constructor(name: String, function: KFunction<*>, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameters: List<KParameter>, returnType: KType, dispatchMechanism: DispatchMechanism)
"},{"location":"0.x/misk/misk/misk/-action/accepted-media-ranges/","title":"acceptedMediaRanges - Misk","text":"//misk/misk/Action/acceptedMediaRanges
"},{"location":"0.x/misk/misk/misk/-action/accepted-media-ranges/#acceptedmediaranges","title":"acceptedMediaRanges","text":"[jvm]\\ val acceptedMediaRanges: List<MediaRange>
"},{"location":"0.x/misk/misk/misk/-action/dispatch-mechanism/","title":"dispatchMechanism - Misk","text":"//misk/misk/Action/dispatchMechanism
"},{"location":"0.x/misk/misk/misk/-action/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"[jvm]\\ val dispatchMechanism: DispatchMechanism
"},{"location":"0.x/misk/misk/misk/-action/function/","title":"function - Misk","text":"//misk/misk/Action/function
"},{"location":"0.x/misk/misk/misk/-action/function/#function","title":"function","text":"[jvm]\\ val function: KFunction<*>
"},{"location":"0.x/misk/misk/misk/-action/has-return-value/","title":"hasReturnValue - Misk","text":"//misk/misk/Action/hasReturnValue
"},{"location":"0.x/misk/misk/misk/-action/has-return-value/#hasreturnvalue","title":"hasReturnValue","text":"[jvm]\\ fun hasReturnValue(): Boolean
"},{"location":"0.x/misk/misk/misk/-action/name/","title":"name - Misk","text":"//misk/misk/Action/name
"},{"location":"0.x/misk/misk/misk/-action/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk/-action/parameter-types/","title":"parameterTypes - Misk","text":"//misk/misk/Action/parameterTypes
"},{"location":"0.x/misk/misk/misk/-action/parameter-types/#parametertypes","title":"parameterTypes","text":"[jvm]\\ val parameterTypes: List<KType>
ParameterTypes and RequestType can differ because RequestType pertains only to the type of the request body, whereas ParameterTypes includes other parts of the request such as path params and query params.
"},{"location":"0.x/misk/misk/misk/-action/parameters/","title":"parameters - Misk","text":"//misk/misk/Action/parameters
"},{"location":"0.x/misk/misk/misk/-action/parameters/#parameters","title":"parameters","text":"[jvm]\\ val parameters: List<KParameter>
"},{"location":"0.x/misk/misk/misk/-action/request-type/","title":"requestType - Misk","text":"//misk/misk/Action/requestType
"},{"location":"0.x/misk/misk/misk/-action/request-type/#requesttype","title":"requestType","text":"[jvm]\\ val requestType: KType?
"},{"location":"0.x/misk/misk/misk/-action/response-content-type/","title":"responseContentType - Misk","text":"//misk/misk/Action/responseContentType
"},{"location":"0.x/misk/misk/misk/-action/response-content-type/#responsecontenttype","title":"responseContentType","text":"[jvm]\\ val responseContentType: MediaType?
"},{"location":"0.x/misk/misk/misk/-action/return-type/","title":"returnType - Misk","text":"//misk/misk/Action/returnType
"},{"location":"0.x/misk/misk/misk/-action/return-type/#returntype","title":"returnType","text":"[jvm]\\ val returnType: KType
"},{"location":"0.x/misk/misk/misk/-action/to-string/","title":"toString - Misk","text":"//misk/misk/Action/toString
"},{"location":"0.x/misk/misk/misk/-action/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk/-application-interceptor/","title":"ApplicationInterceptor - Misk","text":"//misk/misk/ApplicationInterceptor
"},{"location":"0.x/misk/misk/misk/-application-interceptor/#applicationinterceptor","title":"ApplicationInterceptor","text":"interface ApplicationInterceptor
"},{"location":"0.x/misk/misk/misk/-application-interceptor/#inheritors","title":"Inheritors","text":"AccessInterceptor RequestBodyLoggingInterceptor"},{"location":"0.x/misk/misk/misk/-application-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface Factory"},{"location":"0.x/misk/misk/misk/-application-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk/-application-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk/ApplicationInterceptor/intercept
"},{"location":"0.x/misk/misk/misk/-application-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ abstract fun intercept(chain: Chain): Any
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk/ApplicationInterceptor/Factory
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#factory","title":"Factory","text":"interface Factory
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#inheritors","title":"Inheritors","text":"Factory"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): ApplicationInterceptor?"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk/ApplicationInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action): ApplicationInterceptor?
"},{"location":"0.x/misk/misk/misk/-chain/","title":"Chain - Misk","text":"//misk/misk/Chain
"},{"location":"0.x/misk/misk/misk/-chain/#chain","title":"Chain","text":"[jvm]\\ interface Chain
"},{"location":"0.x/misk/misk/misk/-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: WebAction args [jvm]abstract val args: List<Any?> function [jvm]abstract val function: KFunction<*> httpCall [jvm]abstract val httpCall: HttpCall"},{"location":"0.x/misk/misk/misk/-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<Any?>): Any"},{"location":"0.x/misk/misk/misk/-chain/action/","title":"action - Misk","text":"//misk/misk/Chain/action
"},{"location":"0.x/misk/misk/misk/-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: WebAction
"},{"location":"0.x/misk/misk/misk/-chain/args/","title":"args - Misk","text":"//misk/misk/Chain/args
"},{"location":"0.x/misk/misk/misk/-chain/args/#args","title":"args","text":"[jvm]\\ abstract val args: List<Any?>
"},{"location":"0.x/misk/misk/misk/-chain/function/","title":"function - Misk","text":"//misk/misk/Chain/function
"},{"location":"0.x/misk/misk/misk/-chain/function/#function","title":"function","text":"[jvm]\\ abstract val function: KFunction<*>
"},{"location":"0.x/misk/misk/misk/-chain/http-call/","title":"httpCall - Misk","text":"//misk/misk/Chain/httpCall
"},{"location":"0.x/misk/misk/misk/-chain/http-call/#httpcall","title":"httpCall","text":"[jvm]\\ abstract val httpCall: HttpCall
"},{"location":"0.x/misk/misk/misk/-chain/proceed/","title":"proceed - Misk","text":"//misk/misk/Chain/proceed
"},{"location":"0.x/misk/misk/misk/-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(args: List<Any?>): Any
"},{"location":"0.x/misk/misk/misk/-misk-application/","title":"MiskApplication - Misk","text":"//misk/misk/MiskApplication
"},{"location":"0.x/misk/misk/misk/-misk-application/#miskapplication","title":"MiskApplication","text":"[jvm]\\ class MiskApplication
The entry point for misk applications
"},{"location":"0.x/misk/misk/misk/-misk-application/#constructors","title":"Constructors","text":"MiskApplication [jvm]constructor(vararg modules: Module)constructor(vararg commands: MiskCommand)constructor(modules: List<Module>, commands: List<MiskCommand> = listOf())constructor(injector: Injector)"},{"location":"0.x/misk/misk/misk/-misk-application/#functions","title":"Functions","text":"Name Summary run [jvm]fun run(args: Array<String>)Runs the application, finding and executing the appropriate command based on the provided command line arguments"},{"location":"0.x/misk/misk/misk/-misk-application/-misk-application/","title":"MiskApplication - Misk","text":"//misk/misk/MiskApplication/MiskApplication
"},{"location":"0.x/misk/misk/misk/-misk-application/-misk-application/#miskapplication","title":"MiskApplication","text":"[jvm]\\ constructor(vararg modules: Module)
constructor(vararg commands: MiskCommand)
constructor(modules: List<Module>, commands: List<MiskCommand> = listOf())
constructor(injector: Injector)
"},{"location":"0.x/misk/misk/misk/-misk-application/run/","title":"run - Misk","text":"//misk/misk/MiskApplication/run
"},{"location":"0.x/misk/misk/misk/-misk-application/run/#run","title":"run","text":"[jvm]\\ fun run(args: Array<String>)
Runs the application, finding and executing the appropriate command based on the provided command line arguments
"},{"location":"0.x/misk/misk/misk/-misk-command/","title":"MiskCommand - Misk","text":"//misk/misk/MiskCommand
"},{"location":"0.x/misk/misk/misk/-misk-command/#miskcommand","title":"MiskCommand","text":"[jvm]\\ abstract class MiskCommand(name: String, modules: List<Module>) : Runnable
A command to run from the command line. Each command has an associated name and the list of modules to use in initializing the command. Commands can specify optional and required arguments via JCommander annotations. The command line will pick the appropriate command based on the name, create an injector based on that command\u2019s modules, use the injector to initialize the command, and then run the command.
"},{"location":"0.x/misk/misk/misk/-misk-command/#constructors","title":"Constructors","text":"MiskCommand [jvm]constructor(name: String, vararg modules: Module)constructor(name: String, modules: List<Module>)"},{"location":"0.x/misk/misk/misk/-misk-command/#functions","title":"Functions","text":"Name Summary requireCli [jvm]fun requireCli(value: Boolean, lazyMessage: () -> String)Confirms that the given precondition is true, otherwise throws a ParameterException with the supplied message. run [jvm]abstract fun run()"},{"location":"0.x/misk/misk/misk/-misk-command/-misk-command/","title":"MiskCommand - Misk","text":"//misk/misk/MiskCommand/MiskCommand
"},{"location":"0.x/misk/misk/misk/-misk-command/-misk-command/#miskcommand","title":"MiskCommand","text":"[jvm]\\ constructor(name: String, vararg modules: Module)
constructor(name: String, modules: List<Module>)
"},{"location":"0.x/misk/misk/misk/-misk-command/require-cli/","title":"requireCli - Misk","text":"//misk/misk/MiskCommand/requireCli
"},{"location":"0.x/misk/misk/misk/-misk-command/require-cli/#requirecli","title":"requireCli","text":"[jvm]\\ fun requireCli(value: Boolean, lazyMessage: () -> String)
Confirms that the given precondition is true, otherwise throws a ParameterException with the supplied message.
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/","title":"MiskCommonServiceModule - Misk","text":"//misk/misk/MiskCommonServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#miskcommonservicemodule","title":"MiskCommonServiceModule","text":"[jvm]\\ class MiskCommonServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule
This module has common bindings for all environments (both real and testing).
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#constructors","title":"Constructors","text":"MiskCommonServiceModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/-misk-common-service-module/","title":"MiskCommonServiceModule - Misk","text":"//misk/misk/MiskCommonServiceModule/MiskCommonServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/-misk-common-service-module/#miskcommonservicemodule","title":"MiskCommonServiceModule","text":"[jvm]\\
@JvmOverloads
constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/","title":"MiskRealServiceModule - Misk","text":"//misk/misk/MiskRealServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#miskrealservicemodule","title":"MiskRealServiceModule","text":"[jvm]\\ class MiskRealServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule
Install this module in real environments.
The vast majority of Service bindings belong in MiskCommonServiceModule, in order to share with MiskTestingServiceModule. Only bindings that are not suitable for a unit testing environment belong here.
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#constructors","title":"Constructors","text":"MiskRealServiceModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/-misk-real-service-module/","title":"MiskRealServiceModule - Misk","text":"//misk/misk/MiskRealServiceModule/MiskRealServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/-misk-real-service-module/#miskrealservicemodule","title":"MiskRealServiceModule","text":"[jvm]\\
@JvmOverloads
constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())
"},{"location":"0.x/misk/misk/misk.client/","title":"Package-level declarations - Misk","text":"//misk/misk.client
"},{"location":"0.x/misk/misk/misk.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.client/#types","title":"Types","text":"Name Summary BackwardsCompatibleClientsConfig [jvm]data class BackwardsCompatibleClientsConfig@JvmOverloadsconstructor(val defaultConnectTimeout: Duration? = null, val defaultWriteTimeout: Duration? = null, val defaultReadTimeout: Duration? = null, val ssl: HttpClientSSLConfig? = null, val defaultPingInterval: Duration? = null, val defaultCallTimeout: Duration? = null, val endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val logRequests: Boolean = false) BackwardsCompatibleClientsConfigConverter [jvm]class BackwardsCompatibleClientsConfigConverter : Converter<BackwardsCompatibleClientsConfig, HttpClientsConfig> BackwardsCompatibleEndpointConfig [jvm]data class BackwardsCompatibleEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int = 128, val maxRequestsPerHost: Int = 32, val maxIdleConnections: Int = 100, val keepAliveDuration: Duration = Duration.ofMinutes(5), val ssl: HttpClientSSLConfig? = null, val clientConfig: HttpClientConfig? = null) BeginClientCallChain [jvm]interface BeginClientCallChain CallFactoryWrapper [jvm]interface CallFactoryWrapperCallFactoryWrapper is a way to extend the functionality of the okhttp3.Call.Factory instance injected to typed http clients and gRPC clients created by TypedClientFactoryProvider and GrpcClientProvider. ClientApplicationInterceptorFactory [jvm]interface ClientApplicationInterceptorFactory ClientChain [jvm]interface ClientChain ClientMetricsInterceptor [jvm]class ClientMetricsInterceptor : Interceptor ClientNetworkInterceptorsModule [jvm]class ClientNetworkInterceptorsModule : KAbstractModuleThe common set of ClientNetworkInterceptors for all misk apps. GrpcClientModule [jvm]class GrpcClientModule<T : Service, G : T>@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0) : KAbstractModuleCreates a gRPC client given a Wire-generated interface and HTTP configuration. HttpClientConfig [jvm]data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null) HttpClientConfigUrlProvider [jvm]class HttpClientConfigUrlProvider@InjectconstructorCalculates the url for an http client config, which can differ depending on if the client is envoy-based or connects directly. HttpClientEndpointConfig [jvm]data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig()) HttpClientEnvoyConfig [jvm]data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null) HttpClientFactory [jvm]@Singletonclass HttpClientFactory@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator) HttpClientModule [jvm]class HttpClientModule@JvmOverloadsconstructor(name: String, annotation: Annotation? = null) : KAbstractModuleProvides an OkHttpClient and ProtoMessageHttpClient for a peer service HttpClientsConfig [jvm]data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), val logRequests: Boolean = false) : Config HttpClientsConfigModule [jvm]class HttpClientsConfigModule(config: HttpClientsConfig) : KAbstractModule HttpClientSSLConfig [jvm]data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig) JettyPortPeerClientModule [jvm]class JettyPortPeerClientModule : KAbstractModuleFor testing. OkHttpClientCommonConfigurator [jvm]class OkHttpClientCommonConfigurator@Injectconstructor PeerClientFactory [jvm]class PeerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)Factory that creates OkHttpClients for connecting to another instance of the same application running in the same cluster. PeerClientModule [jvm]class PeerClientModule : KAbstractModuleBinds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the SSL port in the WebConfig. ProtoMessageHttpClient [jvm]class ProtoMessageHttpClient(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)This helper class is for making HTTP requests to an endpoint that handles protobuf Message classes. TypedClientFactory [jvm]class TypedClientFactory@Injectconstructor TypedHttpClientModule [jvm]class TypedHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModuleCreates a retrofit-backed typed client given an API interface and an HTTP configuration. TypedPeerClientFactory [jvm]interface TypedPeerClientFactory<T>Factory for creating typed clients that call other members of a cluster. TypedPeerHttpClientModule [jvm]class TypedPeerHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModuleCreates a retrofit-backed typed client factory given an API interface and an HTTP configuration."},{"location":"0.x/misk/misk/misk.client/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/misk/misk/misk.client/apply-defaults/","title":"applyDefaults - Misk","text":"//misk/misk.client/applyDefaults
"},{"location":"0.x/misk/misk/misk.client/apply-defaults/#applydefaults","title":"applyDefaults","text":"[jvm]\\ fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/","title":"BackwardsCompatibleClientsConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#backwardscompatibleclientsconfig","title":"BackwardsCompatibleClientsConfig","text":"[jvm]\\ data class BackwardsCompatibleClientsConfig@JvmOverloadsconstructor(val defaultConnectTimeout: Duration? = null, val defaultWriteTimeout: Duration? = null, val defaultReadTimeout: Duration? = null, val ssl: HttpClientSSLConfig? = null, val defaultPingInterval: Duration? = null, val defaultCallTimeout: Duration? = null, val endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val logRequests: Boolean = false)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#constructors","title":"Constructors","text":"BackwardsCompatibleClientsConfig [jvm]@JvmOverloadsconstructor(defaultConnectTimeout: Duration? = null, defaultWriteTimeout: Duration? = null, defaultReadTimeout: Duration? = null, ssl: HttpClientSSLConfig? = null, defaultPingInterval: Duration? = null, defaultCallTimeout: Duration? = null, endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), logRequests: Boolean = false)"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#properties","title":"Properties","text":"Name Summary defaultCallTimeout [jvm]val defaultCallTimeout: Duration? = null defaultConnectTimeout [jvm]val defaultConnectTimeout: Duration? = null defaultPingInterval [jvm]val defaultPingInterval: Duration? = null defaultReadTimeout [jvm]val defaultReadTimeout: Duration? = null defaultWriteTimeout [jvm]val defaultWriteTimeout: Duration? = null endpoints [jvm]val endpoints: Map<String, BackwardsCompatibleEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig> logRequests [jvm]val logRequests: Boolean = false ssl [jvm]val ssl: HttpClientSSLConfig? = null"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/-backwards-compatible-clients-config/","title":"BackwardsCompatibleClientsConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/BackwardsCompatibleClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/-backwards-compatible-clients-config/#backwardscompatibleclientsconfig","title":"BackwardsCompatibleClientsConfig","text":"[jvm]\\
@JvmOverloads
constructor(defaultConnectTimeout: Duration? = null, defaultWriteTimeout: Duration? = null, defaultReadTimeout: Duration? = null, ssl: HttpClientSSLConfig? = null, defaultPingInterval: Duration? = null, defaultCallTimeout: Duration? = null, endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), logRequests: Boolean = false)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-call-timeout/","title":"defaultCallTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultCallTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-call-timeout/#defaultcalltimeout","title":"defaultCallTimeout","text":"[jvm]\\ val defaultCallTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-connect-timeout/","title":"defaultConnectTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultConnectTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-connect-timeout/#defaultconnecttimeout","title":"defaultConnectTimeout","text":"[jvm]\\ val defaultConnectTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-ping-interval/","title":"defaultPingInterval - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultPingInterval
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-ping-interval/#defaultpinginterval","title":"defaultPingInterval","text":"[jvm]\\ val defaultPingInterval: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-read-timeout/","title":"defaultReadTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultReadTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-read-timeout/#defaultreadtimeout","title":"defaultReadTimeout","text":"[jvm]\\ val defaultReadTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-write-timeout/","title":"defaultWriteTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultWriteTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-write-timeout/#defaultwritetimeout","title":"defaultWriteTimeout","text":"[jvm]\\ val defaultWriteTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/endpoints/","title":"endpoints - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/endpoints
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/endpoints/#endpoints","title":"endpoints","text":"[jvm]\\ val endpoints: Map<String, BackwardsCompatibleEndpointConfig>
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/host-configs/","title":"hostConfigs - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/hostConfigs
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/log-requests/","title":"logRequests - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/logRequests
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/log-requests/#logrequests","title":"logRequests","text":"[jvm]\\ val logRequests: Boolean = false
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/ssl/","title":"ssl - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/ssl
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/","title":"BackwardsCompatibleClientsConfigConverter - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#backwardscompatibleclientsconfigconverter","title":"BackwardsCompatibleClientsConfigConverter","text":"[jvm]\\ class BackwardsCompatibleClientsConfigConverter : Converter<BackwardsCompatibleClientsConfig, HttpClientsConfig>
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#constructors","title":"Constructors","text":"BackwardsCompatibleClientsConfigConverter [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#functions","title":"Functions","text":"Name Summary convert [jvm]open override fun convert(value: BackwardsCompatibleClientsConfig): HttpClientsConfig getInputType [jvm]open override fun getInputType(typeFactory: TypeFactory): JavaType getOutputType [jvm]open override fun getOutputType(typeFactory: TypeFactory): JavaType"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/-backwards-compatible-clients-config-converter/","title":"BackwardsCompatibleClientsConfigConverter - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/BackwardsCompatibleClientsConfigConverter
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/-backwards-compatible-clients-config-converter/#backwardscompatibleclientsconfigconverter","title":"BackwardsCompatibleClientsConfigConverter","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/convert/","title":"convert - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/convert
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/convert/#convert","title":"convert","text":"[jvm]\\ open override fun convert(value: BackwardsCompatibleClientsConfig): HttpClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-input-type/","title":"getInputType - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/getInputType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-input-type/#getinputtype","title":"getInputType","text":"[jvm]\\ open override fun getInputType(typeFactory: TypeFactory): JavaType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-output-type/","title":"getOutputType - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/getOutputType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-output-type/#getoutputtype","title":"getOutputType","text":"[jvm]\\ open override fun getOutputType(typeFactory: TypeFactory): JavaType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/","title":"BackwardsCompatibleEndpointConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#backwardscompatibleendpointconfig","title":"BackwardsCompatibleEndpointConfig","text":"[jvm]\\ data class BackwardsCompatibleEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int = 128, val maxRequestsPerHost: Int = 32, val maxIdleConnections: Int = 100, val keepAliveDuration: Duration = Duration.ofMinutes(5), val ssl: HttpClientSSLConfig? = null, val clientConfig: HttpClientConfig? = null)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#constructors","title":"Constructors","text":"BackwardsCompatibleEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int = 128, maxRequestsPerHost: Int = 32, maxIdleConnections: Int = 100, keepAliveDuration: Duration = Duration.ofMinutes(5), ssl: HttpClientSSLConfig? = null, clientConfig: HttpClientConfig? = null)"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null clientConfig [jvm]val clientConfig: HttpClientConfig? = null connectTimeout [jvm]val connectTimeout: Duration? = null envoy [jvm]val envoy: HttpClientEnvoyConfig? = null keepAliveDuration [jvm]val keepAliveDuration: Duration maxIdleConnections [jvm]val maxIdleConnections: Int = 100 maxRequests [jvm]val maxRequests: Int = 128 maxRequestsPerHost [jvm]val maxRequestsPerHost: Int = 32 pingInterval [jvm]val pingInterval: Duration? = null readTimeout [jvm]val readTimeout: Duration? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null url [jvm]val url: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/-backwards-compatible-endpoint-config/","title":"BackwardsCompatibleEndpointConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/BackwardsCompatibleEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/-backwards-compatible-endpoint-config/#backwardscompatibleendpointconfig","title":"BackwardsCompatibleEndpointConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int = 128, maxRequestsPerHost: Int = 32, maxIdleConnections: Int = 100, keepAliveDuration: Duration = Duration.ofMinutes(5), ssl: HttpClientSSLConfig? = null, clientConfig: HttpClientConfig? = null)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/call-timeout/","title":"callTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/callTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/call-timeout/#calltimeout","title":"callTimeout","text":"[jvm]\\ val callTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/client-config/","title":"clientConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/clientConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"[jvm]\\ val clientConfig: HttpClientConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/connect-timeout/","title":"connectTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/connectTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"[jvm]\\ val connectTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/envoy/","title":"envoy - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/envoy
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/envoy/#envoy","title":"envoy","text":"[jvm]\\ val envoy: HttpClientEnvoyConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/keepAliveDuration
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/maxIdleConnections
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ val maxIdleConnections: Int = 100
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/maxRequestsPerHost
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"[jvm]\\ val maxRequestsPerHost: Int = 32
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests/","title":"maxRequests - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/maxRequests
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests/#maxrequests","title":"maxRequests","text":"[jvm]\\ val maxRequests: Int = 128
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ping-interval/","title":"pingInterval - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/pingInterval
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ping-interval/#pinginterval","title":"pingInterval","text":"[jvm]\\ val pingInterval: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/read-timeout/","title":"readTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/readTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/read-timeout/#readtimeout","title":"readTimeout","text":"[jvm]\\ val readTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ssl/","title":"ssl - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/ssl
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/url/","title":"url - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/url
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/write-timeout/","title":"writeTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/writeTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/write-timeout/#writetimeout","title":"writeTimeout","text":"[jvm]\\ val writeTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/","title":"BeginClientCallChain - Misk","text":"//misk/misk.client/BeginClientCallChain
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#beginclientcallchain","title":"BeginClientCallChain","text":"[jvm]\\ interface BeginClientCallChain
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction args [jvm]abstract val args: List<*>"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<*>): Call<Any>"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/action/","title":"action - Misk","text":"//misk/misk.client/BeginClientCallChain/action
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: ClientAction
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/args/","title":"args - Misk","text":"//misk/misk.client/BeginClientCallChain/args
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/args/#args","title":"args","text":"[jvm]\\ abstract val args: List<*>
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/proceed/","title":"proceed - Misk","text":"//misk/misk.client/BeginClientCallChain/proceed
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(args: List<*>): Call<Any>
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/","title":"CallFactoryWrapper - Misk","text":"//misk/misk.client/CallFactoryWrapper
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/#callfactorywrapper","title":"CallFactoryWrapper","text":"[jvm]\\ interface CallFactoryWrapper
CallFactoryWrapper is a way to extend the functionality of the okhttp3.Call.Factory instance injected to typed http clients and gRPC clients created by TypedClientFactoryProvider and GrpcClientProvider.
The ability to extend the Call.Factory instance gives you similar functionalities to ClientApplicationInterceptorFactory and ClientNetworkInterceptor, where you can modify the request/response of the outgoing request. The main difference is that Call.Factory will be run in the thread the client is making the request as opposite to ClientApplicationInterceptorFactory and ClientNetworkInterceptor, which might be run on the okhttp3.Dispatcher threads when executing requests asynchronously. That can be problematic if ActionScoped or ThreadLocal information wants to be propagated using interceptors to downstream services. For example, tracing related information.
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<CallFactoryWrapper>().to<MyFactoryWrapper>()\ndelegate pass as argument."},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/wrap/","title":"wrap - Misk","text":"//misk/misk.client/CallFactoryWrapper/wrap
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/wrap/#wrap","title":"wrap","text":"[jvm]\\ abstract fun wrap(action: ClientAction, delegate: Call.Factory): Call.Factory?
Returns a Call.Factory that wraps the original call factory delegate pass as argument.
//misk/misk.client/ClientApplicationInterceptorFactory
"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/#clientapplicationinterceptorfactory","title":"ClientApplicationInterceptorFactory","text":"[jvm]\\ interface ClientApplicationInterceptorFactory
"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: ClientAction): Interceptor?"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/create/","title":"create - Misk","text":"//misk/misk.client/ClientApplicationInterceptorFactory/create
"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: ClientAction): Interceptor?
"},{"location":"0.x/misk/misk/misk.client/-client-chain/","title":"ClientChain - Misk","text":"//misk/misk.client/ClientChain
"},{"location":"0.x/misk/misk/misk.client/-client-chain/#clientchain","title":"ClientChain","text":"[jvm]\\ interface ClientChain
"},{"location":"0.x/misk/misk/misk.client/-client-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction args [jvm]abstract val args: List<*> call [jvm]abstract val call: Call<Any> callback [jvm]abstract val callback: Callback<Any>"},{"location":"0.x/misk/misk/misk.client/-client-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<*>, callback: Callback<Any>)"},{"location":"0.x/misk/misk/misk.client/-client-chain/action/","title":"action - Misk","text":"//misk/misk.client/ClientChain/action
"},{"location":"0.x/misk/misk/misk.client/-client-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: ClientAction
"},{"location":"0.x/misk/misk/misk.client/-client-chain/args/","title":"args - Misk","text":"//misk/misk.client/ClientChain/args
"},{"location":"0.x/misk/misk/misk.client/-client-chain/args/#args","title":"args","text":"[jvm]\\ abstract val args: List<*>
"},{"location":"0.x/misk/misk/misk.client/-client-chain/call/","title":"call - Misk","text":"//misk/misk.client/ClientChain/call
"},{"location":"0.x/misk/misk/misk.client/-client-chain/call/#call","title":"call","text":"[jvm]\\ abstract val call: Call<Any>
"},{"location":"0.x/misk/misk/misk.client/-client-chain/callback/","title":"callback - Misk","text":"//misk/misk.client/ClientChain/callback
"},{"location":"0.x/misk/misk/misk.client/-client-chain/callback/#callback","title":"callback","text":"[jvm]\\ abstract val callback: Callback<Any>
"},{"location":"0.x/misk/misk/misk.client/-client-chain/proceed/","title":"proceed - Misk","text":"//misk/misk.client/ClientChain/proceed
"},{"location":"0.x/misk/misk/misk.client/-client-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(args: List<*>, callback: Callback<Any>)
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/","title":"ClientMetricsInterceptor - Misk","text":"//misk/misk.client/ClientMetricsInterceptor
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#clientmetricsinterceptor","title":"ClientMetricsInterceptor","text":"[jvm]\\ class ClientMetricsInterceptor : Interceptor
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#properties","title":"Properties","text":"Name Summary clientName [jvm]val clientName: String"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): Response"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/client-name/","title":"clientName - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/clientName
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/client-name/#clientname","title":"clientName","text":"[jvm]\\ val clientName: String
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(clientName: String): ClientMetricsInterceptor"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ fun create(clientName: String): ClientMetricsInterceptor
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/","title":"ClientNetworkInterceptorsModule - Misk","text":"//misk/misk.client/ClientNetworkInterceptorsModule
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#clientnetworkinterceptorsmodule","title":"ClientNetworkInterceptorsModule","text":"[jvm]\\ class ClientNetworkInterceptorsModule : KAbstractModule
The common set of ClientNetworkInterceptors for all misk apps.
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#constructors","title":"Constructors","text":"ClientNetworkInterceptorsModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/-client-network-interceptors-module/","title":"ClientNetworkInterceptorsModule - Misk","text":"//misk/misk.client/ClientNetworkInterceptorsModule/ClientNetworkInterceptorsModule
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/-client-network-interceptors-module/#clientnetworkinterceptorsmodule","title":"ClientNetworkInterceptorsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/","title":"GrpcClientModule - Misk","text":"//misk/misk.client/GrpcClientModule
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#grpcclientmodule","title":"GrpcClientModule","text":"[jvm]\\ class GrpcClientModule<T : Service, G : T>@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0) : KAbstractModule
Creates a gRPC client given a Wire-generated interface and HTTP configuration.
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#constructors","title":"Constructors","text":"GrpcClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0)"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-grpc-client-module/","title":"GrpcClientModule - Misk","text":"//misk/misk.client/GrpcClientModule/GrpcClientModule
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-grpc-client-module/#grpcclientmodule","title":"GrpcClientModule","text":"[jvm]\\
@JvmOverloads
constructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0)
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/","title":"Companion - Misk","text":"//misk/misk.client/GrpcClientModule/Companion
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Service, G : T> create(name: String, annotation: Annotation? = null): GrpcClientModule<T, G>"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/create/","title":"create - Misk","text":"//misk/misk.client/GrpcClientModule/Companion/create
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Service, G : T> create(name: String, annotation: Annotation? = null): GrpcClientModule<T, G>
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/","title":"HttpClientConfig - Misk","text":"//misk/misk.client/HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\ data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#constructors","title":"Constructors","text":"HttpClientConfig [jvm]@JvmOverloadsconstructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null connectTimeout [jvm]val connectTimeout: Duration? = null keepAliveDuration [jvm]val keepAliveDuration: Duration? = null maxIdleConnections [jvm]val maxIdleConnections: Int? = null maxRequests [jvm]val maxRequests: Int? = null maxRequestsPerHost [jvm]val maxRequestsPerHost: Int? = null pingInterval [jvm]val pingInterval: Duration? = null protocols [jvm]val protocols: List<String>? = null readTimeout [jvm]val readTimeout: Duration? = null retryOnConnectionFailure [jvm]val retryOnConnectionFailure: Boolean? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null unixSocketFile [jvm]val unixSocketFile: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig toWispConfig [jvm]fun toWispConfig(): HttpClientConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-config/-http-client-config/","title":"HttpClientConfig - Misk","text":"//misk/misk.client/HttpClientConfig/HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\
@JvmOverloads
constructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/call-timeout/","title":"callTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/callTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/call-timeout/#calltimeout","title":"callTimeout","text":"[jvm]\\ val callTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/connect-timeout/","title":"connectTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/connectTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"[jvm]\\ val connectTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//misk/misk.client/HttpClientConfig/keepAliveDuration
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//misk/misk.client/HttpClientConfig/maxIdleConnections
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ val maxIdleConnections: Int? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"//misk/misk.client/HttpClientConfig/maxRequestsPerHost
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"[jvm]\\ val maxRequestsPerHost: Int? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests/","title":"maxRequests - Misk","text":"//misk/misk.client/HttpClientConfig/maxRequests
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests/#maxrequests","title":"maxRequests","text":"[jvm]\\ val maxRequests: Int? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ping-interval/","title":"pingInterval - Misk","text":"//misk/misk.client/HttpClientConfig/pingInterval
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ping-interval/#pinginterval","title":"pingInterval","text":"[jvm]\\ val pingInterval: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/protocols/","title":"protocols - Misk","text":"//misk/misk.client/HttpClientConfig/protocols
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/protocols/#protocols","title":"protocols","text":"[jvm]\\ val protocols: List<String>? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/read-timeout/","title":"readTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/readTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/read-timeout/#readtimeout","title":"readTimeout","text":"[jvm]\\ val readTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"//misk/misk.client/HttpClientConfig/retryOnConnectionFailure
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"[jvm]\\ val retryOnConnectionFailure: Boolean? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ssl/","title":"ssl - Misk","text":"//misk/misk.client/HttpClientConfig/ssl
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/unix-socket-file/","title":"unixSocketFile - Misk","text":"//misk/misk.client/HttpClientConfig/unixSocketFile
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/unix-socket-file/#unixsocketfile","title":"unixSocketFile","text":"[jvm]\\ val unixSocketFile: String? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/write-timeout/","title":"writeTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/writeTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/write-timeout/#writetimeout","title":"writeTimeout","text":"[jvm]\\ val writeTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/","title":"HttpClientConfigUrlProvider - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#httpclientconfigurlprovider","title":"HttpClientConfigUrlProvider","text":"[jvm]\\ class HttpClientConfigUrlProvider@Injectconstructor
Calculates the url for an http client config, which can differ depending on if the client is envoy-based or connects directly.
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#constructors","title":"Constructors","text":"HttpClientConfigUrlProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#properties","title":"Properties","text":"Name Summary envoyClientEndpointProvider [jvm]@Inject(optional = true)lateinit var envoyClientEndpointProvider: EnvoyClientEndpointProvider"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#functions","title":"Functions","text":"Name Summary getUrl [jvm]fun getUrl(endpointConfig: HttpClientEndpointConfig): String"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/-http-client-config-url-provider/","title":"HttpClientConfigUrlProvider - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider/HttpClientConfigUrlProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/-http-client-config-url-provider/#httpclientconfigurlprovider","title":"HttpClientConfigUrlProvider","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/envoy-client-endpoint-provider/","title":"envoyClientEndpointProvider - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider/envoyClientEndpointProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"envoyClientEndpointProvider","text":"[jvm]\\
@Inject(optional = true)
lateinit var envoyClientEndpointProvider: EnvoyClientEndpointProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/get-url/","title":"getUrl - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider/getUrl
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/get-url/#geturl","title":"getUrl","text":"[jvm]\\ fun getUrl(endpointConfig: HttpClientEndpointConfig): String
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\ data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#constructors","title":"Constructors","text":"HttpClientEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#properties","title":"Properties","text":"Name Summary clientConfig [jvm]val clientConfig: HttpClientConfig envoy [jvm]val envoy: HttpClientEnvoyConfig? = null url [jvm]val url: String? = null"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientEndpointConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/client-config/","title":"clientConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/clientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"[jvm]\\ val clientConfig: HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/envoy/","title":"envoy - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/envoy
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/envoy/#envoy","title":"envoy","text":"[jvm]\\ val envoy: HttpClientEnvoyConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/url/","title":"url - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/url
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\ data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#constructors","title":"Constructors","text":"HttpClientEnvoyConfig [jvm]@JvmOverloadsconstructor(app: String, env: String? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#properties","title":"Properties","text":"Name Summary app [jvm]val app: String env [jvm]val env: String? = nullEnvironment to target. If null, the same environment as the app is running in is assumed."},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientEnvoyConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/HttpClientEnvoyConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\
@JvmOverloads
constructor(app: String, env: String? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/app/","title":"app - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/app
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/app/#app","title":"app","text":"[jvm]\\ val app: String
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/env/","title":"env - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/env
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/env/#env","title":"env","text":"[jvm]\\ val env: String? = null
Environment to target. If null, the same environment as the app is running in is assumed.
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientEnvoyConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//misk/misk.client/HttpClientFactory
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\ @Singleton
class HttpClientFactory@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#constructors","title":"Constructors","text":"HttpClientFactory [jvm]@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#properties","title":"Properties","text":"Name Summary envoyClientEndpointProvider [jvm]@Inject(optional = true)var envoyClientEndpointProvider: EnvoyClientEndpointProvider? okhttpInterceptors [jvm]@Inject(optional = true)var okhttpInterceptors: Provider<List<Interceptor>>?"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(config: HttpClientEndpointConfig): OkHttpClientReturns a client initialized based onconfig."},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//misk/misk.client/HttpClientFactory/HttpClientFactory
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\
@Inject
constructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/","title":"create - Misk","text":"//misk/misk.client/HttpClientFactory/create
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/#create","title":"create","text":"[jvm]\\ fun create(config: HttpClientEndpointConfig): OkHttpClient
Returns a client initialized based on config.
//misk/misk.client/HttpClientFactory/envoyClientEndpointProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"envoyClientEndpointProvider","text":"[jvm]\\
@Inject(optional = true)
var envoyClientEndpointProvider: EnvoyClientEndpointProvider?
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/okhttp-interceptors/","title":"okhttpInterceptors - Misk","text":"//misk/misk.client/HttpClientFactory/okhttpInterceptors
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/okhttp-interceptors/#okhttpinterceptors","title":"okhttpInterceptors","text":"[jvm]\\
@Inject(optional = true)
var okhttpInterceptors: Provider<List<Interceptor>>?
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-companion/","title":"Companion - Misk","text":"//misk/misk.client/HttpClientFactory/Companion
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/","title":"HttpClientModule - Misk","text":"//misk/misk.client/HttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#httpclientmodule","title":"HttpClientModule","text":"[jvm]\\ class HttpClientModule@JvmOverloadsconstructor(name: String, annotation: Annotation? = null) : KAbstractModule
Provides an OkHttpClient and ProtoMessageHttpClient for a peer service
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#constructors","title":"Constructors","text":"HttpClientModule [jvm]@JvmOverloadsconstructor(name: String, annotation: Annotation? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-http-client-module/-http-client-module/","title":"HttpClientModule - Misk","text":"//misk/misk.client/HttpClientModule/HttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/-http-client-module/#httpclientmodule","title":"HttpClientModule","text":"[jvm]\\
@JvmOverloads
constructor(name: String, annotation: Annotation? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//misk/misk.client/HttpClientSSLConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig)
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#constructors","title":"Constructors","text":"HttpClientSSLConfig [jvm]constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig? trust_store [jvm]val trust_store: TrustStoreConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientSSLConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//misk/misk.client/HttpClientSSLConfig/HttpClientSSLConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/cert_store/","title":"cert_store - Misk","text":"//misk/misk.client/HttpClientSSLConfig/cert_store
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/cert_store/#cert_store","title":"cert_store","text":"[jvm]\\ val cert_store: CertStoreConfig?
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientSSLConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientSSLConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/trust_store/","title":"trust_store - Misk","text":"//misk/misk.client/HttpClientSSLConfig/trust_store
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/trust_store/#trust_store","title":"trust_store","text":"[jvm]\\ val trust_store: TrustStoreConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//misk/misk.client/HttpClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\ data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), val logRequests: Boolean = false) : Config
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#constructors","title":"Constructors","text":"HttpClientsConfig [jvm]@JvmOverloadsconstructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), logRequests: Boolean = false)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#properties","title":"Properties","text":"Name Summary endpoints [jvm]val endpoints: Map<String, HttpClientEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig> logRequests [jvm]val logRequests: Boolean = false"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#functions","title":"Functions","text":"Name Summary endpointNames [jvm]fun endpointNames(): Set<String>Names of configured endpoints, all of which can be fetched using get get [jvm]operator fun get(url: URL): HttpClientEndpointConfigoperator fun get(clientName: String): HttpClientEndpointConfig"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//misk/misk.client/HttpClientsConfig/HttpClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\
@JvmOverloads
constructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), logRequests: Boolean = false)
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoint-names/","title":"endpointNames - Misk","text":"//misk/misk.client/HttpClientsConfig/endpointNames
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoint-names/#endpointnames","title":"endpointNames","text":"[jvm]\\ fun endpointNames(): Set<String>
Names of configured endpoints, all of which can be fetched using get
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoints/","title":"endpoints - Misk","text":"//misk/misk.client/HttpClientsConfig/endpoints
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoints/#endpoints","title":"endpoints","text":"[jvm]\\ val endpoints: Map<String, HttpClientEndpointConfig>
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/","title":"get - Misk","text":"//misk/misk.client/HttpClientsConfig/get
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#get","title":"get","text":"[jvm]\\ operator fun get(clientName: String): HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#return","title":"Return","text":"The HttpClientEndpointConfig for the given client, populated with defaults as needed
[jvm]\\ operator fun get(url: URL): HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#return_1","title":"Return","text":"The HttpClientEndpointConfig for the given URL, populated with defaults as needed
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/host-configs/","title":"hostConfigs - Misk","text":"//misk/misk.client/HttpClientsConfig/hostConfigs
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/log-requests/","title":"logRequests - Misk","text":"//misk/misk.client/HttpClientsConfig/logRequests
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/log-requests/#logrequests","title":"logRequests","text":"[jvm]\\ val logRequests: Boolean = false
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/","title":"Companion - Misk","text":"//misk/misk.client/HttpClientsConfig/Companion
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/#properties","title":"Properties","text":"Name Summary httpClientConfigDefaults [jvm]val httpClientConfigDefaults: HttpClientConfig logger [jvm]val logger: KLogger"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/http-client-config-defaults/","title":"httpClientConfigDefaults - Misk","text":"//misk/misk.client/HttpClientsConfig/Companion/httpClientConfigDefaults
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/http-client-config-defaults/#httpclientconfigdefaults","title":"httpClientConfigDefaults","text":"[jvm]\\ val httpClientConfigDefaults: HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/logger/","title":"logger - Misk","text":"//misk/misk.client/HttpClientsConfig/Companion/logger
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/","title":"HttpClientsConfigModule - Misk","text":"//misk/misk.client/HttpClientsConfigModule
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#httpclientsconfigmodule","title":"HttpClientsConfigModule","text":"[jvm]\\ class HttpClientsConfigModule(config: HttpClientsConfig) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#constructors","title":"Constructors","text":"HttpClientsConfigModule [jvm]constructor(config: HttpClientsConfig)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/-http-clients-config-module/","title":"HttpClientsConfigModule - Misk","text":"//misk/misk.client/HttpClientsConfigModule/HttpClientsConfigModule
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/-http-clients-config-module/#httpclientsconfigmodule","title":"HttpClientsConfigModule","text":"[jvm]\\ constructor(config: HttpClientsConfig)
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/","title":"JettyPortPeerClientModule - Misk","text":"//misk/misk.client/JettyPortPeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#jettyportpeerclientmodule","title":"JettyPortPeerClientModule","text":"[jvm]\\ class JettyPortPeerClientModule : KAbstractModule
For testing.
Binds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the Jetty server\u2019s port.
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#constructors","title":"Constructors","text":"JettyPortPeerClientModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) peerClientFactory [jvm]@Provides@Singletonfun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, jetty: JettyService): PeerClientFactory"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/-jetty-port-peer-client-module/","title":"JettyPortPeerClientModule - Misk","text":"//misk/misk.client/JettyPortPeerClientModule/JettyPortPeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/-jetty-port-peer-client-module/#jettyportpeerclientmodule","title":"JettyPortPeerClientModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/peer-client-factory/","title":"peerClientFactory - Misk","text":"//misk/misk.client/JettyPortPeerClientModule/peerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/peer-client-factory/#peerclientfactory","title":"peerClientFactory","text":"[jvm]\\
@Provides
@Singleton
fun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, jetty: JettyService): PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\ class OkHttpClientCommonConfigurator@Injectconstructor
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#constructors","title":"Constructors","text":"OkHttpClientCommonConfigurator [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: OkHttpClientCommonConfigurator"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator/OkHttpClientCommonConfigurator
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/configure/","title":"configure - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator/configure
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/configure/#configure","title":"configure","text":"[jvm]\\ fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/delegate/","title":"delegate - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator/delegate
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: OkHttpClientCommonConfigurator
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/","title":"PeerClientFactory - Misk","text":"//misk/misk.client/PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#peerclientfactory","title":"PeerClientFactory","text":"[jvm]\\ class PeerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)
Factory that creates OkHttpClients for connecting to another instance of the same application running in the same cluster.
An OkHttpClient is cached for each peer.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#constructors","title":"Constructors","text":"PeerClientFactory [jvm]constructor(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#functions","title":"Functions","text":"Name Summary baseUrl [jvm]fun baseUrl(peer: Cluster.Member): StringGet the base URL for calling the given peer cluster member. client [jvm]fun client(peer: Cluster.Member): OkHttpClientGet a client to call the given peer cluster member. This client will fail when calling different services, as determined by the OU in the certificate returned by the called service."},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/-peer-client-factory/","title":"PeerClientFactory - Misk","text":"//misk/misk.client/PeerClientFactory/PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/-peer-client-factory/#peerclientfactory","title":"PeerClientFactory","text":"[jvm]\\ constructor(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/base-url/","title":"baseUrl - Misk","text":"//misk/misk.client/PeerClientFactory/baseUrl
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/base-url/#baseurl","title":"baseUrl","text":"[jvm]\\ fun baseUrl(peer: Cluster.Member): String
Get the base URL for calling the given peer cluster member.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/client/","title":"client - Misk","text":"//misk/misk.client/PeerClientFactory/client
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/client/#client","title":"client","text":"[jvm]\\ fun client(peer: Cluster.Member): OkHttpClient
Get a client to call the given peer cluster member. This client will fail when calling different services, as determined by the OU in the certificate returned by the called service.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/","title":"PeerClientModule - Misk","text":"//misk/misk.client/PeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#peerclientmodule","title":"PeerClientModule","text":"[jvm]\\ class PeerClientModule : KAbstractModule
Binds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the SSL port in the WebConfig.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#constructors","title":"Constructors","text":"PeerClientModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) peerClientFactory [jvm]@Provides@Singletonfun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, webConfig: WebConfig): PeerClientFactory"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/-peer-client-module/","title":"PeerClientModule - Misk","text":"//misk/misk.client/PeerClientModule/PeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/-peer-client-module/#peerclientmodule","title":"PeerClientModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/peer-client-factory/","title":"peerClientFactory - Misk","text":"//misk/misk.client/PeerClientModule/peerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/peer-client-factory/#peerclientfactory","title":"peerClientFactory","text":"[jvm]\\
@Provides
@Singleton
fun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, webConfig: WebConfig): PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/","title":"ProtoMessageHttpClient - Misk","text":"//misk/misk.client/ProtoMessageHttpClient
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#protomessagehttpclient","title":"ProtoMessageHttpClient","text":"[jvm]\\ class ProtoMessageHttpClient(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)
This helper class is for making HTTP requests to an endpoint that handles protobuf Message classes.
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#constructors","title":"Constructors","text":"ProtoMessageHttpClient [jvm]constructor(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#functions","title":"Functions","text":"Name Summary post [jvm]inline fun <O : Any> post(path: String, requestBody: Message<, *>): Ofun <O : Any> post(path: String, requestBody: Message<, *>, responseType: Class<O>): O"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/-proto-message-http-client/","title":"ProtoMessageHttpClient - Misk","text":"//misk/misk.client/ProtoMessageHttpClient/ProtoMessageHttpClient
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/-proto-message-http-client/#protomessagehttpclient","title":"ProtoMessageHttpClient","text":"[jvm]\\ constructor(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/post/","title":"post - Misk","text":"//misk/misk.client/ProtoMessageHttpClient/post
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/post/#post","title":"post","text":"[jvm]\\ fun <O : Any> post(path: String, requestBody: Message<*, *>, responseType: Class<O>): O
inline fun <O : Any> post(path: String, requestBody: Message<*, *>): O
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/","title":"TypedClientFactory - Misk","text":"//misk/misk.client/TypedClientFactory
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#typedclientfactory","title":"TypedClientFactory","text":"[jvm]\\ class TypedClientFactory@Injectconstructor
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#constructors","title":"Constructors","text":"TypedClientFactory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#functions","title":"Functions","text":"Name Summary build [jvm]@JvmOverloadsinline fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null): TReified flavor of build[jvm]fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>?): TBuild up a typed client dynamically in runtime. This is useful for platform-type services that cannot statically define all of the services they talk to."},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/-typed-client-factory/","title":"TypedClientFactory - Misk","text":"//misk/misk.client/TypedClientFactory/TypedClientFactory
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/-typed-client-factory/#typedclientfactory","title":"TypedClientFactory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/","title":"build - Misk","text":"//misk/misk.client/TypedClientFactory/build
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/#build","title":"build","text":"[jvm]\\ fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>?): T
Build up a typed client dynamically in runtime. This is useful for platform-type services that cannot statically define all of the services they talk to.
Services should cache the resulting clients to avoid incurring the construction on every call.
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/#parameters","title":"Parameters","text":"jvm
endpointConfig HTTP configuration to use to connect to the service kclass The class of the typed client that will be built name A name to reference the client by for observability purposes retrofitBuilderProvider Optional retrofit builder override. If not provided, an empty builder is used[jvm]\\
@JvmOverloads
inline fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null): T
Reified flavor of build
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/","title":"TypedHttpClientModule - Misk","text":"//misk/misk.client/TypedHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#typedhttpclientmodule","title":"TypedHttpClientModule","text":"class TypedHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModule
Creates a retrofit-backed typed client given an API interface and an HTTP configuration.
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#parameters","title":"Parameters","text":"jvm
retrofitBuilderProvider Optional provider of a Retrofit.Builder. This provider should not return a singleton since the builder it returns will be mutated."},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#constructors","title":"Constructors","text":"TypedHttpClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/","title":"TypedHttpClientModule - Misk","text":"//misk/misk.client/TypedHttpClientModule/TypedHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/#typedhttpclientmodule","title":"TypedHttpClientModule","text":"[jvm]\\
@JvmOverloads
constructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/#parameters","title":"Parameters","text":"jvm
retrofitBuilderProvider Optional provider of a Retrofit.Builder. This provider should not return a singleton since the builder it returns will be mutated."},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/","title":"Companion - Misk","text":"//misk/misk.client/TypedHttpClientModule/Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Any> create(name: String, annotation: Annotation? = null): TypedHttpClientModule<T>"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/create/","title":"create - Misk","text":"//misk/misk.client/TypedHttpClientModule/Companion/create
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Any> create(name: String, annotation: Annotation? = null): TypedHttpClientModule<T>
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/","title":"TypedPeerClientFactory - Misk","text":"//misk/misk.client/TypedPeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/#typedpeerclientfactory","title":"TypedPeerClientFactory","text":"[jvm]\\ interface TypedPeerClientFactory<T>
Factory for creating typed clients that call other members of a cluster.
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/#functions","title":"Functions","text":"Name Summary client [jvm]abstract fun client(peer: Cluster.Member): T"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/client/","title":"client - Misk","text":"//misk/misk.client/TypedPeerClientFactory/client
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/client/#client","title":"client","text":"[jvm]\\ abstract fun client(peer: Cluster.Member): T
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/","title":"TypedPeerHttpClientModule - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#typedpeerhttpclientmodule","title":"TypedPeerHttpClientModule","text":"[jvm]\\ class TypedPeerHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModule
Creates a retrofit-backed typed client factory given an API interface and an HTTP configuration.
The factory returned typed clients that can be used to call other members of the cluster.
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#constructors","title":"Constructors","text":"TypedPeerHttpClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-typed-peer-http-client-module/","title":"TypedPeerHttpClientModule - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule/TypedPeerHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-typed-peer-http-client-module/#typedpeerhttpclientmodule","title":"TypedPeerHttpClientModule","text":"[jvm]\\
@JvmOverloads
constructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/","title":"Companion - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule/Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Any> create(name: String): TypedPeerHttpClientModule<T>"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/create/","title":"create - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule/Companion/create
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Any> create(name: String): TypedPeerHttpClientModule<T>
"},{"location":"0.x/misk/misk/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk/misk.concurrent
"},{"location":"0.x/misk/misk/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.concurrent/#types","title":"Types","text":"Name Summary ExecutorServiceModule [jvm]class ExecutorServiceModule(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService) : KAbstractModuleInstall this to bind an executor service with annotation. The executor service will be automatically shut down when the service shuts down. ExplicitReleaseBlockingQueue [jvm]class ExplicitReleaseBlockingQueue<T> : BlockingQueue<T> An ExplicitReleaseBlockingQueue is a BlockingQueue that only returns elements from BlockingQueue.take, BlockingQueue.poll, and BlockingQueue.peek after a call to ExplicitReleaseBlockingQueue.release. Used by tests that want to explicitly control when pollers receive queued items. ExplicitReleaseDelayQueue [jvm]class ExplicitReleaseDelayQueue<T : Delayed> : BlockingQueue<T> An ExplicitReleaseDelayQueue is an ExplicitReleaseBlockingQueue that release elements in the order in which they expire WrappingListeningExecutorService [jvm]abstract class WrappingListeningExecutorService : ForwardingListeningExecutorServiceListeningExecutorService which wraps all calls"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/","title":"ExecutorServiceModule - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#executorservicemodule","title":"ExecutorServiceModule","text":"[jvm]\\ class ExecutorServiceModule(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService) : KAbstractModule
Install this to bind an executor service with annotation. The executor service will be automatically shut down when the service shuts down.
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#constructors","title":"Constructors","text":"ExecutorServiceModule [jvm]constructor(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService)"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-executor-service-module/","title":"ExecutorServiceModule - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-executor-service-module/#executorservicemodule","title":"ExecutorServiceModule","text":"[jvm]\\ constructor(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService)
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/","title":"Companion - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/Companion
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/#functions","title":"Functions","text":"Name Summary withFixedThreadPool [jvm]fun withFixedThreadPool(annotation: KClass<out Annotation>, nameFormat: String, nThreads: Int): ExecutorServiceModule withUnboundThreadPool [jvm]fun withUnboundThreadPool(annotation: KClass<out Annotation>, nameFormat: String): ExecutorServiceModule"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-fixed-thread-pool/","title":"withFixedThreadPool - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/Companion/withFixedThreadPool
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-fixed-thread-pool/#withfixedthreadpool","title":"withFixedThreadPool","text":"[jvm]\\ fun withFixedThreadPool(annotation: KClass<out Annotation>, nameFormat: String, nThreads: Int): ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-unbound-thread-pool/","title":"withUnboundThreadPool - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/Companion/withUnboundThreadPool
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-unbound-thread-pool/#withunboundthreadpool","title":"withUnboundThreadPool","text":"[jvm]\\ fun withUnboundThreadPool(annotation: KClass<out Annotation>, nameFormat: String): ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/","title":"ExplicitReleaseBlockingQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#explicitreleaseblockingqueue","title":"ExplicitReleaseBlockingQueue","text":"[jvm]\\ class ExplicitReleaseBlockingQueue<T> : BlockingQueue<T>
An ExplicitReleaseBlockingQueue is a BlockingQueue that only returns elements from BlockingQueue.take, BlockingQueue.poll, and BlockingQueue.peek after a call to ExplicitReleaseBlockingQueue.release. Used by tests that want to explicitly control when pollers receive queued items.
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#constructors","title":"Constructors","text":"ExplicitReleaseBlockingQueue [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#properties","title":"Properties","text":"Name Summary size [jvm]open override val size: Int"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(element: T): Boolean addAll [jvm]open override fun addAll(elements: Collection<T>): Boolean clear [jvm]open override fun clear() contains [jvm]open operator override fun contains(element: T): Boolean containsAll [jvm]open override fun containsAll(elements: Collection<T>): Boolean drainTo [jvm]open override fun drainTo(c: MutableCollection<in T>): Intopen override fun drainTo(c: MutableCollection<in T>?, maxElements: Int): Int element [jvm]open override fun element(): T forEach [jvm]open fun forEach(p0: Consumer<in T>) isEmpty [jvm]open override fun isEmpty(): Boolean iterator [jvm]open operator override fun iterator(): MutableIterator<T> offer [jvm]open override fun offer(e: T): Booleanopen override fun offer(e: T, timeout: Long, unit: TimeUnit): Boolean parallelStream [jvm]open fun parallelStream(): Stream<T> peek [jvm]open override fun peek(): T? peekPending [jvm]fun peekPending(): T? poll [jvm]open override fun poll(): T?open override fun poll(timeout: Long, unit: TimeUnit): T? put [jvm]open override fun put(e: T) release [jvm]fun release(n: Int): Intreleases up to n items from the pending queue, making them visible to take, poll, peek, etc. This method does not \"extend credit\"; if n number of pending items on the queue, every currently pending item is made visible, but any items added in the future continue to go onto the pending queue releaseAll [jvm]fun releaseAll(): Intreleases all items from the pending queue, returning the number of items released remainingCapacity [jvm]open override fun remainingCapacity(): Int remove [jvm]open override fun remove(): T?open override fun remove(element: T): Boolean removeAll [jvm]open override fun removeAll(elements: Collection<T>): Boolean removeIf [jvm]open fun removeIf(p0: Predicate<in T>): Boolean retainAll [jvm]open override fun retainAll(elements: Collection<T>): Boolean spliterator [jvm]open override fun spliterator(): Spliterator<T> stream [jvm]open fun stream(): Stream<T> take [jvm]open override fun take(): T"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/-explicit-release-blocking-queue/","title":"ExplicitReleaseBlockingQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/ExplicitReleaseBlockingQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/-explicit-release-blocking-queue/#explicitreleaseblockingqueue","title":"ExplicitReleaseBlockingQueue","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add-all/","title":"addAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/addAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add-all/#addall","title":"addAll","text":"[jvm]\\ open override fun addAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add/","title":"add - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/add
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add/#add","title":"add","text":"[jvm]\\ open override fun add(element: T): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/clear/","title":"clear - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/clear
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/clear/#clear","title":"clear","text":"[jvm]\\ open override fun clear()
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains-all/","title":"containsAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/containsAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains-all/#containsall","title":"containsAll","text":"[jvm]\\ open override fun containsAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains/","title":"contains - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/contains
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains/#contains","title":"contains","text":"[jvm]\\ open operator override fun contains(element: T): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/drain-to/","title":"drainTo - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/drainTo
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/drain-to/#drainto","title":"drainTo","text":"[jvm]\\ open override fun drainTo(c: MutableCollection<in T>): Int
open override fun drainTo(c: MutableCollection<in T>?, maxElements: Int): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/element/","title":"element - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/element
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/element/#element","title":"element","text":"[jvm]\\ open override fun element(): T
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/is-empty/","title":"isEmpty - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/isEmpty
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/is-empty/#isempty","title":"isEmpty","text":"[jvm]\\ open override fun isEmpty(): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/iterator/","title":"iterator - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/iterator
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/iterator/#iterator","title":"iterator","text":"[jvm]\\ open operator override fun iterator(): MutableIterator<T>
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/offer/","title":"offer - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/offer
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/offer/#offer","title":"offer","text":"[jvm]\\ open override fun offer(e: T): Boolean
open override fun offer(e: T, timeout: Long, unit: TimeUnit): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek-pending/","title":"peekPending - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/peekPending
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek-pending/#peekpending","title":"peekPending","text":"[jvm]\\ fun peekPending(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek/","title":"peek - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/peek
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek/#peek","title":"peek","text":"[jvm]\\ open override fun peek(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/poll/","title":"poll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/poll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/poll/#poll","title":"poll","text":"[jvm]\\ open override fun poll(timeout: Long, unit: TimeUnit): T?
open override fun poll(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/put/","title":"put - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/put
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/put/#put","title":"put","text":"[jvm]\\ open override fun put(e: T)
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release-all/","title":"releaseAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/releaseAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ fun releaseAll(): Int
releases all items from the pending queue, returning the number of items released
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/","title":"release - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/release
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/#release","title":"release","text":"[jvm]\\ fun release(n: Int): Int
releases up to n items from the pending queue, making them visible to take, poll, peek, etc. This method does not \"extend credit\"; if n number of pending items on the queue, every currently pending item is made visible, but any items added in the future continue to go onto the pending queue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/#return","title":"Return","text":"the number of items actually releases
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remaining-capacity/","title":"remainingCapacity - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/remainingCapacity
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remaining-capacity/#remainingcapacity","title":"remainingCapacity","text":"[jvm]\\ open override fun remainingCapacity(): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove-all/","title":"removeAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/removeAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove-all/#removeall","title":"removeAll","text":"[jvm]\\ open override fun removeAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove/","title":"remove - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/remove
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove/#remove","title":"remove","text":"[jvm]\\ open override fun remove(element: T): Boolean
open override fun remove(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/retain-all/","title":"retainAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/retainAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/retain-all/#retainall","title":"retainAll","text":"[jvm]\\ open override fun retainAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/size/","title":"size - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/size
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/size/#size","title":"size","text":"[jvm]\\ open override val size: Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/take/","title":"take - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/take
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/take/#take","title":"take","text":"[jvm]\\ open override fun take(): T
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/","title":"ExplicitReleaseDelayQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#explicitreleasedelayqueue","title":"ExplicitReleaseDelayQueue","text":"[jvm]\\ class ExplicitReleaseDelayQueue<T : Delayed> : BlockingQueue<T>
An ExplicitReleaseDelayQueue is an ExplicitReleaseBlockingQueue that release elements in the order in which they expire
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#constructors","title":"Constructors","text":"ExplicitReleaseDelayQueue [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#properties","title":"Properties","text":"Name Summary size [jvm]open override val size: Int"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(element: T): Boolean addAll [jvm]open override fun addAll(elements: Collection<T>): Boolean clear [jvm]open override fun clear() contains [jvm]open operator override fun contains(element: T): Boolean containsAll [jvm]open override fun containsAll(elements: Collection<T>): Boolean drainTo [jvm]open override fun drainTo(p0: MutableCollection<in T>): Intopen override fun drainTo(p0: MutableCollection<in T>, p1: Int): Int element [jvm]open override fun element(): T forEach [jvm]open fun forEach(p0: Consumer<in T>) isEmpty [jvm]open override fun isEmpty(): Boolean iterator [jvm]open operator override fun iterator(): MutableIterator<T> offer [jvm]open override fun offer(p0: T): Booleanopen override fun offer(p0: T, p1: Long, p2: TimeUnit): Boolean parallelStream [jvm]open fun parallelStream(): Stream<T> peek [jvm]open override fun peek(): T peekPending [jvm]fun peekPending(): T? poll [jvm]open override fun poll(): Topen override fun poll(p0: Long, p1: TimeUnit): T put [jvm]open override fun put(p0: T) release [jvm]fun release(n: Int): Int releaseAll [jvm]fun releaseAll(): Int remainingCapacity [jvm]open override fun remainingCapacity(): Int remove [jvm]open override fun remove(): Topen override fun remove(element: T): Boolean removeAll [jvm]open override fun removeAll(elements: Collection<T>): Boolean removeIf [jvm]open fun removeIf(p0: Predicate<in T>): Boolean retainAll [jvm]open override fun retainAll(elements: Collection<T>): Boolean spliterator [jvm]open override fun spliterator(): Spliterator<T> stream [jvm]open fun stream(): Stream<T> take [jvm]open override fun take(): T"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/-explicit-release-delay-queue/","title":"ExplicitReleaseDelayQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/ExplicitReleaseDelayQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/-explicit-release-delay-queue/#explicitreleasedelayqueue","title":"ExplicitReleaseDelayQueue","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/peek-pending/","title":"peekPending - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/peekPending
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/peek-pending/#peekpending","title":"peekPending","text":"[jvm]\\ fun peekPending(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release-all/","title":"releaseAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/releaseAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ fun releaseAll(): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release/","title":"release - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/release
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release/#release","title":"release","text":"[jvm]\\ fun release(n: Int): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"[jvm]\\ abstract class WrappingListeningExecutorService : ForwardingListeningExecutorService
ListeningExecutorService which wraps all calls
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/#constructors","title":"Constructors","text":"WrappingListeningExecutorService [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/WrappingListeningExecutorService
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/execute/","title":"execute - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/execute
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(runnable: Runnable)
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-all/","title":"invokeAll - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/invokeAll
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-all/#invokeall","title":"invokeAll","text":"[jvm]\\ open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>
open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>>
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-any/","title":"invokeAny - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/invokeAny
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-any/#invokeany","title":"invokeAny","text":"[jvm]\\ open override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Any
open override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/submit/","title":"submit - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/submit
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/submit/#submit","title":"submit","text":"[jvm]\\ open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>
open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T>
open override fun submit(runnable: Runnable): ListenableFuture<*>
"},{"location":"0.x/misk/misk/misk.environment/","title":"Package-level declarations - Misk","text":"//misk/misk.environment
"},{"location":"0.x/misk/misk/misk.environment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.environment/#types","title":"Types","text":"Name Summary DeploymentModule [jvm]class DeploymentModule@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable()) : KAbstractModuleBinds Deployment to make it available to services and actions EnvVarLoader [jvm]interface EnvVarLoader : EnvironmentVariableLoaderLoads an environment variable value. FakeEnvVarModule [jvm]class FakeEnvVarModule : KAbstractModuleBinds a EnvVarLoader for tests. Tests can contribute values through the@ForEnvVars Map<String, String> binding. ForEnvVars [jvm]@Qualifierannotation class ForEnvVars RealEnvVarModule [jvm]class RealEnvVarModule : KAbstractModuleBinds a EnvVarLoader for production"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/","title":"DeploymentModule - Misk","text":"//misk/misk.environment/DeploymentModule
"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#deploymentmodule","title":"DeploymentModule","text":"[jvm]\\ class DeploymentModule@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable()) : KAbstractModule
Binds Deployment to make it available to services and actions
"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#constructors","title":"Constructors","text":"DeploymentModule [jvm]@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable())"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/-deployment-module/","title":"DeploymentModule - Misk","text":"//misk/misk.environment/DeploymentModule/DeploymentModule
"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/-deployment-module/#deploymentmodule","title":"DeploymentModule","text":"[jvm]\\
@JvmOverloads
constructor(deployment: Deployment = getDeploymentFromEnvironmentVariable())
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/","title":"EnvVarLoader - Misk","text":"//misk/misk.environment/EnvVarLoader
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/#envvarloader","title":"EnvVarLoader","text":"[jvm]\\ interface EnvVarLoader : EnvironmentVariableLoader
Loads an environment variable value.
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): String getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String getEnvVar [jvm]open fun getEnvVar(name: String): StringGet the environment variable value"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/","title":"getEnvVar - Misk","text":"//misk/misk.environment/EnvVarLoader/getEnvVar
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/#getenvvar","title":"getEnvVar","text":"[jvm]\\ open fun getEnvVar(name: String): String
Get the environment variable value
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/#throws","title":"Throws","text":"IllegalStateException if the environment variable is not found"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/","title":"FakeEnvVarModule - Misk","text":"//misk/misk.environment/FakeEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/#fakeenvvarmodule","title":"FakeEnvVarModule","text":"[jvm]\\ class FakeEnvVarModule : KAbstractModule
Binds a EnvVarLoader for tests. Tests can contribute values through the @ForEnvVars Map<String, String> binding.
//misk/misk.environment/FakeEnvVarModule/FakeEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/-fake-env-var-module/#fakeenvvarmodule","title":"FakeEnvVarModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.environment/-for-env-vars/","title":"ForEnvVars - Misk","text":"//misk/misk.environment/ForEnvVars
"},{"location":"0.x/misk/misk/misk.environment/-for-env-vars/#forenvvars","title":"ForEnvVars","text":"[jvm]\\ @Qualifier
annotation class ForEnvVars
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/","title":"RealEnvVarModule - Misk","text":"//misk/misk.environment/RealEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#realenvvarmodule","title":"RealEnvVarModule","text":"[jvm]\\ class RealEnvVarModule : KAbstractModule
Binds a EnvVarLoader for production
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#constructors","title":"Constructors","text":"RealEnvVarModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/-real-env-var-module/","title":"RealEnvVarModule - Misk","text":"//misk/misk.environment/RealEnvVarModule/RealEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/-real-env-var-module/#realenvvarmodule","title":"RealEnvVarModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.grpc/","title":"Package-level declarations - Misk","text":"//misk/misk.grpc
"},{"location":"0.x/misk/misk/misk.grpc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.grpc/#functions","title":"Functions","text":"Name Summary consumeEachAndClose [jvm]fun <T : Any> MessageSource<T>.consumeEachAndClose(block: (T) -> Unit)"},{"location":"0.x/misk/misk/misk.grpc/consume-each-and-close/","title":"consumeEachAndClose - Misk","text":"//misk/misk.grpc/consumeEachAndClose
"},{"location":"0.x/misk/misk/misk.grpc/consume-each-and-close/#consumeeachandclose","title":"consumeEachAndClose","text":"[jvm]\\ fun <T : Any> MessageSource<T>.consumeEachAndClose(block: (T) -> Unit)
"},{"location":"0.x/misk/misk/misk.io/","title":"Package-level declarations - Misk","text":"//misk/misk.io
"},{"location":"0.x/misk/misk/misk.io/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.io/#functions","title":"Functions","text":"Name Summary listRecursively [jvm]fun Path.listRecursively(includeDirs: Boolean = false): List<Path>"},{"location":"0.x/misk/misk/misk.io/list-recursively/","title":"listRecursively - Misk","text":"//misk/misk.io/listRecursively
"},{"location":"0.x/misk/misk/misk.io/list-recursively/#listrecursively","title":"listRecursively","text":"[jvm]\\ fun Path.listRecursively(includeDirs: Boolean = false): List<Path>
"},{"location":"0.x/misk/misk/misk.io/list-recursively/#return","title":"Return","text":"all of the paths beneath this one, including nested paths
"},{"location":"0.x/misk/misk/misk.jvm/","title":"Package-level declarations - Misk","text":"//misk/misk.jvm
"},{"location":"0.x/misk/misk/misk.jvm/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.jvm/#types","title":"Types","text":"Name Summary JvmManagementFactoryModule [jvm]class JvmManagementFactoryModule : KInstallOnceModuleDefault providers for the ManagementFactory beans that the framework depends on."},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/","title":"JvmManagementFactoryModule - Misk","text":"//misk/misk.jvm/JvmManagementFactoryModule
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#jvmmanagementfactorymodule","title":"JvmManagementFactoryModule","text":"[jvm]\\ class JvmManagementFactoryModule : KInstallOnceModule
Default providers for the ManagementFactory beans that the framework depends on.
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#constructors","title":"Constructors","text":"JvmManagementFactoryModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int provideRuntimeMxBean [jvm]@Providesfun provideRuntimeMxBean(): RuntimeMXBean"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/-jvm-management-factory-module/","title":"JvmManagementFactoryModule - Misk","text":"//misk/misk.jvm/JvmManagementFactoryModule/JvmManagementFactoryModule
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/-jvm-management-factory-module/#jvmmanagementfactorymodule","title":"JvmManagementFactoryModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/provide-runtime-mx-bean/","title":"provideRuntimeMxBean - Misk","text":"//misk/misk.jvm/JvmManagementFactoryModule/provideRuntimeMxBean
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/provide-runtime-mx-bean/#provideruntimemxbean","title":"provideRuntimeMxBean","text":"[jvm]\\
@Provides
fun provideRuntimeMxBean(): RuntimeMXBean
"},{"location":"0.x/misk/misk/misk.logging/","title":"Package-level declarations - Misk","text":"//misk/misk.logging
"},{"location":"0.x/misk/misk/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.logging/#types","title":"Types","text":"Name Summary MdcModule [jvm]class MdcModule : KInstallOnceModule MiskMdc [jvm]object MiskMdc : Mdc"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/","title":"MdcModule - Misk","text":"//misk/misk.logging/MdcModule
"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#mdcmodule","title":"MdcModule","text":"[jvm]\\ class MdcModule : KInstallOnceModule
"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#constructors","title":"Constructors","text":"MdcModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/-mdc-module/","title":"MdcModule - Misk","text":"//misk/misk.logging/MdcModule/MdcModule
"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/-mdc-module/#mdcmodule","title":"MdcModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/","title":"MiskMdc - Misk","text":"//misk/misk.logging/MiskMdc
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/#miskmdc","title":"MiskMdc","text":"[jvm]\\ object MiskMdc : Mdc
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() get [jvm]open override fun get(key: String): String? put [jvm]open override fun put(key: String, value: String?)"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/clear/","title":"clear - Misk","text":"//misk/misk.logging/MiskMdc/clear
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/clear/#clear","title":"clear","text":"[jvm]\\ open override fun clear()
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/get/","title":"get - Misk","text":"//misk/misk.logging/MiskMdc/get
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/get/#get","title":"get","text":"[jvm]\\ open override fun get(key: String): String?
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/put/","title":"put - Misk","text":"//misk/misk.logging/MiskMdc/put
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/put/#put","title":"put","text":"[jvm]\\ open override fun put(key: String, value: String?)
"},{"location":"0.x/misk/misk/misk.monitoring/","title":"Package-level declarations - Misk","text":"//misk/misk.monitoring
"},{"location":"0.x/misk/misk/misk.monitoring/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.monitoring/#types","title":"Types","text":"Name Summary JvmMetrics [jvm]@Singletonclass JvmMetrics@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)Exposes additional JVM metrics. MonitoringModule [jvm]class MonitoringModule : KInstallOnceModule"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/","title":"JvmMetrics - Misk","text":"//misk/misk.monitoring/JvmMetrics
"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/#jvmmetrics","title":"JvmMetrics","text":"[jvm]\\ @Singleton
class JvmMetrics@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)
Exposes additional JVM metrics.
"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/#constructors","title":"Constructors","text":"JvmMetrics [jvm]@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/-jvm-metrics/","title":"JvmMetrics - Misk","text":"//misk/misk.monitoring/JvmMetrics/JvmMetrics
"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/-jvm-metrics/#jvmmetrics","title":"JvmMetrics","text":"[jvm]\\
@Inject
constructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/","title":"MonitoringModule - Misk","text":"//misk/misk.monitoring/MonitoringModule
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#monitoringmodule","title":"MonitoringModule","text":"[jvm]\\ class MonitoringModule : KInstallOnceModule
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#constructors","title":"Constructors","text":"MonitoringModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/-monitoring-module/","title":"MonitoringModule - Misk","text":"//misk/misk.monitoring/MonitoringModule/MonitoringModule
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/-monitoring-module/#monitoringmodule","title":"MonitoringModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.moshi/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi
"},{"location":"0.x/misk/misk/misk.moshi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi/#types","title":"Types","text":"Name Summary MoshiAdapterModule [jvm]class MoshiAdapterModule@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false) : KAbstractModule MoshiModule [jvm]class MoshiModule@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false) : KAbstractModuleFor service setup, prefer to install misk.MiskCommonServiceModule over installing MoshiModule directly."},{"location":"0.x/misk/misk/misk.moshi/#functions","title":"Functions","text":"Name Summary adapter [jvm]inline fun <T> Moshi.adapter(): JsonAdapter<T>"},{"location":"0.x/misk/misk/misk.moshi/adapter/","title":"adapter - Misk","text":"//misk/misk.moshi/adapter
"},{"location":"0.x/misk/misk/misk.moshi/adapter/#adapter","title":"adapter","text":"[jvm]\\ inline fun <T> Moshi.adapter(): JsonAdapter<T>
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/","title":"MoshiAdapterModule - Misk","text":"//misk/misk.moshi/MoshiAdapterModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#moshiadaptermodule","title":"MoshiAdapterModule","text":"[jvm]\\ class MoshiAdapterModule@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#constructors","title":"Constructors","text":"MoshiAdapterModule [jvm]@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-moshi-adapter-module/","title":"MoshiAdapterModule - Misk","text":"//misk/misk.moshi/MoshiAdapterModule/MoshiAdapterModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-moshi-adapter-module/#moshiadaptermodule","title":"MoshiAdapterModule","text":"[jvm]\\
@JvmOverloads
constructor(jsonAdapter: Any, addLast: Boolean = false)
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/","title":"Companion - Misk","text":"//misk/misk.moshi/MoshiAdapterModule/Companion
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/#functions","title":"Functions","text":"Name Summary invoke [jvm]inline operator fun <T> invoke(adapter: JsonAdapter<T>, addLast: Boolean = false): MoshiAdapterModule"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/invoke/","title":"invoke - Misk","text":"//misk/misk.moshi/MoshiAdapterModule/Companion/invoke
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/invoke/#invoke","title":"invoke","text":"[jvm]\\ inline operator fun <T> invoke(adapter: JsonAdapter<T>, addLast: Boolean = false): MoshiAdapterModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/","title":"MoshiModule - Misk","text":"//misk/misk.moshi/MoshiModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#moshimodule","title":"MoshiModule","text":"[jvm]\\ class MoshiModule@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false) : KAbstractModule
For service setup, prefer to install misk.MiskCommonServiceModule over installing MoshiModule directly.
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#constructors","title":"Constructors","text":"MoshiModule [jvm]@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singletonfun provideMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any>): Moshi"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-moshi-module/","title":"MoshiModule - Misk","text":"//misk/misk.moshi/MoshiModule/MoshiModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-moshi-module/#moshimodule","title":"MoshiModule","text":"[jvm]\\
@JvmOverloads
constructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false)
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/provide-moshi/","title":"provideMoshi - Misk","text":"//misk/misk.moshi/MoshiModule/provideMoshi
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"[jvm]\\
@Provides
@Singleton
fun provideMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any>): Moshi
"},{"location":"0.x/misk/misk/misk.moshi.adapters/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi.adapters
"},{"location":"0.x/misk/misk/misk.moshi.adapters/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.adapters/#types","title":"Types","text":"Name Summary BigDecimalAdapter [jvm]object BigDecimalAdapter"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/","title":"BigDecimalAdapter - Misk","text":"//misk/misk.moshi.adapters/BigDecimalAdapter
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/#bigdecimaladapter","title":"BigDecimalAdapter","text":"[jvm]\\ object BigDecimalAdapter
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/#functions","title":"Functions","text":"Name Summary decode [jvm]fun decode(decimal: String): BigDecimal encode [jvm]fun encode(decimal: BigDecimal): String"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/decode/","title":"decode - Misk","text":"//misk/misk.moshi.adapters/BigDecimalAdapter/decode
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/decode/#decode","title":"decode","text":"[jvm]\\ fun decode(decimal: String): BigDecimal
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/encode/","title":"encode - Misk","text":"//misk/misk.moshi.adapters/BigDecimalAdapter/encode
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/encode/#encode","title":"encode","text":"[jvm]\\ fun encode(decimal: BigDecimal): String
"},{"location":"0.x/misk/misk/misk.moshi.okio/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi.okio
"},{"location":"0.x/misk/misk/misk.moshi.okio/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.okio/#types","title":"Types","text":"Name Summary ByteStringAdapter [jvm]object ByteStringAdapterJSON adapter converting ByteStrings as base64 encoded strings"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/","title":"ByteStringAdapter - Misk","text":"//misk/misk.moshi.okio/ByteStringAdapter
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/#bytestringadapter","title":"ByteStringAdapter","text":"[jvm]\\ object ByteStringAdapter
JSON adapter converting ByteStrings as base64 encoded strings
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(value: String): ByteString toJson [jvm]fun toJson(value: ByteString): String"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.okio/ByteStringAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(value: String): ByteString
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.okio/ByteStringAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: ByteString): String
"},{"location":"0.x/misk/misk/misk.moshi.time/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi.time
"},{"location":"0.x/misk/misk/misk.moshi.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.time/#types","title":"Types","text":"Name Summary InstantAdapter [jvm]object InstantAdapter LocalDateAdapter [jvm]object LocalDateAdapter OffsetDateTimeAdapter [jvm]object OffsetDateTimeAdapter"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/","title":"InstantAdapter - Misk","text":"//misk/misk.moshi.time/InstantAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/#instantadapter","title":"InstantAdapter","text":"[jvm]\\ object InstantAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(date: Date?): Instant? toJson [jvm]fun toJson(value: Instant?): Date?"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.time/InstantAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(date: Date?): Instant?
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.time/InstantAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: Instant?): Date?
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/","title":"LocalDateAdapter - Misk","text":"//misk/misk.moshi.time/LocalDateAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/#localdateadapter","title":"LocalDateAdapter","text":"[jvm]\\ object LocalDateAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(date: Date?): LocalDate? toJson [jvm]fun toJson(value: LocalDate?): Date?"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.time/LocalDateAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(date: Date?): LocalDate?
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.time/LocalDateAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: LocalDate?): Date?
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/","title":"OffsetDateTimeAdapter - Misk","text":"//misk/misk.moshi.time/OffsetDateTimeAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/#offsetdatetimeadapter","title":"OffsetDateTimeAdapter","text":"[jvm]\\ object OffsetDateTimeAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(value: String?): OffsetDateTime? toJson [jvm]fun toJson(value: OffsetDateTime?): String?"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.time/OffsetDateTimeAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(value: String?): OffsetDateTime?
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.time/OffsetDateTimeAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: OffsetDateTime?): String?
"},{"location":"0.x/misk/misk/misk.okio/","title":"Package-level declarations - Misk","text":"//misk/misk.okio
"},{"location":"0.x/misk/misk/misk.okio/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.okio/#functions","title":"Functions","text":"Name Summary forEachBlock [jvm]fun BufferedSource.forEachBlock(buffer: ByteArray, f: (buffer: ByteArray, bytesRead: Int) -> Unit)fun BufferedSource.forEachBlock(blockSize: Int, f: (buffer: ByteArray, bytesRead: Int) -> Unit) split [jvm]fun BufferedSource.split(separator: ByteString): Sequence<Buffer>"},{"location":"0.x/misk/misk/misk.okio/for-each-block/","title":"forEachBlock - Misk","text":"//misk/misk.okio/forEachBlock
"},{"location":"0.x/misk/misk/misk.okio/for-each-block/#foreachblock","title":"forEachBlock","text":"[jvm]\\ fun BufferedSource.forEachBlock(buffer: ByteArray, f: (buffer: ByteArray, bytesRead: Int) -> Unit)
fun BufferedSource.forEachBlock(blockSize: Int, f: (buffer: ByteArray, bytesRead: Int) -> Unit)
"},{"location":"0.x/misk/misk/misk.okio/split/","title":"split - Misk","text":"//misk/misk.okio/split
"},{"location":"0.x/misk/misk/misk.okio/split/#split","title":"split","text":"[jvm]\\ fun BufferedSource.split(separator: ByteString): Sequence<Buffer>
"},{"location":"0.x/misk/misk/misk.perf/","title":"Package-level declarations - Misk","text":"//misk/misk.perf
"},{"location":"0.x/misk/misk/misk.perf/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.perf/#types","title":"Types","text":"Name Summary ForPauseDetector [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ForPauseDetectorUsed to bind a Sleeper and Ticker that are suitable for usage by the PauseDetector PauseDetectorConfig [jvm]data class PauseDetectorConfig@JvmOverloadsconstructor(val resolutionMillis: Long = 1, val logInfoMillis: Long = 1000, val logWarnMillis: Long = -1, val logErrorMillis: Long = -1, val metricsUpdateFloor: Long = 0)Configuration for the PauseDetector PauseDetectorModule [jvm]class PauseDetectorModule@JvmOverloadsconstructor(val pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig()) : KAbstractModuleInstall this module to run the PauseDetector in the background."},{"location":"0.x/misk/misk/misk.perf/-for-pause-detector/","title":"ForPauseDetector - Misk","text":"//misk/misk.perf/ForPauseDetector
"},{"location":"0.x/misk/misk/misk.perf/-for-pause-detector/#forpausedetector","title":"ForPauseDetector","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ForPauseDetector
Used to bind a Sleeper and Ticker that are suitable for usage by the PauseDetector
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/","title":"PauseDetectorConfig - Misk","text":"//misk/misk.perf/PauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#pausedetectorconfig","title":"PauseDetectorConfig","text":"[jvm]\\ data class PauseDetectorConfig@JvmOverloadsconstructor(val resolutionMillis: Long = 1, val logInfoMillis: Long = 1000, val logWarnMillis: Long = -1, val logErrorMillis: Long = -1, val metricsUpdateFloor: Long = 0)
Configuration for the PauseDetector
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#constructors","title":"Constructors","text":"PauseDetectorConfig [jvm]@JvmOverloadsconstructor(resolutionMillis: Long = 1, logInfoMillis: Long = 1000, logWarnMillis: Long = -1, logErrorMillis: Long = -1, metricsUpdateFloor: Long = 0)"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#properties","title":"Properties","text":"Name Summary logErrorMillis [jvm]val logErrorMillis: LongThe minimum number of millis paused before logging at error. -1 for never. logInfoMillis [jvm]val logInfoMillis: Long = 1000The minimum number of millis paused before logging at info. -1 for never. logWarnMillis [jvm]val logWarnMillis: LongThe minimum number of millis paused before logging at warn. -1 for never. metricsUpdateFloor [jvm]val metricsUpdateFloor: Long = 0The minimum number of millis required to trigger an update of the histogram resolutionMillis [jvm]val resolutionMillis: Long = 1The delay between detector runs. If 0, the detector runs in a spin loop."},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/-pause-detector-config/","title":"PauseDetectorConfig - Misk","text":"//misk/misk.perf/PauseDetectorConfig/PauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/-pause-detector-config/#pausedetectorconfig","title":"PauseDetectorConfig","text":"[jvm]\\
@JvmOverloads
constructor(resolutionMillis: Long = 1, logInfoMillis: Long = 1000, logWarnMillis: Long = -1, logErrorMillis: Long = -1, metricsUpdateFloor: Long = 0)
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-error-millis/","title":"logErrorMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/logErrorMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-error-millis/#logerrormillis","title":"logErrorMillis","text":"[jvm]\\ val logErrorMillis: Long
The minimum number of millis paused before logging at error. -1 for never.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-info-millis/","title":"logInfoMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/logInfoMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-info-millis/#loginfomillis","title":"logInfoMillis","text":"[jvm]\\ val logInfoMillis: Long = 1000
The minimum number of millis paused before logging at info. -1 for never.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-warn-millis/","title":"logWarnMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/logWarnMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-warn-millis/#logwarnmillis","title":"logWarnMillis","text":"[jvm]\\ val logWarnMillis: Long
The minimum number of millis paused before logging at warn. -1 for never.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/metrics-update-floor/","title":"metricsUpdateFloor - Misk","text":"//misk/misk.perf/PauseDetectorConfig/metricsUpdateFloor
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/metrics-update-floor/#metricsupdatefloor","title":"metricsUpdateFloor","text":"[jvm]\\ val metricsUpdateFloor: Long = 0
The minimum number of millis required to trigger an update of the histogram
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/resolution-millis/","title":"resolutionMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/resolutionMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/resolution-millis/#resolutionmillis","title":"resolutionMillis","text":"[jvm]\\ val resolutionMillis: Long = 1
The delay between detector runs. If 0, the detector runs in a spin loop.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/","title":"PauseDetectorModule - Misk","text":"//misk/misk.perf/PauseDetectorModule
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#pausedetectormodule","title":"PauseDetectorModule","text":"[jvm]\\ class PauseDetectorModule@JvmOverloadsconstructor(val pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig()) : KAbstractModule
Install this module to run the PauseDetector in the background.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#constructors","title":"Constructors","text":"PauseDetectorModule [jvm]@JvmOverloadsconstructor(pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig())"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#properties","title":"Properties","text":"Name Summary pauseDetectorConfig [jvm]val pauseDetectorConfig: PauseDetectorConfig"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/-pause-detector-module/","title":"PauseDetectorModule - Misk","text":"//misk/misk.perf/PauseDetectorModule/PauseDetectorModule
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/-pause-detector-module/#pausedetectormodule","title":"PauseDetectorModule","text":"[jvm]\\
@JvmOverloads
constructor(pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig())
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/pause-detector-config/","title":"pauseDetectorConfig - Misk","text":"//misk/misk.perf/PauseDetectorModule/pauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/pause-detector-config/#pausedetectorconfig","title":"pauseDetectorConfig","text":"[jvm]\\ val pauseDetectorConfig: PauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.security.authz/","title":"Package-level declarations - Misk","text":"//misk/misk.security.authz
"},{"location":"0.x/misk/misk/misk.security.authz/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.authz/#types","title":"Types","text":"Name Summary AccessAnnotationEntry [jvm]data class AccessAnnotationEntry@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val services: List<String> = listOf(), val capabilities: List<String> = listOf(), val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)Use this to alias an annotation to a set of services and capabilities. This can be used to decouple code that needs access control from the policy that defines it. AccessControlModule [jvm]class AccessControlModule : ActionScopedProviderModuleInstall support for performing access control checks for actions based on the incoming caller. AccessInterceptor [jvm]class AccessInterceptor : ApplicationInterceptor DevelopmentOnly [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class DevelopmentOnly ExcludeFromAllowAnyService [jvm]@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])annotation class ExcludeFromAllowAnyServiceExclude a service from @AllowAnyService. FakeCallerAuthenticator [jvm]@Singletonclass FakeCallerAuthenticator@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>) : MiskCallerAuthenticatorA caller authenticator that blindly trusts HTTP headers. Unsafe for production use. MiskCallerAuthenticator [jvm]interface MiskCallerAuthenticatorInterface for determining the current MiskCaller. Typically use an Request, ClientCertSubject, etc to determine the caller based on request headers or client certificate information."},{"location":"0.x/misk/misk/misk.security.authz/#functions","title":"Functions","text":"Name Summary AccessAnnotationEntry [jvm]inline fun <T : Annotation> AccessAnnotationEntry(services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false): AccessAnnotationEntry"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"[jvm]\\ inline fun <T : Annotation> AccessAnnotationEntry(services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false): AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"[jvm]\\ data class AccessAnnotationEntry@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val services: List<String> = listOf(), val capabilities: List<String> = listOf(), val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)
Use this to alias an annotation to a set of services and capabilities. This can be used to decouple code that needs access control from the policy that defines it.
To demonstrate, let\u2019s define an access annotation. By convention these annotations are suffixed Access:
@Retention(AnnotationRetention.RUNTIME)\n@Target(AnnotationTarget.FUNCTION)\nannotation class PaleontologistAccess\nNext we define actions that apply our annotation:
class DiscoverDinosaurAction @Inject constructor() : WebAction {\n @Get(\"/discover\")\n @PaleontologistAccess\n fun discover()\n}\n\nclass DigUpDinosaurAction @Inject constructor() : WebAction {\n @Get(\"/dig\")\n @PaleontologistAccess\n fun dig()\n}\nFinally we use multibindings to specify which services and capabilities are permitted:
multibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<PaleontologistAccess>(capabilities = listOf(\"paleontologist\", \"intern\")))\n//misk/misk.security.authz/AccessAnnotationEntry/AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"[jvm]\\
@JvmOverloads
constructor(annotation: KClass<out Annotation>, services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false)
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-service/","title":"allowAnyService - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/allowAnyService
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-service/#allowanyservice","title":"allowAnyService","text":"[jvm]\\ val allowAnyService: Boolean = false
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-user/","title":"allowAnyUser - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/allowAnyUser
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-user/#allowanyuser","title":"allowAnyUser","text":"[jvm]\\ val allowAnyUser: Boolean = false
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/annotation/","title":"annotation - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/annotation
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: KClass<out Annotation>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/capabilities/","title":"capabilities - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/capabilities
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: List<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/services/","title":"services - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/services
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/services/#services","title":"services","text":"[jvm]\\ val services: List<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/","title":"AccessControlModule - Misk","text":"//misk/misk.security.authz/AccessControlModule
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#accesscontrolmodule","title":"AccessControlModule","text":"[jvm]\\ class AccessControlModule : ActionScopedProviderModule
Install support for performing access control checks for actions based on the incoming caller.
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#constructors","title":"Constructors","text":"AccessControlModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#functions","title":"Functions","text":"Name Summary bindConstant [jvm]fun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation?)fun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation?) bindProvider [jvm]fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)fun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation?)fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)fun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation?) bindSeedData [jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>)fun <T : Any> bindSeedData(kclass: KClass<T>)fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>) configure [jvm]override fun configure(builder: Binder) configureProviders [jvm]open override fun configureProviders()"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/-access-control-module/","title":"AccessControlModule - Misk","text":"//misk/misk.security.authz/AccessControlModule/AccessControlModule
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/-access-control-module/#accesscontrolmodule","title":"AccessControlModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/configure-providers/","title":"configureProviders - Misk","text":"//misk/misk.security.authz/AccessControlModule/configureProviders
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/configure-providers/#configureproviders","title":"configureProviders","text":"[jvm]\\ open override fun configureProviders()
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/","title":"AccessInterceptor - Misk","text":"//misk/misk.security.authz/AccessInterceptor
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#accessinterceptor","title":"AccessInterceptor","text":"[jvm]\\ class AccessInterceptor : ApplicationInterceptor
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#properties","title":"Properties","text":"Name Summary allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String>"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"//misk/misk.security.authz/AccessInterceptor/allowedCapabilities
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"[jvm]\\ val allowedCapabilities: Set<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-services/","title":"allowedServices - Misk","text":"//misk/misk.security.authz/AccessInterceptor/allowedServices
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-services/#allowedservices","title":"allowedServices","text":"[jvm]\\ val allowedServices: Set<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.security.authz/AccessInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Chain): Any
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/","title":"Companion - Misk","text":"//misk/misk.security.authz/AccessInterceptor/Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/logger/","title":"logger - Misk","text":"//misk/misk.security.authz/AccessInterceptor/Companion/logger
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk/misk/misk.security.authz/-development-only/","title":"DevelopmentOnly - Misk","text":"//misk/misk.security.authz/DevelopmentOnly
"},{"location":"0.x/misk/misk/misk.security.authz/-development-only/#developmentonly","title":"DevelopmentOnly","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])
annotation class DevelopmentOnly
"},{"location":"0.x/misk/misk/misk.security.authz/-exclude-from-allow-any-service/","title":"ExcludeFromAllowAnyService - Misk","text":"//misk/misk.security.authz/ExcludeFromAllowAnyService
"},{"location":"0.x/misk/misk/misk.security.authz/-exclude-from-allow-any-service/#excludefromallowanyservice","title":"ExcludeFromAllowAnyService","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])
annotation class ExcludeFromAllowAnyService
Exclude a service from @AllowAnyService.
Add any external proxies that do service-to-service authentication to prevent AllowAnyService from also allowing external traffic to your service.
You can still explicitly include these services by including them in
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/","title":"FakeCallerAuthenticator - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#fakecallerauthenticator","title":"FakeCallerAuthenticator","text":"[jvm]\\ @Singleton
class FakeCallerAuthenticator@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>) : MiskCallerAuthenticator
A caller authenticator that blindly trusts HTTP headers. Unsafe for production use.
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#constructors","title":"Constructors","text":"FakeCallerAuthenticator [jvm]@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>)"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#properties","title":"Properties","text":"Name Summary developmentCaller [jvm]@Inject(optional = true)var developmentCaller: MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#functions","title":"Functions","text":"Name Summary getAuthenticatedCaller [jvm]open override fun getAuthenticatedCaller(): MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-fake-caller-authenticator/","title":"FakeCallerAuthenticator - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/FakeCallerAuthenticator
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-fake-caller-authenticator/#fakecallerauthenticator","title":"FakeCallerAuthenticator","text":"[jvm]\\
@Inject
constructor(currentHttpCall: ActionScoped<HttpCall>)
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/development-caller/","title":"developmentCaller - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/developmentCaller
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/development-caller/#developmentcaller","title":"developmentCaller","text":"[jvm]\\
@Inject(optional = true)
var developmentCaller: MiskCaller?
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/get-authenticated-caller/","title":"getAuthenticatedCaller - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/getAuthenticatedCaller
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/get-authenticated-caller/#getauthenticatedcaller","title":"getAuthenticatedCaller","text":"[jvm]\\ open override fun getAuthenticatedCaller(): MiskCaller?
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/","title":"Companion - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/#properties","title":"Properties","text":"Name Summary CAPABILITIES_HEADER [jvm]const val CAPABILITIES_HEADER: String SERVICE_HEADER [jvm]const val SERVICE_HEADER: String USER_HEADER [jvm]const val USER_HEADER: String"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-c-a-p-a-b-i-l-i-t-i-e-s_-h-e-a-d-e-r/","title":"CAPABILITIES_HEADER - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion/CAPABILITIES_HEADER
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-c-a-p-a-b-i-l-i-t-i-e-s_-h-e-a-d-e-r/#capabilities_header","title":"CAPABILITIES_HEADER","text":"[jvm]\\ const val CAPABILITIES_HEADER: String
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-s-e-r-v-i-c-e_-h-e-a-d-e-r/","title":"SERVICE_HEADER - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion/SERVICE_HEADER
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-s-e-r-v-i-c-e_-h-e-a-d-e-r/#service_header","title":"SERVICE_HEADER","text":"[jvm]\\ const val SERVICE_HEADER: String
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-u-s-e-r_-h-e-a-d-e-r/","title":"USER_HEADER - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion/USER_HEADER
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-u-s-e-r_-h-e-a-d-e-r/#user_header","title":"USER_HEADER","text":"[jvm]\\ const val USER_HEADER: String
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/","title":"MiskCallerAuthenticator - Misk","text":"//misk/misk.security.authz/MiskCallerAuthenticator
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#miskcallerauthenticator","title":"MiskCallerAuthenticator","text":"interface MiskCallerAuthenticator
Interface for determining the current MiskCaller. Typically use an Request, ClientCertSubject, etc to determine the caller based on request headers or client certificate information.
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<MiskCallerAuthenticator>().to<MyAuthenticator>()\nWe allow binding up many authenticators in case applications would like to support alternative ways in which to authenticate requests. For example, one mechanism might leverage HTTP headers while another mechanism might leverage third party authentication services.
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#inheritors","title":"Inheritors","text":"FakeCallerAuthenticator"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#functions","title":"Functions","text":"Name Summary getAuthenticatedCaller [jvm]abstract fun getAuthenticatedCaller(): MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/get-authenticated-caller/","title":"getAuthenticatedCaller - Misk","text":"//misk/misk.security.authz/MiskCallerAuthenticator/getAuthenticatedCaller
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/get-authenticated-caller/#getauthenticatedcaller","title":"getAuthenticatedCaller","text":"[jvm]\\ abstract fun getAuthenticatedCaller(): MiskCaller?
"},{"location":"0.x/misk/misk/misk.security.cert/","title":"Package-level declarations - Misk","text":"//misk/misk.security.cert
"},{"location":"0.x/misk/misk/misk.security.cert/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.cert/#types","title":"Types","text":"Name Summary X500Name [jvm]data class X500Name(val commonName: String?, val organizationalUnit: String?, val organization: String?, val locality: String?, val state: String?, val country: String?)"},{"location":"0.x/misk/misk/misk.security.cert/#properties","title":"Properties","text":"Name Summary isSelfSigned [jvm]val X509Certificate.isSelfSigned: Boolean"},{"location":"0.x/misk/misk/misk.security.cert/#functions","title":"Functions","text":"Name Summary isSignedBy [jvm]fun X509Certificate.isSignedBy(key: PublicKey): Booleanfun X509Certificate.isSignedBy(cert: Certificate): Boolean"},{"location":"0.x/misk/misk/misk.security.cert/is-self-signed/","title":"isSelfSigned - Misk","text":"//misk/misk.security.cert/isSelfSigned
"},{"location":"0.x/misk/misk/misk.security.cert/is-self-signed/#isselfsigned","title":"isSelfSigned","text":"[jvm]\\ val X509Certificate.isSelfSigned: Boolean
"},{"location":"0.x/misk/misk/misk.security.cert/is-signed-by/","title":"isSignedBy - Misk","text":"//misk/misk.security.cert/isSignedBy
"},{"location":"0.x/misk/misk/misk.security.cert/is-signed-by/#issignedby","title":"isSignedBy","text":"[jvm]\\ fun X509Certificate.isSignedBy(cert: Certificate): Boolean
fun X509Certificate.isSignedBy(key: PublicKey): Boolean
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/","title":"X500Name - Misk","text":"//misk/misk.security.cert/X500Name
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#x500name","title":"X500Name","text":"[jvm]\\ data class X500Name(val commonName: String?, val organizationalUnit: String?, val organization: String?, val locality: String?, val state: String?, val country: String?)
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#constructors","title":"Constructors","text":"X500Name [jvm]constructor(components: Map<String, String>)constructor(commonName: String?, organizationalUnit: String?, organization: String?, locality: String?, state: String?, country: String?)"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#properties","title":"Properties","text":"Name Summary commonName [jvm]val commonName: String? country [jvm]val country: String? locality [jvm]val locality: String? organization [jvm]val organization: String? organizationalUnit [jvm]val organizationalUnit: String? state [jvm]val state: String?"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-x500-name/","title":"X500Name - Misk","text":"//misk/misk.security.cert/X500Name/X500Name
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-x500-name/#x500name","title":"X500Name","text":"[jvm]\\ constructor(components: Map<String, String>)
constructor(commonName: String?, organizationalUnit: String?, organization: String?, locality: String?, state: String?, country: String?)
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/common-name/","title":"commonName - Misk","text":"//misk/misk.security.cert/X500Name/commonName
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/common-name/#commonname","title":"commonName","text":"[jvm]\\ val commonName: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/country/","title":"country - Misk","text":"//misk/misk.security.cert/X500Name/country
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/country/#country","title":"country","text":"[jvm]\\ val country: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/locality/","title":"locality - Misk","text":"//misk/misk.security.cert/X500Name/locality
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/locality/#locality","title":"locality","text":"[jvm]\\ val locality: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organization/","title":"organization - Misk","text":"//misk/misk.security.cert/X500Name/organization
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organization/#organization","title":"organization","text":"[jvm]\\ val organization: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organizational-unit/","title":"organizationalUnit - Misk","text":"//misk/misk.security.cert/X500Name/organizationalUnit
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organizational-unit/#organizationalunit","title":"organizationalUnit","text":"[jvm]\\ val organizationalUnit: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/state/","title":"state - Misk","text":"//misk/misk.security.cert/X500Name/state
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/state/#state","title":"state","text":"[jvm]\\ val state: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/","title":"Companion - Misk","text":"//misk/misk.security.cert/X500Name/Companion
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(dnString: String): X500Name"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/parse/","title":"parse - Misk","text":"//misk/misk.security.cert/X500Name/Companion/parse
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(dnString: String): X500Name
"},{"location":"0.x/misk/misk/misk.security.csp/","title":"Package-level declarations - Misk","text":"//misk/misk.security.csp
"},{"location":"0.x/misk/misk/misk.security.csp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.csp/#types","title":"Types","text":"Name Summary ContentSecurityPolicy [jvm]annotation class ContentSecurityPolicy(val rules: Array<String>)This annotation allows misk endpoints to define their Content-Security-Policy directive. See https://web.archive.org/web/20220906063156/https://content-security-policy.com/ for a reference that\u2019s up to date when this annotation was added. ContentSecurityPolicyInterceptor [jvm]class ContentSecurityPolicyInterceptor(val rules: List<String>) : NetworkInterceptor"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/","title":"ContentSecurityPolicy - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicy
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/#contentsecuritypolicy","title":"ContentSecurityPolicy","text":"annotation class ContentSecurityPolicy(val rules: Array<String>)
This annotation allows misk endpoints to define their Content-Security-Policy directive. See https://web.archive.org/web/20220906063156/https://content-security-policy.com/ for a reference that\u2019s up to date when this annotation was added.
Production CSPs can be very long so a future contribution should add the ability to define CSP into YAML configs and point the @Csp annotation to the config value. This annotation is currently dumb, it adds the rules passed to a Content-Security-Policy header directive, with no inspection or validation. A future change could parse the policy. Developers using this should check out the various browser extensions to verify the actual CSP on their webpages. #### Parameters jvm | | | |---|---| | rules | A list of valid Content-Security-Policy rules. | ## Properties | Name | Summary | |---|---| | [rules](rules.md) | [jvm]val [rules](rules.md): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> |"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/","title":"rules - Misk","text":"
//misk/misk.security.csp/ContentSecurityPolicy/rules
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/#rules","title":"rules","text":"[jvm]\\ val rules: Array<String>
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/#parameters","title":"Parameters","text":"jvm
rules A list of valid Content-Security-Policy rules."},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/","title":"ContentSecurityPolicyInterceptor - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#contentsecuritypolicyinterceptor","title":"ContentSecurityPolicyInterceptor","text":"[jvm]\\ class ContentSecurityPolicyInterceptor(val rules: List<String>) : NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#constructors","title":"Constructors","text":"ContentSecurityPolicyInterceptor [jvm]constructor(rules: List<String>)"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#properties","title":"Properties","text":"Name Summary rules [jvm]val rules: List<String>"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-content-security-policy-interceptor/","title":"ContentSecurityPolicyInterceptor - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/ContentSecurityPolicyInterceptor
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-content-security-policy-interceptor/#contentsecuritypolicyinterceptor","title":"ContentSecurityPolicyInterceptor","text":"[jvm]\\ constructor(rules: List<String>)
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/rules/","title":"rules - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/rules
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/rules/#rules","title":"rules","text":"[jvm]\\ val rules: List<String>
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory@Injectconstructor : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory/Factory
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.security.keys/","title":"Package-level declarations - Misk","text":"//misk/misk.security.keys
"},{"location":"0.x/misk/misk/misk.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.keys/#types","title":"Types","text":"Name Summary KeyService [jvm]interface KeyServiceHandles encryption and decryption using keys stored in a key management service"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/","title":"KeyService - Misk","text":"//misk/misk.security.keys/KeyService
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/#keyservice","title":"KeyService","text":"[jvm]\\ interface KeyService
Handles encryption and decryption using keys stored in a key management service
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/#functions","title":"Functions","text":"Name Summary decrypt [jvm]abstract fun decrypt(keyAlias: String, cipherText: ByteString): ByteStringdecrypts the provided cipher text using the given stored key encrypt [jvm]abstract fun encrypt(keyAlias: String, plainText: ByteString): ByteStringencrypts the provided plain text using the given stored key"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/decrypt/","title":"decrypt - Misk","text":"//misk/misk.security.keys/KeyService/decrypt
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/decrypt/#decrypt","title":"decrypt","text":"[jvm]\\ abstract fun decrypt(keyAlias: String, cipherText: ByteString): ByteString
decrypts the provided cipher text using the given stored key
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/encrypt/","title":"encrypt - Misk","text":"//misk/misk.security.keys/KeyService/encrypt
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/encrypt/#encrypt","title":"encrypt","text":"[jvm]\\ abstract fun encrypt(keyAlias: String, plainText: ByteString): ByteString
encrypts the provided plain text using the given stored key
"},{"location":"0.x/misk/misk/misk.security.ssl/","title":"Package-level declarations - Misk","text":"//misk/misk.security.ssl
"},{"location":"0.x/misk/misk/misk.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.ssl/#types","title":"Types","text":"Name Summary CipherSuites [jvm]object CipherSuites ClientCertChain [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertChainQualifier annotation for an ActionScoped array of X509Certificates containing the certificate chain provided by the client (if any) ClientCertIssuer [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertIssuerQualifier annotation for an ActionScoped containing the issuer of the client cert ClientCertSubject [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertSubjectQualifier annotation for an ActionScoped containing the subject of the client cert TlsProtocols [jvm]object TlsProtocols"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/","title":"CipherSuites - Misk","text":"//misk/misk.security.ssl/CipherSuites
"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/#ciphersuites","title":"CipherSuites","text":"[jvm]\\ object CipherSuites
"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/#properties","title":"Properties","text":"Name Summary compatible [jvm]val compatible: Array<String>"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/compatible/","title":"compatible - Misk","text":"//misk/misk.security.ssl/CipherSuites/compatible
"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/compatible/#compatible","title":"compatible","text":"[jvm]\\ val compatible: Array<String>
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-chain/","title":"ClientCertChain - Misk","text":"//misk/misk.security.ssl/ClientCertChain
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-chain/#clientcertchain","title":"ClientCertChain","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ClientCertChain
Qualifier annotation for an ActionScoped array of X509Certificates containing the certificate chain provided by the client (if any)
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-issuer/","title":"ClientCertIssuer - Misk","text":"//misk/misk.security.ssl/ClientCertIssuer
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-issuer/#clientcertissuer","title":"ClientCertIssuer","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ClientCertIssuer
Qualifier annotation for an ActionScoped containing the issuer of the client cert
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-subject/","title":"ClientCertSubject - Misk","text":"//misk/misk.security.ssl/ClientCertSubject
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-subject/#clientcertsubject","title":"ClientCertSubject","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ClientCertSubject
Qualifier annotation for an ActionScoped containing the subject of the client cert
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/","title":"TlsProtocols - Misk","text":"//misk/misk.security.ssl/TlsProtocols
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/#tlsprotocols","title":"TlsProtocols","text":"[jvm]\\ object TlsProtocols
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/#properties","title":"Properties","text":"Name Summary compatible [jvm]val compatible: Array<String>List of safe to use TLS protocols, in preferred order restricted [jvm]val restricted: Array<String>List of modern TLS protocols for extra security, in preferred order"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/compatible/","title":"compatible - Misk","text":"//misk/misk.security.ssl/TlsProtocols/compatible
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/compatible/#compatible","title":"compatible","text":"[jvm]\\ val compatible: Array<String>
List of safe to use TLS protocols, in preferred order
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/restricted/","title":"restricted - Misk","text":"//misk/misk.security.ssl/TlsProtocols/restricted
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/restricted/#restricted","title":"restricted","text":"[jvm]\\ val restricted: Array<String>
List of modern TLS protocols for extra security, in preferred order
"},{"location":"0.x/misk/misk/misk.tasks/","title":"Package-level declarations - Misk","text":"//misk/misk.tasks
"},{"location":"0.x/misk/misk/misk.tasks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.tasks/#types","title":"Types","text":"Name Summary DelayedTask [jvm]class DelayedTask(clock: Clock, executionTime: Instant, val task: () -> Result) : DelayedA DelayedTask is a task that runs in the future RepeatedTaskQueue [jvm]class RepeatedTaskQueue : AbstractExecutionThreadServiceA RepeatedTaskQueue runs repeated tasks at a user controlled rate. Internally it uses a DelayQueue to hold the pending tasks; a background thread pulls the next task from the DelayQueue and hands it off to an executor service for execution. RepeatedTaskQueueConfig [jvm]data class RepeatedTaskQueueConfig@JvmOverloadsconstructor(val default_jitter_ms: Long = 50, val default_max_delay_sec: Long = 60, val num_parallel_tasks: Int = 1) RepeatedTaskQueueFactory [jvm]@Singletonclass RepeatedTaskQueueFactory@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory) RepeatedTaskQueueMetrics [jvm]@Singletonclass RepeatedTaskQueueMetrics@Injectconstructor(metrics: Metrics) Result [jvm]data class Result(val status: Status, val nextDelay: Duration) Status [jvm]enum Status : Enum<Status>"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/","title":"DelayedTask - Misk","text":"//misk/misk.tasks/DelayedTask
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#delayedtask","title":"DelayedTask","text":"[jvm]\\ class DelayedTask(clock: Clock, executionTime: Instant, val task: () -> Result) : Delayed
A DelayedTask is a task that runs in the future
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#constructors","title":"Constructors","text":"DelayedTask [jvm]constructor(clock: Clock, executionTime: Instant, task: () -> Result)"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#properties","title":"Properties","text":"Name Summary task [jvm]val task: () -> Result"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Delayed): Int getDelay [jvm]open override fun getDelay(unit: TimeUnit): Long"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/-delayed-task/","title":"DelayedTask - Misk","text":"//misk/misk.tasks/DelayedTask/DelayedTask
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/-delayed-task/#delayedtask","title":"DelayedTask","text":"[jvm]\\ constructor(clock: Clock, executionTime: Instant, task: () -> Result)
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/compare-to/","title":"compareTo - Misk","text":"//misk/misk.tasks/DelayedTask/compareTo
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Delayed): Int
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/get-delay/","title":"getDelay - Misk","text":"//misk/misk.tasks/DelayedTask/getDelay
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/get-delay/#getdelay","title":"getDelay","text":"[jvm]\\ open override fun getDelay(unit: TimeUnit): Long
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/task/","title":"task - Misk","text":"//misk/misk.tasks/DelayedTask/task
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/task/#task","title":"task","text":"[jvm]\\ val task: () -> Result
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/","title":"RepeatedTaskQueue - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#repeatedtaskqueue","title":"RepeatedTaskQueue","text":"[jvm]\\ class RepeatedTaskQueue : AbstractExecutionThreadService
A RepeatedTaskQueue runs repeated tasks at a user controlled rate. Internally it uses a DelayQueue to hold the pending tasks; a background thread pulls the next task from the DelayQueue and hands it off to an executor service for execution.
RepeatedTaskQueue implements the Service interface, which requires proper startup and shutdown. Alternatively, you can add new instances to the Service multibind.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean schedule [jvm]@JvmOverloadsfun schedule(delay: Duration, retryDelayOnFailure: Duration? = null, task: () -> Result)Schedules a task to run repeatedly after an initial delay. The task itself determines the next execution time. Provide an optional retryDelayOnFailure parameter to determine when the job should be retried in the case of an unhandled exception by the client scheduleWithBackoff [jvm]@JvmOverloadsfun scheduleWithBackoff(timeBetweenRuns: Duration, initialDelay: Duration = timeBetweenRuns, noWorkBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), failureBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), task: () -> Status)Schedules a task to run repeatedly at a fixed delay, with back-off for errors and lack of available work startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/name/","title":"name - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/name
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule-with-backoff/","title":"scheduleWithBackoff - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/scheduleWithBackoff
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule-with-backoff/#schedulewithbackoff","title":"scheduleWithBackoff","text":"[jvm]\\
@JvmOverloads
fun scheduleWithBackoff(timeBetweenRuns: Duration, initialDelay: Duration = timeBetweenRuns, noWorkBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), failureBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), task: () -> Status)
Schedules a task to run repeatedly at a fixed delay, with back-off for errors and lack of available work
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule/","title":"schedule - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/schedule
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule/#schedule","title":"schedule","text":"[jvm]\\
@JvmOverloads
fun schedule(delay: Duration, retryDelayOnFailure: Duration? = null, task: () -> Result)
Schedules a task to run repeatedly after an initial delay. The task itself determines the next execution time. Provide an optional retryDelayOnFailure parameter to determine when the job should be retried in the case of an unhandled exception by the client
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/-companion/","title":"Companion - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/Companion
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/","title":"RepeatedTaskQueueConfig - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#repeatedtaskqueueconfig","title":"RepeatedTaskQueueConfig","text":"[jvm]\\ data class RepeatedTaskQueueConfig@JvmOverloadsconstructor(val default_jitter_ms: Long = 50, val default_max_delay_sec: Long = 60, val num_parallel_tasks: Int = 1)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#constructors","title":"Constructors","text":"RepeatedTaskQueueConfig [jvm]@JvmOverloadsconstructor(default_jitter_ms: Long = 50, default_max_delay_sec: Long = 60, num_parallel_tasks: Int = 1)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#properties","title":"Properties","text":"Name Summary default_jitter_ms [jvm]val default_jitter_ms: Long = 50The default amount of jitter to use when scheduling backoffs. default_max_delay_sec [jvm]val default_max_delay_sec: Long = 60The default maximum backoff time. num_parallel_tasks [jvm]val num_parallel_tasks: Int = 1The fixed number of parallel tasks to run."},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#functions","title":"Functions","text":"Name Summary defaultBackoff [jvm]fun defaultBackoff(initialDelay: Duration): BackoffConstruct an ExponentialBackoff from the initial delay using the default configs."},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/-repeated-task-queue-config/","title":"RepeatedTaskQueueConfig - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/RepeatedTaskQueueConfig
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/-repeated-task-queue-config/#repeatedtaskqueueconfig","title":"RepeatedTaskQueueConfig","text":"[jvm]\\
@JvmOverloads
constructor(default_jitter_ms: Long = 50, default_max_delay_sec: Long = 60, num_parallel_tasks: Int = 1)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default-backoff/","title":"defaultBackoff - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/defaultBackoff
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default-backoff/#defaultbackoff","title":"defaultBackoff","text":"[jvm]\\ fun defaultBackoff(initialDelay: Duration): Backoff
Construct an ExponentialBackoff from the initial delay using the default configs.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_jitter_ms/","title":"default_jitter_ms - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/default_jitter_ms
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_jitter_ms/#default_jitter_ms","title":"default_jitter_ms","text":"[jvm]\\ val default_jitter_ms: Long = 50
The default amount of jitter to use when scheduling backoffs.
Can be overridden when scheduling a tasks.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_max_delay_sec/","title":"default_max_delay_sec - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/default_max_delay_sec
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_max_delay_sec/#default_max_delay_sec","title":"default_max_delay_sec","text":"[jvm]\\ val default_max_delay_sec: Long = 60
The default maximum backoff time.
Can be overridden when scheduling a task.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/num_parallel_tasks/","title":"num_parallel_tasks - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/num_parallel_tasks
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/num_parallel_tasks/#num_parallel_tasks","title":"num_parallel_tasks","text":"[jvm]\\ val num_parallel_tasks: Int = 1
The fixed number of parallel tasks to run.
If -1 then an unbounded number of parallel tasks are allowed. An unbounded number of tasks can be useful for an App that needs to dynamically compute the number of tasks at runtime. However, the App is then responsible for ensuring an upper bound for the number of tasks submitted.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/","title":"RepeatedTaskQueueFactory - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#repeatedtaskqueuefactory","title":"RepeatedTaskQueueFactory","text":"[jvm]\\ @Singleton
class RepeatedTaskQueueFactory@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#constructors","title":"Constructors","text":"RepeatedTaskQueueFactory [jvm]@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#functions","title":"Functions","text":"Name Summary forTesting [jvm]@JvmOverloadsfun forTesting(name: String, backingStorage: ExplicitReleaseDelayQueue<DelayedTask>, pollingTimeout: Duration = Duration.ofMillis(50)): RepeatedTaskQueueBuilds a new instance of a RepeatedTaskQueue for testing new [jvm]@JvmOverloadsfun new(name: String, config: RepeatedTaskQueueConfig = RepeatedTaskQueueConfig(), pollingTimeout: Duration = Duration.ofMillis(250)): RepeatedTaskQueueBuilds a new instance of a RepeatedTaskQueue"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/-repeated-task-queue-factory/","title":"RepeatedTaskQueueFactory - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory/RepeatedTaskQueueFactory
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/-repeated-task-queue-factory/#repeatedtaskqueuefactory","title":"RepeatedTaskQueueFactory","text":"[jvm]\\
@Inject
constructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/for-testing/","title":"forTesting - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory/forTesting
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/for-testing/#fortesting","title":"forTesting","text":"[jvm]\\
@JvmOverloads
fun forTesting(name: String, backingStorage: ExplicitReleaseDelayQueue<DelayedTask>, pollingTimeout: Duration = Duration.ofMillis(50)): RepeatedTaskQueue
Builds a new instance of a RepeatedTaskQueue for testing
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/new/","title":"new - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory/new
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/new/#new","title":"new","text":"[jvm]\\
@JvmOverloads
fun new(name: String, config: RepeatedTaskQueueConfig = RepeatedTaskQueueConfig(), pollingTimeout: Duration = Duration.ofMillis(250)): RepeatedTaskQueue
Builds a new instance of a RepeatedTaskQueue
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/","title":"RepeatedTaskQueueMetrics - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueMetrics
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/#repeatedtaskqueuemetrics","title":"RepeatedTaskQueueMetrics","text":"[jvm]\\ @Singleton
class RepeatedTaskQueueMetrics@Injectconstructor(metrics: Metrics)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/#constructors","title":"Constructors","text":"RepeatedTaskQueueMetrics [jvm]@Injectconstructor(metrics: Metrics)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/-repeated-task-queue-metrics/","title":"RepeatedTaskQueueMetrics - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueMetrics/RepeatedTaskQueueMetrics
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/-repeated-task-queue-metrics/#repeatedtaskqueuemetrics","title":"RepeatedTaskQueueMetrics","text":"[jvm]\\
@Inject
constructor(metrics: Metrics)
"},{"location":"0.x/misk/misk/misk.tasks/-result/","title":"Result - Misk","text":"//misk/misk.tasks/Result
"},{"location":"0.x/misk/misk/misk.tasks/-result/#result","title":"Result","text":"[jvm]\\ data class Result(val status: Status, val nextDelay: Duration)
"},{"location":"0.x/misk/misk/misk.tasks/-result/#constructors","title":"Constructors","text":"Result [jvm]constructor(status: Status, nextDelay: Duration)"},{"location":"0.x/misk/misk/misk.tasks/-result/#properties","title":"Properties","text":"Name Summary nextDelay [jvm]val nextDelay: Duration status [jvm]val status: Status"},{"location":"0.x/misk/misk/misk.tasks/-result/-result/","title":"Result - Misk","text":"//misk/misk.tasks/Result/Result
"},{"location":"0.x/misk/misk/misk.tasks/-result/-result/#result","title":"Result","text":"[jvm]\\ constructor(status: Status, nextDelay: Duration)
"},{"location":"0.x/misk/misk/misk.tasks/-result/next-delay/","title":"nextDelay - Misk","text":"//misk/misk.tasks/Result/nextDelay
"},{"location":"0.x/misk/misk/misk.tasks/-result/next-delay/#nextdelay","title":"nextDelay","text":"[jvm]\\ val nextDelay: Duration
"},{"location":"0.x/misk/misk/misk.tasks/-result/status/","title":"status - Misk","text":"//misk/misk.tasks/Result/status
"},{"location":"0.x/misk/misk/misk.tasks/-result/status/#status","title":"status","text":"[jvm]\\ val status: Status
"},{"location":"0.x/misk/misk/misk.tasks/-status/","title":"Status - Misk","text":"//misk/misk.tasks/Status
"},{"location":"0.x/misk/misk/misk.tasks/-status/#status","title":"Status","text":"[jvm]\\ enum Status : Enum<Status>
"},{"location":"0.x/misk/misk/misk.tasks/-status/#entries","title":"Entries","text":"OK [jvm]OKThe task completed successfully and processed work NO_WORK [jvm]NO_WORKThe task had no work to complete FAILED [jvm]FAILEDThe task resulted in an error NO_RESCHEDULE [jvm]NO_RESCHEDULEThe task should not be rescheduled"},{"location":"0.x/misk/misk/misk.tasks/-status/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Status>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored. valueOf [jvm]fun valueOf(value: String): StatusReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Status>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.tasks/-status/entries/","title":"entries - Misk","text":"//misk/misk.tasks/Status/entries
"},{"location":"0.x/misk/misk/misk.tasks/-status/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Status>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.tasks/-status/metric-label/","title":"metricLabel - Misk","text":"//misk/misk.tasks/Status/metricLabel
"},{"location":"0.x/misk/misk/misk.tasks/-status/metric-label/#metriclabel","title":"metricLabel","text":"[jvm]\\ fun metricLabel(): String
The metric label for the status. This is used instead of name() in case the code is refactored.
"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/","title":"valueOf - Misk","text":"//misk/misk.tasks/Status/valueOf
"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Status
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.tasks/-status/values/","title":"values - Misk","text":"//misk/misk.tasks/Status/values
"},{"location":"0.x/misk/misk/misk.tasks/-status/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Status>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/","title":"FAILED - Misk","text":"//misk/misk.tasks/Status/FAILED
"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#failed","title":"FAILED","text":"[jvm]\\ FAILED
The task resulted in an error
"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/","title":"NO_RESCHEDULE - Misk","text":"//misk/misk.tasks/Status/NO_RESCHEDULE
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#no_reschedule","title":"NO_RESCHEDULE","text":"[jvm]\\ NO_RESCHEDULE
The task should not be rescheduled
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/","title":"NO_WORK - Misk","text":"//misk/misk.tasks/Status/NO_WORK
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#no_work","title":"NO_WORK","text":"[jvm]\\ NO_WORK
The task had no work to complete
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/","title":"OK - Misk","text":"//misk/misk.tasks/Status/OK
"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#ok","title":"OK","text":"[jvm]\\ OK
The task completed successfully and processed work
"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.time/","title":"Package-level declarations - Misk","text":"//misk/misk.time
"},{"location":"0.x/misk/misk/misk.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.time/#types","title":"Types","text":"Name Summary ForceUtcTimeZoneService [jvm]@Singletonclass ForceUtcTimeZoneService@Injectconstructor : AbstractIdleServiceForces the default JVM timezone to UTC."},{"location":"0.x/misk/misk/misk.time/#functions","title":"Functions","text":"Name Summary timed [jvm]fun <T> timed(f: () -> T): Pair<Duration, T>fun <T> timed(ticker: Ticker, f: () -> T): Pair<Duration, T>"},{"location":"0.x/misk/misk/misk.time/timed/","title":"timed - Misk","text":"//misk/misk.time/timed
"},{"location":"0.x/misk/misk/misk.time/timed/#timed","title":"timed","text":"[jvm]\\ fun <T> timed(f: () -> T): Pair<Duration, T>
fun <T> timed(ticker: Ticker, f: () -> T): Pair<Duration, T>
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/","title":"ForceUtcTimeZoneService - Misk","text":"//misk/misk.time/ForceUtcTimeZoneService
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#forceutctimezoneservice","title":"ForceUtcTimeZoneService","text":"[jvm]\\ @Singleton
class ForceUtcTimeZoneService@Injectconstructor : AbstractIdleService
Forces the default JVM timezone to UTC.
This is useful when running Misk applications on machines that don\u2019t have UTC set as the system timezone (eg. development machines).
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#constructors","title":"Constructors","text":"ForceUtcTimeZoneService [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/-force-utc-time-zone-service/","title":"ForceUtcTimeZoneService - Misk","text":"//misk/misk.time/ForceUtcTimeZoneService/ForceUtcTimeZoneService
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/-force-utc-time-zone-service/#forceutctimezoneservice","title":"ForceUtcTimeZoneService","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web/","title":"Package-level declarations - Misk","text":"//misk/misk.web
"},{"location":"0.x/misk/misk/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web/#types","title":"Types","text":"Name Summary ConcurrencyLimiterConfig [jvm]data class ConcurrencyLimiterConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, val min_limit: Int? = null, val max_concurrency: Int? = null, val initial_limit: Int? = null, val log_level: Level = Level.ERROR) CorsConfig [jvm]data class CorsConfig@JvmOverloadsconstructor(val allowedOrigins: Array<String> = arrayOf(\"*\"), val allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), val allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), val allowCredentials: Boolean = true, val preflightMaxAge: String = \"1800\", val chainPreflight: Boolean = true, val exposedHeaders: Array<String> = arrayOf()) FeatureBinding [jvm]interface FeatureBindingBinds an HTTP call to a WebAction function. HttpCall [jvm]interface HttpCall : HttpRequestA live HTTP call from a client for use by a chain of network interceptors. MiskWebFormBuilder [jvm]class MiskWebFormBuilderProvides a mapping from field name to Type definition given a KType. Useful for processes that want to have a schema definition of a type. For example: used by the WebActions admin dashboard tab to show a statically typed form containing request fields for developers to fill out. Currently only supports Wire request type messages; non-Wire messages return an empty mapping. MiskWebModule [jvm]class MiskWebModule@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList()) : KAbstractModule NetworkChain [jvm]interface NetworkChain NetworkInterceptor [jvm]interface NetworkInterceptor PathPattern [jvm]class PathPattern(val pattern: String, val regex: Pattern, val variableNames: List<String>, val numRegexVariables: Int, val numSegments: Int, val matchesWildcardPath: Boolean) : Comparable<PathPattern> A path with placeholders for variables. Paths may be constant like/app/home/ or dynamic like /user/{username}. Variables are delimited by curly braces and may specify an optional regex like this: {username:[a-z]+}. If no regex is specified the variable is a sequence of non-\u2018/\u2019 characters. SocketAddress [jvm]sealed class SocketAddressInformation about the socket on which a HTTP call arrived. WebActionSeedDataTransformerFactory [jvm]interface WebActionSeedDataTransformerFactoryCreates a SeedDataTransformer for a specific web Action. WebConfig [jvm]data class WebConfig@JvmOverloadsconstructor(val port: Int, val idle_timeout: Long = 0, val health_port: Int = -1, val host: String? = null, val ssl: WebSslConfig? = null, val unix_domain_socket: WebUnixDomainSocketConfig? = null, val http2: Boolean = false, val selectors: Int? = null, val acceptors: Int? = null, val queue_size: Int? = null, val jetty_max_thread_pool_size: Int = 200, val jetty_min_thread_pool_size: Int = 8, val jetty_max_thread_pool_queue_size: Int = 300, val enable_thread_pool_queue_metrics: Boolean = false, val action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), val jetty_max_concurrent_streams: Int? = null, val close_connection_percent: Double = 0.0, val gzip: Boolean = true, val minGzipSize: Int = 1024, val cors: Map<String, CorsConfig> = mapOf(), val concurrency_limiter_disabled: Boolean = true, val concurrency_limiter_log_level: Level = Level.ERROR, val concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), val shutdown_sleep_ms: Int = 0, val http_request_header_size: Int? = 32768, val http_header_cache_size: Int? = null, val override_shutdown_idle_timeout: Long? = null, val readiness_refresh_interval_ms: Int = 1000, val readiness_max_age_ms: Int = 10000, val use_virtual_threads: Boolean = false, val install_default_not_found_action: Boolean = true, val jetty_output_buffer_size: Int? = null, val jetty_initial_session_recv_window: Int? = null, val jetty_initial_stream_recv_window: Int? = null, val enable_thread_pool_health_check: Boolean = false, val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null) : Config WebSslConfig [jvm]data class WebSslConfig@JvmOverloadsconstructor(val port: Int, val cert_store: CertStoreConfig, val trust_store: TrustStoreConfig? = null, val mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, val cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN) WebUnixDomainSocketConfig [jvm]data class WebUnixDomainSocketConfig@JvmOverloadsconstructor(val path: String, val h2c: Boolean? = true)"},{"location":"0.x/misk/misk/misk.web/#functions","title":"Functions","text":"Name Summary readUtf8 [jvm]fun Response<*>.readUtf8(): String toMisk [jvm]fun Response.toMisk(): Response<ResponseBody> toResponseBody [jvm]fun String.toResponseBody(): ResponseBodyReturns a ResponseBody that writes this out as UTF-8.[jvm]fun ByteString.toResponseBody(): ResponseBodyReturns a ResponseBody that writes this out as bytestring."},{"location":"0.x/misk/misk/misk.web/read-utf8/","title":"readUtf8 - Misk","text":"//misk/misk.web/readUtf8
"},{"location":"0.x/misk/misk/misk.web/read-utf8/#readutf8","title":"readUtf8","text":"[jvm]\\ fun Response<*>.readUtf8(): String
"},{"location":"0.x/misk/misk/misk.web/to-misk/","title":"toMisk - Misk","text":"//misk/misk.web/toMisk
"},{"location":"0.x/misk/misk/misk.web/to-misk/#tomisk","title":"toMisk","text":"[jvm]\\ fun Response.toMisk(): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web/to-response-body/","title":"toResponseBody - Misk","text":"//misk/misk.web/toResponseBody
"},{"location":"0.x/misk/misk/misk.web/to-response-body/#toresponsebody","title":"toResponseBody","text":"[jvm]\\ fun String.toResponseBody(): ResponseBody
Returns a ResponseBody that writes this out as UTF-8.
[jvm]\\ fun ByteString.toResponseBody(): ResponseBody
Returns a ResponseBody that writes this out as bytestring.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/","title":"ConcurrencyLimiterConfig - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#concurrencylimiterconfig","title":"ConcurrencyLimiterConfig","text":"[jvm]\\ data class ConcurrencyLimiterConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, val min_limit: Int? = null, val max_concurrency: Int? = null, val initial_limit: Int? = null, val log_level: Level = Level.ERROR)
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#constructors","title":"Constructors","text":"ConcurrencyLimiterConfig [jvm]@JvmOverloadsconstructor(disabled: Boolean = false, strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, min_limit: Int? = null, max_concurrency: Int? = null, initial_limit: Int? = null, log_level: Level = Level.ERROR)"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#properties","title":"Properties","text":"Name Summary disabled [jvm]val disabled: Boolean = falseIf true, disables automatic load shedding when degraded. initial_limit [jvm]val initial_limit: Int? = nullInitial limit used by the concurrency limiter. log_level [jvm]val log_level: LevelThe level of log when concurrency shedding. Same as concurrency_limiter_log_level default for backwards compatibility. max_concurrency [jvm]val max_concurrency: Int? = nullMaximum allowed concurrency limit providing an upper bound failsafe. min_limit [jvm]val min_limit: Int? = nullMinimum concurrency limit allowed. strategy [jvm]val strategy: ConcurrencyLimiterStrategyThe algorithm to use for determining concurrency limits."},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/-concurrency-limiter-config/","title":"ConcurrencyLimiterConfig - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/ConcurrencyLimiterConfig
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/-concurrency-limiter-config/#concurrencylimiterconfig","title":"ConcurrencyLimiterConfig","text":"[jvm]\\
@JvmOverloads
constructor(disabled: Boolean = false, strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, min_limit: Int? = null, max_concurrency: Int? = null, initial_limit: Int? = null, log_level: Level = Level.ERROR)
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/disabled/","title":"disabled - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/disabled
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/disabled/#disabled","title":"disabled","text":"[jvm]\\ val disabled: Boolean = false
If true, disables automatic load shedding when degraded.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/initial_limit/","title":"initial_limit - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/initial_limit
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/initial_limit/#initial_limit","title":"initial_limit","text":"[jvm]\\ val initial_limit: Int? = null
Initial limit used by the concurrency limiter.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/log_level/","title":"log_level - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/log_level
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/log_level/#log_level","title":"log_level","text":"[jvm]\\ val log_level: Level
The level of log when concurrency shedding. Same as concurrency_limiter_log_level default for backwards compatibility.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/max_concurrency/","title":"max_concurrency - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/max_concurrency
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/max_concurrency/#max_concurrency","title":"max_concurrency","text":"[jvm]\\ val max_concurrency: Int? = null
Maximum allowed concurrency limit providing an upper bound failsafe.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/min_limit/","title":"min_limit - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/min_limit
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/min_limit/#min_limit","title":"min_limit","text":"[jvm]\\ val min_limit: Int? = null
Minimum concurrency limit allowed.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/strategy/","title":"strategy - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/strategy
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/strategy/#strategy","title":"strategy","text":"[jvm]\\ val strategy: ConcurrencyLimiterStrategy
The algorithm to use for determining concurrency limits.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/","title":"CorsConfig - Misk","text":"//misk/misk.web/CorsConfig
"},{"location":"0.x/misk/misk/misk.web/-cors-config/#corsconfig","title":"CorsConfig","text":"[jvm]\\ data class CorsConfig@JvmOverloadsconstructor(val allowedOrigins: Array<String> = arrayOf(\"*\"), val allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), val allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), val allowCredentials: Boolean = true, val preflightMaxAge: String = \"1800\", val chainPreflight: Boolean = true, val exposedHeaders: Array<String> = arrayOf())
"},{"location":"0.x/misk/misk/misk.web/-cors-config/#constructors","title":"Constructors","text":"CorsConfig [jvm]@JvmOverloadsconstructor(allowedOrigins: Array<String> = arrayOf(\"*\"), allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), allowCredentials: Boolean = true, preflightMaxAge: String = \"1800\", chainPreflight: Boolean = true, exposedHeaders: Array<String> = arrayOf())"},{"location":"0.x/misk/misk/misk.web/-cors-config/#properties","title":"Properties","text":"Name Summary allowCredentials [jvm]val allowCredentials: Boolean = trueA boolean indicating if the resource allows requests with credentials. allowedHeaders [jvm]val allowedHeaders: Array<String>A comma separated list of HTTP headers that are allowed to be specified when accessing the resources. allowedMethods [jvm]val allowedMethods: Array<String>A comma separated list of HTTP methods that are allowed to be used when accessing the resources. allowedOrigins [jvm]val allowedOrigins: Array<String>A comma separated list of origins that are allowed to access the resources. chainPreflight [jvm]val chainPreflight: Boolean = trueTrue if preflight requests are chained to their target resource for normal handling (as an OPTION request). exposedHeaders [jvm]val exposedHeaders: Array<String>A comma separated list of HTTP headers that are allowed to be exposed on the client. preflightMaxAge [jvm]val preflightMaxAge: StringThe number of seconds that preflight requests can be cached by the client."},{"location":"0.x/misk/misk/misk.web/-cors-config/-cors-config/","title":"CorsConfig - Misk","text":"//misk/misk.web/CorsConfig/CorsConfig
"},{"location":"0.x/misk/misk/misk.web/-cors-config/-cors-config/#corsconfig","title":"CorsConfig","text":"[jvm]\\
@JvmOverloads
constructor(allowedOrigins: Array<String> = arrayOf(\"*\"), allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), allowCredentials: Boolean = true, preflightMaxAge: String = \"1800\", chainPreflight: Boolean = true, exposedHeaders: Array<String> = arrayOf())
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allow-credentials/","title":"allowCredentials - Misk","text":"//misk/misk.web/CorsConfig/allowCredentials
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allow-credentials/#allowcredentials","title":"allowCredentials","text":"[jvm]\\ val allowCredentials: Boolean = true
A boolean indicating if the resource allows requests with credentials.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-headers/","title":"allowedHeaders - Misk","text":"//misk/misk.web/CorsConfig/allowedHeaders
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-headers/#allowedheaders","title":"allowedHeaders","text":"[jvm]\\ val allowedHeaders: Array<String>
A comma separated list of HTTP headers that are allowed to be specified when accessing the resources.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-methods/","title":"allowedMethods - Misk","text":"//misk/misk.web/CorsConfig/allowedMethods
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-methods/#allowedmethods","title":"allowedMethods","text":"[jvm]\\ val allowedMethods: Array<String>
A comma separated list of HTTP methods that are allowed to be used when accessing the resources.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-origins/","title":"allowedOrigins - Misk","text":"//misk/misk.web/CorsConfig/allowedOrigins
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-origins/#allowedorigins","title":"allowedOrigins","text":"[jvm]\\ val allowedOrigins: Array<String>
A comma separated list of origins that are allowed to access the resources.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/chain-preflight/","title":"chainPreflight - Misk","text":"//misk/misk.web/CorsConfig/chainPreflight
"},{"location":"0.x/misk/misk/misk.web/-cors-config/chain-preflight/#chainpreflight","title":"chainPreflight","text":"[jvm]\\ val chainPreflight: Boolean = true
True if preflight requests are chained to their target resource for normal handling (as an OPTION request).
"},{"location":"0.x/misk/misk/misk.web/-cors-config/exposed-headers/","title":"exposedHeaders - Misk","text":"//misk/misk.web/CorsConfig/exposedHeaders
"},{"location":"0.x/misk/misk/misk.web/-cors-config/exposed-headers/#exposedheaders","title":"exposedHeaders","text":"[jvm]\\ val exposedHeaders: Array<String>
A comma separated list of HTTP headers that are allowed to be exposed on the client.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/preflight-max-age/","title":"preflightMaxAge - Misk","text":"//misk/misk.web/CorsConfig/preflightMaxAge
"},{"location":"0.x/misk/misk/misk.web/-cors-config/preflight-max-age/#preflightmaxage","title":"preflightMaxAge","text":"[jvm]\\ val preflightMaxAge: String
The number of seconds that preflight requests can be cached by the client.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/","title":"FeatureBinding - Misk","text":"//misk/misk.web/FeatureBinding
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#featurebinding","title":"FeatureBinding","text":"[jvm]\\ interface FeatureBinding
Binds an HTTP call to a WebAction function.
Each web action has several features:
Each bindings claims one or more features that it is responsible for. Some examples:
A binding can claim multiple features. beforeCall is invoked if any features are claimed, and afterCall is only invoked if the return value is claimed.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#creating-bindings","title":"Creating Bindings","text":"Each factory is executed once for each endpoint at service startup time. Factories should interrogate the function and claim whichever features that intend to bind. This happens early so Misk can validate that every feature is bound exactly once.
Factories that return null must make no claims. If no claims are made then no binding is executed.
Misk will validate that every feature is claimed exactly once. If a feature is unclaimed that is a fatal error and the service will not be started.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#binding-execution","title":"Binding Execution","text":"Once a functions bindings have been created and validated, each binding will be executed once before and once after every each HTTP call. In this method it must bind the features it claimed by providing parameters, reading the request body, writing the response body, or taking the return value.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#types","title":"Types","text":"Name Summary Claimer [jvm]interface Claimer Factory [jvm]interface Factory Subject [jvm]interface Subject"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#functions","title":"Functions","text":"Name Summary afterCall [jvm]open fun afterCall(subject: FeatureBinding.Subject) beforeCall [jvm]open fun beforeCall(subject: FeatureBinding.Subject)"},{"location":"0.x/misk/misk/misk.web/-feature-binding/after-call/","title":"afterCall - Misk","text":"//misk/misk.web/FeatureBinding/afterCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/after-call/#aftercall","title":"afterCall","text":"[jvm]\\ open fun afterCall(subject: FeatureBinding.Subject)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/before-call/","title":"beforeCall - Misk","text":"//misk/misk.web/FeatureBinding/beforeCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/before-call/#beforecall","title":"beforeCall","text":"[jvm]\\ open fun beforeCall(subject: FeatureBinding.Subject)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/","title":"Claimer - Misk","text":"//misk/misk.web/FeatureBinding/Claimer
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/#claimer","title":"Claimer","text":"[jvm]\\ interface Claimer
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/#functions","title":"Functions","text":"Name Summary claimParameter [jvm]abstract fun claimParameter(index: Int)abstract fun claimParameter(parameter: KParameter) claimRequestBody [jvm]abstract fun claimRequestBody() claimResponseBody [jvm]abstract fun claimResponseBody() claimReturnValue [jvm]abstract fun claimReturnValue()"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-parameter/","title":"claimParameter - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimParameter
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-parameter/#claimparameter","title":"claimParameter","text":"[jvm]\\ abstract fun claimParameter(index: Int)
abstract fun claimParameter(parameter: KParameter)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-request-body/","title":"claimRequestBody - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimRequestBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-request-body/#claimrequestbody","title":"claimRequestBody","text":"[jvm]\\ abstract fun claimRequestBody()
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-response-body/","title":"claimResponseBody - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimResponseBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-response-body/#claimresponsebody","title":"claimResponseBody","text":"[jvm]\\ abstract fun claimResponseBody()
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-return-value/","title":"claimReturnValue - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimReturnValue
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-return-value/#claimreturnvalue","title":"claimReturnValue","text":"[jvm]\\ abstract fun claimReturnValue()
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/","title":"Factory - Misk","text":"//misk/misk.web/FeatureBinding/Factory
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/#factory","title":"Factory","text":"[jvm]\\ interface Factory
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action, pathPattern: PathPattern, claimer: FeatureBinding.Claimer): FeatureBinding?"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/create/","title":"create - Misk","text":"//misk/misk.web/FeatureBinding/Factory/create
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action, pathPattern: PathPattern, claimer: FeatureBinding.Claimer): FeatureBinding?
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/","title":"Subject - Misk","text":"//misk/misk.web/FeatureBinding/Subject
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#subject","title":"Subject","text":"[jvm]\\ interface Subject
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#properties","title":"Properties","text":"Name Summary httpCall [jvm]abstract val httpCall: HttpCall pathMatcher [jvm]abstract val pathMatcher: Matcher webAction [jvm]abstract val webAction: WebAction"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#functions","title":"Functions","text":"Name Summary setParameter [jvm]abstract fun setParameter(index: Int, value: Any?)abstract fun setParameter(parameter: KParameter, value: Any?) takeRequestBody [jvm]abstract fun takeRequestBody(): BufferedSource takeResponseBody [jvm]abstract fun takeResponseBody(): BufferedSink takeReturnValue [jvm]abstract fun takeReturnValue(): Any?"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/http-call/","title":"httpCall - Misk","text":"//misk/misk.web/FeatureBinding/Subject/httpCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/http-call/#httpcall","title":"httpCall","text":"[jvm]\\ abstract val httpCall: HttpCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/path-matcher/","title":"pathMatcher - Misk","text":"//misk/misk.web/FeatureBinding/Subject/pathMatcher
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/path-matcher/#pathmatcher","title":"pathMatcher","text":"[jvm]\\ abstract val pathMatcher: Matcher
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/set-parameter/","title":"setParameter - Misk","text":"//misk/misk.web/FeatureBinding/Subject/setParameter
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/set-parameter/#setparameter","title":"setParameter","text":"[jvm]\\ abstract fun setParameter(parameter: KParameter, value: Any?)
abstract fun setParameter(index: Int, value: Any?)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-request-body/","title":"takeRequestBody - Misk","text":"//misk/misk.web/FeatureBinding/Subject/takeRequestBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-request-body/#takerequestbody","title":"takeRequestBody","text":"[jvm]\\ abstract fun takeRequestBody(): BufferedSource
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-response-body/","title":"takeResponseBody - Misk","text":"//misk/misk.web/FeatureBinding/Subject/takeResponseBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"[jvm]\\ abstract fun takeResponseBody(): BufferedSink
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-return-value/","title":"takeReturnValue - Misk","text":"//misk/misk.web/FeatureBinding/Subject/takeReturnValue
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-return-value/#takereturnvalue","title":"takeReturnValue","text":"[jvm]\\ abstract fun takeReturnValue(): Any?
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/web-action/","title":"webAction - Misk","text":"//misk/misk.web/FeatureBinding/Subject/webAction
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/web-action/#webaction","title":"webAction","text":"[jvm]\\ abstract val webAction: WebAction
"},{"location":"0.x/misk/misk/misk.web/-http-call/","title":"HttpCall - Misk","text":"//misk/misk.web/HttpCall
"},{"location":"0.x/misk/misk/misk.web/-http-call/#httpcall","title":"HttpCall","text":"[jvm]\\ interface HttpCall : HttpRequest
A live HTTP call from a client for use by a chain of network interceptors.
"},{"location":"0.x/misk/misk/misk.web/-http-call/#properties","title":"Properties","text":"Name Summary cookies [jvm]abstract var cookies: List<Cookie>Cookies derived from request\u2019s \"Cookie\" header, if any dispatchMechanism [jvm]abstract val dispatchMechanism: DispatchMechanism linkLayerLocalAddress [jvm]abstract val linkLayerLocalAddress: SocketAddress? networkStatusCode [jvm]abstract val networkStatusCode: IntThe HTTP status code actually sent over the network. For gRPC, this is always 200, even for errors, per the spec. requestHeaders [jvm]abstract var requestHeaders: Headers responseHeaders [jvm]abstract val responseHeaders: Headers statusCode [jvm]abstract var statusCode: IntMeaningful HTTP status about what actually happened. Not sent over the wire in the case of gRPC, which always returns HTTP 200 even for errors. url [jvm]abstract val url: HttpUrl"},{"location":"0.x/misk/misk/misk.web/-http-call/#functions","title":"Functions","text":"Name Summary accepts [jvm]open fun accepts(): List<MediaRange> addResponseHeaders [jvm]abstract fun addResponseHeaders(headers: Headers) asOkHttpRequest [jvm]open fun asOkHttpRequest(): Request computeRequestHeader [jvm]open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?)Set or replaces an existing HTTP request header. contentType [jvm]open fun contentType(): MediaType? initWebSocketListener [jvm]abstract fun initWebSocketListener(webSocketListener: WebSocketListener)Set the call\u2019s web socket listener. This should only be called once, and only for web socket calls. putRequestBody [jvm]abstract fun putRequestBody(requestBody: BufferedSource)Changes this call so that the next call to takeRequestBody returns requestBody. Use this to apply filters such as decompression or metrics. putResponseBody [jvm]abstract fun putResponseBody(responseBody: BufferedSink)Changes this call so that the next call to takeResponseBody returns responseBody. Use this to apply filters such as decompression or metrics. putWebSocket [jvm]abstract fun putWebSocket(webSocket: WebSocket)Changes this call so that the next call to takeWebSocket returns webSocket. Use this to apply filters such as decompression or metrics. requireTrailers [jvm]abstract fun requireTrailers()Call this before the response body is written to make sure it is encoded in a way that\u2019ll permit trailers to be sent. This will do chunked encoding for HTTP/1. For HTTP/2 trailers are always permitted. It is an error to call this for web socket calls. setResponseHeader [jvm]abstract fun setResponseHeader(name: String, value: String) setResponseTrailer [jvm]abstract fun setResponseTrailer(name: String, value: String)Add a trailer. This requires that requireTrailers was called before the response body is written. setStatusCodes [jvm]abstract fun setStatusCodes(statusCode: Int, networkStatusCode: Int)Set both the raw network status code and the meaningful status code that\u2019s recorded in metrics takeRequestBody [jvm]abstract fun takeRequestBody(): BufferedSource?Claim ownership of the request body stream. Returns null if the stream has already been claimed. Callers should read the HTTP request body or call putRequestBody to create a new chain with a request body that is unclaimed. takeResponseBody [jvm]abstract fun takeResponseBody(): BufferedSink?Claim ownership of the response body stream. Returns null if the stream has already been claimed. Callers should write the HTTP response body or call putRequestBody to create a new chain with a response body that is unclaimed. takeWebSocket [jvm]abstract fun takeWebSocket(): WebSocket?Claim ownership of the call\u2019s web socket."},{"location":"0.x/misk/misk/misk.web/-http-call/accepts/","title":"accepts - Misk","text":"//misk/misk.web/HttpCall/accepts
"},{"location":"0.x/misk/misk/misk.web/-http-call/accepts/#accepts","title":"accepts","text":"[jvm]\\ open fun accepts(): List<MediaRange>
"},{"location":"0.x/misk/misk/misk.web/-http-call/add-response-headers/","title":"addResponseHeaders - Misk","text":"//misk/misk.web/HttpCall/addResponseHeaders
"},{"location":"0.x/misk/misk/misk.web/-http-call/add-response-headers/#addresponseheaders","title":"addResponseHeaders","text":"[jvm]\\ abstract fun addResponseHeaders(headers: Headers)
"},{"location":"0.x/misk/misk/misk.web/-http-call/as-ok-http-request/","title":"asOkHttpRequest - Misk","text":"//misk/misk.web/HttpCall/asOkHttpRequest
"},{"location":"0.x/misk/misk/misk.web/-http-call/as-ok-http-request/#asokhttprequest","title":"asOkHttpRequest","text":"[jvm]\\ open fun asOkHttpRequest(): Request
"},{"location":"0.x/misk/misk/misk.web/-http-call/compute-request-header/","title":"computeRequestHeader - Misk","text":"//misk/misk.web/HttpCall/computeRequestHeader
"},{"location":"0.x/misk/misk/misk.web/-http-call/compute-request-header/#computerequestheader","title":"computeRequestHeader","text":"[jvm]\\ open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?)
Set or replaces an existing HTTP request header.
"},{"location":"0.x/misk/misk/misk.web/-http-call/content-type/","title":"contentType - Misk","text":"//misk/misk.web/HttpCall/contentType
"},{"location":"0.x/misk/misk/misk.web/-http-call/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web/-http-call/cookies/","title":"cookies - Misk","text":"//misk/misk.web/HttpCall/cookies
"},{"location":"0.x/misk/misk/misk.web/-http-call/cookies/#cookies","title":"cookies","text":"[jvm]\\ abstract var cookies: List<Cookie>
Cookies derived from request\u2019s \"Cookie\" header, if any
"},{"location":"0.x/misk/misk/misk.web/-http-call/init-web-socket-listener/","title":"initWebSocketListener - Misk","text":"//misk/misk.web/HttpCall/initWebSocketListener
"},{"location":"0.x/misk/misk/misk.web/-http-call/init-web-socket-listener/#initwebsocketlistener","title":"initWebSocketListener","text":"[jvm]\\ abstract fun initWebSocketListener(webSocketListener: WebSocketListener)
Set the call\u2019s web socket listener. This should only be called once, and only for web socket calls.
"},{"location":"0.x/misk/misk/misk.web/-http-call/link-layer-local-address/","title":"linkLayerLocalAddress - Misk","text":"//misk/misk.web/HttpCall/linkLayerLocalAddress
"},{"location":"0.x/misk/misk/misk.web/-http-call/link-layer-local-address/#linklayerlocaladdress","title":"linkLayerLocalAddress","text":"[jvm]\\ abstract val linkLayerLocalAddress: SocketAddress?
"},{"location":"0.x/misk/misk/misk.web/-http-call/network-status-code/","title":"networkStatusCode - Misk","text":"//misk/misk.web/HttpCall/networkStatusCode
"},{"location":"0.x/misk/misk/misk.web/-http-call/network-status-code/#networkstatuscode","title":"networkStatusCode","text":"[jvm]\\ abstract val networkStatusCode: Int
The HTTP status code actually sent over the network. For gRPC, this is always 200, even for errors, per the spec.
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-request-body/","title":"putRequestBody - Misk","text":"//misk/misk.web/HttpCall/putRequestBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-request-body/#putrequestbody","title":"putRequestBody","text":"[jvm]\\ abstract fun putRequestBody(requestBody: BufferedSource)
Changes this call so that the next call to takeRequestBody returns requestBody. Use this to apply filters such as decompression or metrics.
This may only be called on calls whose request body has been taken. Otherwise that would be leaked.
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-response-body/","title":"putResponseBody - Misk","text":"//misk/misk.web/HttpCall/putResponseBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-response-body/#putresponsebody","title":"putResponseBody","text":"[jvm]\\ abstract fun putResponseBody(responseBody: BufferedSink)
Changes this call so that the next call to takeResponseBody returns responseBody. Use this to apply filters such as decompression or metrics.
This may only be called on calls whose response body has been taken. Otherwise that would be leaked.
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-web-socket/","title":"putWebSocket - Misk","text":"//misk/misk.web/HttpCall/putWebSocket
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-web-socket/#putwebsocket","title":"putWebSocket","text":"[jvm]\\ abstract fun putWebSocket(webSocket: WebSocket)
Changes this call so that the next call to takeWebSocket returns webSocket. Use this to apply filters such as decompression or metrics.
This may only be called on calls whose web socket has been taken. Otherwise that would be leaked.
"},{"location":"0.x/misk/misk/misk.web/-http-call/require-trailers/","title":"requireTrailers - Misk","text":"//misk/misk.web/HttpCall/requireTrailers
"},{"location":"0.x/misk/misk/misk.web/-http-call/require-trailers/#requiretrailers","title":"requireTrailers","text":"[jvm]\\ abstract fun requireTrailers()
Call this before the response body is written to make sure it is encoded in a way that\u2019ll permit trailers to be sent. This will do chunked encoding for HTTP/1. For HTTP/2 trailers are always permitted. It is an error to call this for web socket calls.
"},{"location":"0.x/misk/misk/misk.web/-http-call/response-headers/","title":"responseHeaders - Misk","text":"//misk/misk.web/HttpCall/responseHeaders
"},{"location":"0.x/misk/misk/misk.web/-http-call/response-headers/#responseheaders","title":"responseHeaders","text":"[jvm]\\ abstract val responseHeaders: Headers
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-header/","title":"setResponseHeader - Misk","text":"//misk/misk.web/HttpCall/setResponseHeader
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-header/#setresponseheader","title":"setResponseHeader","text":"[jvm]\\ abstract fun setResponseHeader(name: String, value: String)
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-trailer/","title":"setResponseTrailer - Misk","text":"//misk/misk.web/HttpCall/setResponseTrailer
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-trailer/#setresponsetrailer","title":"setResponseTrailer","text":"[jvm]\\ abstract fun setResponseTrailer(name: String, value: String)
Add a trailer. This requires that requireTrailers was called before the response body is written.
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-status-codes/","title":"setStatusCodes - Misk","text":"//misk/misk.web/HttpCall/setStatusCodes
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-status-codes/#setstatuscodes","title":"setStatusCodes","text":"[jvm]\\ abstract fun setStatusCodes(statusCode: Int, networkStatusCode: Int)
Set both the raw network status code and the meaningful status code that\u2019s recorded in metrics
"},{"location":"0.x/misk/misk/misk.web/-http-call/status-code/","title":"statusCode - Misk","text":"//misk/misk.web/HttpCall/statusCode
"},{"location":"0.x/misk/misk/misk.web/-http-call/status-code/#statuscode","title":"statusCode","text":"[jvm]\\ abstract var statusCode: Int
Meaningful HTTP status about what actually happened. Not sent over the wire in the case of gRPC, which always returns HTTP 200 even for errors.
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-request-body/","title":"takeRequestBody - Misk","text":"//misk/misk.web/HttpCall/takeRequestBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-request-body/#takerequestbody","title":"takeRequestBody","text":"[jvm]\\ abstract fun takeRequestBody(): BufferedSource?
Claim ownership of the request body stream. Returns null if the stream has already been claimed. Callers should read the HTTP request body or call putRequestBody to create a new chain with a request body that is unclaimed.
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-response-body/","title":"takeResponseBody - Misk","text":"//misk/misk.web/HttpCall/takeResponseBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"[jvm]\\ abstract fun takeResponseBody(): BufferedSink?
Claim ownership of the response body stream. Returns null if the stream has already been claimed. Callers should write the HTTP response body or call putRequestBody to create a new chain with a response body that is unclaimed.
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-web-socket/","title":"takeWebSocket - Misk","text":"//misk/misk.web/HttpCall/takeWebSocket
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-web-socket/#takewebsocket","title":"takeWebSocket","text":"[jvm]\\ abstract fun takeWebSocket(): WebSocket?
Claim ownership of the call\u2019s web socket.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/","title":"MiskWebFormBuilder - Misk","text":"//misk/misk.web/MiskWebFormBuilder
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#miskwebformbuilder","title":"MiskWebFormBuilder","text":"[jvm]\\ class MiskWebFormBuilder
Provides a mapping from field name to Type definition given a KType. Useful for processes that want to have a schema definition of a type. For example: used by the WebActions admin dashboard tab to show a statically typed form containing request fields for developers to fill out. Currently only supports Wire request type messages; non-Wire messages return an empty mapping.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#constructors","title":"Constructors","text":"MiskWebFormBuilder [jvm]constructor()"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Field [jvm]data class Field@JvmOverloadsconstructor(val name: String, val type: String, val repeated: Boolean, val annotations: List<String> = listOf())Akin to a Proto field, a field can be of primitive or another Message type, and can be repeated to become a list. Type [jvm]data class Type(val fields: List<MiskWebFormBuilder.Field>)Akin to a Proto Message, a Type has a list of fields"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#functions","title":"Functions","text":"Name Summary calculateTypes [jvm]fun calculateTypes(requestType: KType?): Map<String, MiskWebFormBuilder.Type>"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-misk-web-form-builder/","title":"MiskWebFormBuilder - Misk","text":"//misk/misk.web/MiskWebFormBuilder/MiskWebFormBuilder
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-misk-web-form-builder/#miskwebformbuilder","title":"MiskWebFormBuilder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/calculate-types/","title":"calculateTypes - Misk","text":"//misk/misk.web/MiskWebFormBuilder/calculateTypes
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/calculate-types/#calculatetypes","title":"calculateTypes","text":"[jvm]\\ fun calculateTypes(requestType: KType?): Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/","title":"Companion - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Companion
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/#functions","title":"Functions","text":"Name Summary createEnumField [jvm]fun createEnumField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.FieldAdds a field with a type that has the class name and enum values embedded Example: \"Enum\" createSyntheticEnumField [jvm]fun createSyntheticEnumField(fieldClassName: String, fieldName: String, enumValues: List<String>, repeated: Boolean, annotations: List<Annotation> = listOf()): MiskWebFormBuilder.FieldAdds a field with a type that has the class name and enum values embedded Example: \"Enum\" maybeCreatePrimitiveField [jvm]fun maybeCreatePrimitiveField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field?Create misk-web Fields for primitives and enum types. Returns null if the type cannot be mapped."},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-enum-field/","title":"createEnumField - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Companion/createEnumField
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-enum-field/#createenumfield","title":"createEnumField","text":"[jvm]\\ fun createEnumField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field
Adds a field with a type that has the class name and enum values embedded Example: \"Enum\""},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-synthetic-enum-field/","title":"createSyntheticEnumField - Misk","text":"
//misk/misk.web/MiskWebFormBuilder/Companion/createSyntheticEnumField
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-synthetic-enum-field/#createsyntheticenumfield","title":"createSyntheticEnumField","text":"[jvm]\\ fun createSyntheticEnumField(fieldClassName: String, fieldName: String, enumValues: List<String>, repeated: Boolean, annotations: List<Annotation> = listOf()): MiskWebFormBuilder.Field
Adds a field with a type that has the class name and enum values embedded Example: \"Enum\""},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/maybe-create-primitive-field/","title":"maybeCreatePrimitiveField - Misk","text":"
//misk/misk.web/MiskWebFormBuilder/Companion/maybeCreatePrimitiveField
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/maybe-create-primitive-field/#maybecreateprimitivefield","title":"maybeCreatePrimitiveField","text":"[jvm]\\ fun maybeCreatePrimitiveField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field?
Create misk-web Fields for primitives and enum types. Returns null if the type cannot be mapped.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/","title":"Field - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#field","title":"Field","text":"[jvm]\\ data class Field@JvmOverloadsconstructor(val name: String, val type: String, val repeated: Boolean, val annotations: List<String> = listOf())
Akin to a Proto field, a field can be of primitive or another Message type, and can be repeated to become a list.
Enums are encoded to contain their values within their Type definition as opposed to a unique Type.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#constructors","title":"Constructors","text":"Field [jvm]@JvmOverloadsconstructor(name: String, type: String, repeated: Boolean, annotations: List<String> = listOf())"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#properties","title":"Properties","text":"Name Summary annotations [jvm]val annotations: List<String> name [jvm]val name: String repeated [jvm]val repeated: Boolean type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/-field/","title":"Field - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/Field
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/-field/#field","title":"Field","text":"[jvm]\\
@JvmOverloads
constructor(name: String, type: String, repeated: Boolean, annotations: List<String> = listOf())
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/annotations/","title":"annotations - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/annotations
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/annotations/#annotations","title":"annotations","text":"[jvm]\\ val annotations: List<String>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/name/","title":"name - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/name
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/repeated/","title":"repeated - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/repeated
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/repeated/#repeated","title":"repeated","text":"[jvm]\\ val repeated: Boolean
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/type/","title":"type - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/type
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/","title":"Type - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Type
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#type","title":"Type","text":"[jvm]\\ data class Type(val fields: List<MiskWebFormBuilder.Field>)
Akin to a Proto Message, a Type has a list of fields
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#constructors","title":"Constructors","text":"Type [jvm]constructor(fields: List<MiskWebFormBuilder.Field>)"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#properties","title":"Properties","text":"Name Summary fields [jvm]val fields: List<MiskWebFormBuilder.Field>"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/-type/","title":"Type - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Type/Type
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/-type/#type","title":"Type","text":"[jvm]\\ constructor(fields: List<MiskWebFormBuilder.Field>)
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/fields/","title":"fields - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Type/fields
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/fields/#fields","title":"fields","text":"[jvm]\\ val fields: List<MiskWebFormBuilder.Field>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/","title":"MiskWebModule - Misk","text":"//misk/misk.web/MiskWebModule
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#miskwebmodule","title":"MiskWebModule","text":"[jvm]\\ class MiskWebModule@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList()) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#constructors","title":"Constructors","text":"MiskWebModule [jvm]@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList())"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#types","title":"Types","text":"Name Summary MiskCallerProvider [jvm]class MiskCallerProvider@Injectconstructor(authenticators: List<MiskCallerAuthenticator>) : ActionScopedProvider<MiskCaller?>"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideGzipHandler [jvm]@Provides@Singletonfun provideGzipHandler(): GzipHandler provideStatisticsHandler [jvm]@Provides@Singletonfun provideStatisticsHandler(): StatisticsHandler readinessRefreshQueue [jvm]@Provides@Singletonfun readinessRefreshQueue(queueFactory: RepeatedTaskQueueFactory, deployment: Deployment): RepeatedTaskQueue"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-web-module/","title":"MiskWebModule - Misk","text":"//misk/misk.web/MiskWebModule/MiskWebModule
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-web-module/#miskwebmodule","title":"MiskWebModule","text":"[jvm]\\
@JvmOverloads
constructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList())
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-gzip-handler/","title":"provideGzipHandler - Misk","text":"//misk/misk.web/MiskWebModule/provideGzipHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-gzip-handler/#providegziphandler","title":"provideGzipHandler","text":"[jvm]\\
@Provides
@Singleton
fun provideGzipHandler(): GzipHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-statistics-handler/","title":"provideStatisticsHandler - Misk","text":"//misk/misk.web/MiskWebModule/provideStatisticsHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-statistics-handler/#providestatisticshandler","title":"provideStatisticsHandler","text":"[jvm]\\
@Provides
@Singleton
fun provideStatisticsHandler(): StatisticsHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/readiness-refresh-queue/","title":"readinessRefreshQueue - Misk","text":"//misk/misk.web/MiskWebModule/readinessRefreshQueue
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/readiness-refresh-queue/#readinessrefreshqueue","title":"readinessRefreshQueue","text":"[jvm]\\
@Provides
@Singleton
fun readinessRefreshQueue(queueFactory: RepeatedTaskQueueFactory, deployment: Deployment): RepeatedTaskQueue
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/","title":"MiskCallerProvider - Misk","text":"//misk/misk.web/MiskWebModule/MiskCallerProvider
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#miskcallerprovider","title":"MiskCallerProvider","text":"[jvm]\\ class MiskCallerProvider@Injectconstructor(authenticators: List<MiskCallerAuthenticator>) : ActionScopedProvider<MiskCaller?>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#constructors","title":"Constructors","text":"MiskCallerProvider [jvm]@Injectconstructor(authenticators: List<MiskCallerAuthenticator>)"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): MiskCaller?"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/-misk-caller-provider/","title":"MiskCallerProvider - Misk","text":"//misk/misk.web/MiskWebModule/MiskCallerProvider/MiskCallerProvider
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/-misk-caller-provider/#miskcallerprovider","title":"MiskCallerProvider","text":"[jvm]\\
@Inject
constructor(authenticators: List<MiskCallerAuthenticator>)
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/get/","title":"get - Misk","text":"//misk/misk.web/MiskWebModule/MiskCallerProvider/get
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): MiskCaller?
"},{"location":"0.x/misk/misk/misk.web/-network-chain/","title":"NetworkChain - Misk","text":"//misk/misk.web/NetworkChain
"},{"location":"0.x/misk/misk/misk.web/-network-chain/#networkchain","title":"NetworkChain","text":"[jvm]\\ interface NetworkChain
"},{"location":"0.x/misk/misk/misk.web/-network-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ActionThe action for this call. httpCall [jvm]abstract val httpCall: HttpCallThe live HTTP call. You can access hot streams on this call. webAction [jvm]abstract val webAction: WebActionThe action instance this call is routing to."},{"location":"0.x/misk/misk/misk.web/-network-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(httpCall: HttpCall)Invoke the next call in the interceptor chain."},{"location":"0.x/misk/misk/misk.web/-network-chain/action/","title":"action - Misk","text":"//misk/misk.web/NetworkChain/action
"},{"location":"0.x/misk/misk/misk.web/-network-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: Action
The action for this call.
"},{"location":"0.x/misk/misk/misk.web/-network-chain/http-call/","title":"httpCall - Misk","text":"//misk/misk.web/NetworkChain/httpCall
"},{"location":"0.x/misk/misk/misk.web/-network-chain/http-call/#httpcall","title":"httpCall","text":"[jvm]\\ abstract val httpCall: HttpCall
The live HTTP call. You can access hot streams on this call.
"},{"location":"0.x/misk/misk/misk.web/-network-chain/proceed/","title":"proceed - Misk","text":"//misk/misk.web/NetworkChain/proceed
"},{"location":"0.x/misk/misk/misk.web/-network-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(httpCall: HttpCall)
Invoke the next call in the interceptor chain.
"},{"location":"0.x/misk/misk/misk.web/-network-chain/web-action/","title":"webAction - Misk","text":"//misk/misk.web/NetworkChain/webAction
"},{"location":"0.x/misk/misk/misk.web/-network-chain/web-action/#webaction","title":"webAction","text":"[jvm]\\ abstract val webAction: WebAction
The action instance this call is routing to.
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/","title":"NetworkInterceptor - Misk","text":"//misk/misk.web/NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#networkinterceptor","title":"NetworkInterceptor","text":"interface NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#inheritors","title":"Inheritors","text":"ContentSecurityPolicyInterceptor ExceptionHandlingInterceptor RebalancingInterceptor RequestLoggingInterceptor WideOpenDevelopmentInterceptor"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface Factory"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web/NetworkInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ abstract fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web/NetworkInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#factory","title":"Factory","text":"interface Factory
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#inheritors","title":"Inheritors","text":"Factory Factory InternalErrorInterceptorFactory Factory Factory WideOpenDevelopmentInterceptorFactory"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web/NetworkInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/","title":"PathPattern - Misk","text":"//misk/misk.web/PathPattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#pathpattern","title":"PathPattern","text":"[jvm]\\ class PathPattern(val pattern: String, val regex: Pattern, val variableNames: List<String>, val numRegexVariables: Int, val numSegments: Int, val matchesWildcardPath: Boolean) : Comparable<PathPattern>
A path with placeholders for variables. Paths may be constant like /app/home/ or dynamic like /user/{username}. Variables are delimited by curly braces and may specify an optional regex like this: {username:[a-z]+}. If no regex is specified the variable is a sequence of non-\u2018/\u2019 characters.
//misk/misk.web/PathPattern/PathPattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-path-pattern/#pathpattern","title":"PathPattern","text":"[jvm]\\ constructor(pattern: String, regex: Pattern, variableNames: List<String>, numRegexVariables: Int, numSegments: Int, matchesWildcardPath: Boolean)
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/compare-to/","title":"compareTo - Misk","text":"//misk/misk.web/PathPattern/compareTo
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: PathPattern): Int
Compares path patterns by specificity with the more specific pattern ordered first.
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/equals/","title":"equals - Misk","text":"//misk/misk.web/PathPattern/equals
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/hash-code/","title":"hashCode - Misk","text":"//misk/misk.web/PathPattern/hashCode
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matcher/","title":"matcher - Misk","text":"//misk/misk.web/PathPattern/matcher
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matcher/#matcher","title":"matcher","text":"[jvm]\\ fun matcher(requestUrl: HttpUrl): Matcher?
Returns a Matcher if requestUrl can be matched, else null
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matches-wildcard-path/","title":"matchesWildcardPath - Misk","text":"//misk/misk.web/PathPattern/matchesWildcardPath
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matches-wildcard-path/#matcheswildcardpath","title":"matchesWildcardPath","text":"[jvm]\\ val matchesWildcardPath: Boolean
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-regex-variables/","title":"numRegexVariables - Misk","text":"//misk/misk.web/PathPattern/numRegexVariables
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-regex-variables/#numregexvariables","title":"numRegexVariables","text":"[jvm]\\ val numRegexVariables: Int
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-segments/","title":"numSegments - Misk","text":"//misk/misk.web/PathPattern/numSegments
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-segments/#numsegments","title":"numSegments","text":"[jvm]\\ val numSegments: Int
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/pattern/","title":"pattern - Misk","text":"//misk/misk.web/PathPattern/pattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/pattern/#pattern","title":"pattern","text":"[jvm]\\ val pattern: String
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/regex/","title":"regex - Misk","text":"//misk/misk.web/PathPattern/regex
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/regex/#regex","title":"regex","text":"[jvm]\\ val regex: Pattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/to-string/","title":"toString - Misk","text":"//misk/misk.web/PathPattern/toString
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/variable-names/","title":"variableNames - Misk","text":"//misk/misk.web/PathPattern/variableNames
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/variable-names/#variablenames","title":"variableNames","text":"[jvm]\\ val variableNames: List<String>
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/","title":"Companion - Misk","text":"//misk/misk.web/PathPattern/Companion
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(pattern: String): PathPattern"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/parse/","title":"parse - Misk","text":"//misk/misk.web/PathPattern/Companion/parse
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(pattern: String): PathPattern
"},{"location":"0.x/misk/misk/misk.web/-socket-address/","title":"SocketAddress - Misk","text":"//misk/misk.web/SocketAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/#socketaddress","title":"SocketAddress","text":"sealed class SocketAddress
Information about the socket on which a HTTP call arrived.
"},{"location":"0.x/misk/misk/misk.web/-socket-address/#inheritors","title":"Inheritors","text":"Network Unix"},{"location":"0.x/misk/misk/misk.web/-socket-address/#types","title":"Types","text":"Name Summary Network [jvm]class Network(val ipAddress: String, val port: Int) : SocketAddress Unix [jvm]class Unix(val path: String) : SocketAddress"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/","title":"Network - Misk","text":"//misk/misk.web/SocketAddress/Network
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#network","title":"Network","text":"[jvm]\\ class Network(val ipAddress: String, val port: Int) : SocketAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#constructors","title":"Constructors","text":"Network [jvm]constructor(ipAddress: String, port: Int)"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#properties","title":"Properties","text":"Name Summary ipAddress [jvm]val ipAddress: String port [jvm]val port: Int"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/-network/","title":"Network - Misk","text":"//misk/misk.web/SocketAddress/Network/Network
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/-network/#network","title":"Network","text":"[jvm]\\ constructor(ipAddress: String, port: Int)
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/ip-address/","title":"ipAddress - Misk","text":"//misk/misk.web/SocketAddress/Network/ipAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/ip-address/#ipaddress","title":"ipAddress","text":"[jvm]\\ val ipAddress: String
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/port/","title":"port - Misk","text":"//misk/misk.web/SocketAddress/Network/port
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/port/#port","title":"port","text":"[jvm]\\ val port: Int
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/","title":"Unix - Misk","text":"//misk/misk.web/SocketAddress/Unix
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#unix","title":"Unix","text":"[jvm]\\ class Unix(val path: String) : SocketAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#constructors","title":"Constructors","text":"Unix [jvm]constructor(path: String)"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#properties","title":"Properties","text":"Name Summary path [jvm]val path: String"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/-unix/","title":"Unix - Misk","text":"//misk/misk.web/SocketAddress/Unix/Unix
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/-unix/#unix","title":"Unix","text":"[jvm]\\ constructor(path: String)
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/path/","title":"path - Misk","text":"//misk/misk.web/SocketAddress/Unix/path
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/","title":"WebActionSeedDataTransformerFactory - Misk","text":"//misk/misk.web/WebActionSeedDataTransformerFactory
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/#webactionseeddatatransformerfactory","title":"WebActionSeedDataTransformerFactory","text":"[jvm]\\ interface WebActionSeedDataTransformerFactory
Creates a SeedDataTransformer for a specific web Action.
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<WebActionSeedDataTransformerFactory>().toInstance(WebActionSeedDataTransformerFactory(...))\n//misk/misk.web/WebActionSeedDataTransformerFactory/create
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(pathPattern: PathPattern, action: Action): SeedDataTransformer?
Returns null to not transform the map on action.
"},{"location":"0.x/misk/misk/misk.web/-web-config/","title":"WebConfig - Misk","text":"//misk/misk.web/WebConfig
"},{"location":"0.x/misk/misk/misk.web/-web-config/#webconfig","title":"WebConfig","text":"[jvm]\\ data class WebConfig@JvmOverloadsconstructor(val port: Int, val idle_timeout: Long = 0, val health_port: Int = -1, val host: String? = null, val ssl: WebSslConfig? = null, val unix_domain_socket: WebUnixDomainSocketConfig? = null, val http2: Boolean = false, val selectors: Int? = null, val acceptors: Int? = null, val queue_size: Int? = null, val jetty_max_thread_pool_size: Int = 200, val jetty_min_thread_pool_size: Int = 8, val jetty_max_thread_pool_queue_size: Int = 300, val enable_thread_pool_queue_metrics: Boolean = false, val action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), val jetty_max_concurrent_streams: Int? = null, val close_connection_percent: Double = 0.0, val gzip: Boolean = true, val minGzipSize: Int = 1024, val cors: Map<String, CorsConfig> = mapOf(), val concurrency_limiter_disabled: Boolean = true, val concurrency_limiter_log_level: Level = Level.ERROR, val concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), val shutdown_sleep_ms: Int = 0, val http_request_header_size: Int? = 32768, val http_header_cache_size: Int? = null, val override_shutdown_idle_timeout: Long? = null, val readiness_refresh_interval_ms: Int = 1000, val readiness_max_age_ms: Int = 10000, val use_virtual_threads: Boolean = false, val install_default_not_found_action: Boolean = true, val jetty_output_buffer_size: Int? = null, val jetty_initial_session_recv_window: Int? = null, val jetty_initial_stream_recv_window: Int? = null, val enable_thread_pool_health_check: Boolean = false, val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null) : Config
"},{"location":"0.x/misk/misk/misk.web/-web-config/#constructors","title":"Constructors","text":"WebConfig [jvm]@JvmOverloadsconstructor(port: Int, idle_timeout: Long = 0, health_port: Int = -1, host: String? = null, ssl: WebSslConfig? = null, unix_domain_socket: WebUnixDomainSocketConfig? = null, http2: Boolean = false, selectors: Int? = null, acceptors: Int? = null, queue_size: Int? = null, jetty_max_thread_pool_size: Int = 200, jetty_min_thread_pool_size: Int = 8, jetty_max_thread_pool_queue_size: Int = 300, enable_thread_pool_queue_metrics: Boolean = false, action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), jetty_max_concurrent_streams: Int? = null, close_connection_percent: Double = 0.0, gzip: Boolean = true, minGzipSize: Int = 1024, cors: Map<String, CorsConfig> = mapOf(), concurrency_limiter_disabled: Boolean = true, concurrency_limiter_log_level: Level = Level.ERROR, concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), shutdown_sleep_ms: Int = 0, http_request_header_size: Int? = 32768, http_header_cache_size: Int? = null, override_shutdown_idle_timeout: Long? = null, readiness_refresh_interval_ms: Int = 1000, readiness_max_age_ms: Int = 10000, use_virtual_threads: Boolean = false, install_default_not_found_action: Boolean = true, jetty_output_buffer_size: Int? = null, jetty_initial_session_recv_window: Int? = null, jetty_initial_stream_recv_window: Int? = null, enable_thread_pool_health_check: Boolean = false, unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null)"},{"location":"0.x/misk/misk/misk.web/-web-config/#properties","title":"Properties","text":"Name Summary acceptors [jvm]val acceptors: Int? = nullNumber of acceptor threads. action_exception_log_level [jvm]val action_exception_log_level: ActionExceptionLogLevelConfig close_connection_percent [jvm]val close_connection_percent: Double = 0.0A value in 0.0..100.0. Include \u2018Connection: close\u2019 in this percentage of responses. concurrency_limiter [jvm]val concurrency_limiter: ConcurrencyLimiterConfig? concurrency_limiter_disabled [jvm]val concurrency_limiter_disabled: Boolean = trueIf true, disables automatic load shedding when degraded. concurrency_limiter_log_level [jvm]val concurrency_limiter_log_level: LevelThe level of log when concurrency shedding. cors [jvm]val cors: Map<String, CorsConfig> enable_thread_pool_health_check [jvm]val enable_thread_pool_health_check: Boolean = falseWires up health checks on whether Jetty\u2019s thread pool is low on threads. enable_thread_pool_queue_metrics [jvm]val enable_thread_pool_queue_metrics: Boolean = falseFlag to enable thread pool queue metrics gzip [jvm]val gzip: Boolean = trueIf true responses which are larger than the minGzipSize will be compressed. health_port [jvm]val health_port: IntIf >= 0, use a dedicated jetty thread pool for health checking. host [jvm]val host: String? = nullThe network interface to bind to. Null or 0.0.0.0 to bind to all interfaces. http2 [jvm]val http2: Boolean = falseHTTP/2 support is currently opt-in because we can\u2019t load balance it dynamically. http_header_cache_size [jvm]val http_header_cache_size: Int? = nullThe size of Jetty\u2019s header field cache, in terms of unique character branches. http_request_header_size [jvm]val http_request_header_size: Int? = 32768The maximum allowed size in bytes for the HTTP request line and HTTP request headers. idle_timeout [jvm]val idle_timeout: Long = 0If a connection is unused for this many milliseconds, it is closed. If zero, it is not closed. install_default_not_found_action [jvm]val install_default_not_found_action: Boolean = trueIf true install NotFoundAction, the default action when a path is not found. jetty_initial_session_recv_window [jvm]val jetty_initial_session_recv_window: Int? = nullThe initial size of session\u2019s flow control receive window. jetty_initial_stream_recv_window [jvm]val jetty_initial_stream_recv_window: Int? = nullThe initial size of stream\u2019s flow control receive window. jetty_max_concurrent_streams [jvm]val jetty_max_concurrent_streams: Int? = nullThe maximum number of streams per HTTP/2 connection. jetty_max_thread_pool_queue_size [jvm]val jetty_max_thread_pool_queue_size: Int = 300Maximum number of items in the queue for Jetty\u2019s thread pool. jetty_max_thread_pool_size [jvm]val jetty_max_thread_pool_size: Int = 200Maximum number of threads in Jetty\u2019s thread pool. jetty_min_thread_pool_size [jvm]val jetty_min_thread_pool_size: Int = 8Minimum number of threads in Jetty\u2019s thread pool. jetty_output_buffer_size [jvm]val jetty_output_buffer_size: Int? = nullThe output buffer size of Jetty (default is 32KB). minGzipSize [jvm]val minGzipSize: Int = 1024The minimum size in bytes before the response body will be compressed. override_shutdown_idle_timeout [jvm]val override_shutdown_idle_timeout: Long? = nullThe number of milliseconds a connection can be idling before commencing service shutdown. If zero, it is never closed and may cause ungraceful shutdown. port [jvm]val port: IntHTTP port to listen on, or 0 for any available port. queue_size [jvm]val queue_size: Int? = nullThe accept backlog. readiness_max_age_ms [jvm]val readiness_max_age_ms: Int = 10000Maximum age of readiness status. If exceeded readiness will return an error readiness_refresh_interval_ms [jvm]val readiness_refresh_interval_ms: Int = 1000How often readiness will re-run its status check. selectors [jvm]val selectors: Int? = nullNumber of NIO selector threads. shutdown_sleep_ms [jvm]val shutdown_sleep_ms: Int = 0The number of milliseconds to sleep before commencing service shutdown. ssl [jvm]val ssl: WebSslConfig? = null unix_domain_socket [jvm]val unix_domain_socket: WebUnixDomainSocketConfig? = nullConfiguration to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (like Envoy). unix_domain_sockets [jvm]val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = nullConfigurations to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (e.g. envoy, istio) use_virtual_threads [jvm]val use_virtual_threads: Boolean = falseIf possible (e.g. running on JDK 21) misk will attempt to use a virtual thread executor for jetty."},{"location":"0.x/misk/misk/misk.web/-web-config/-web-config/","title":"WebConfig - Misk","text":"//misk/misk.web/WebConfig/WebConfig
"},{"location":"0.x/misk/misk/misk.web/-web-config/-web-config/#webconfig","title":"WebConfig","text":"[jvm]\\
@JvmOverloads
constructor(port: Int, idle_timeout: Long = 0, health_port: Int = -1, host: String? = null, ssl: WebSslConfig? = null, unix_domain_socket: WebUnixDomainSocketConfig? = null, http2: Boolean = false, selectors: Int? = null, acceptors: Int? = null, queue_size: Int? = null, jetty_max_thread_pool_size: Int = 200, jetty_min_thread_pool_size: Int = 8, jetty_max_thread_pool_queue_size: Int = 300, enable_thread_pool_queue_metrics: Boolean = false, action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), jetty_max_concurrent_streams: Int? = null, close_connection_percent: Double = 0.0, gzip: Boolean = true, minGzipSize: Int = 1024, cors: Map<String, CorsConfig> = mapOf(), concurrency_limiter_disabled: Boolean = true, concurrency_limiter_log_level: Level = Level.ERROR, concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), shutdown_sleep_ms: Int = 0, http_request_header_size: Int? = 32768, http_header_cache_size: Int? = null, override_shutdown_idle_timeout: Long? = null, readiness_refresh_interval_ms: Int = 1000, readiness_max_age_ms: Int = 10000, use_virtual_threads: Boolean = false, install_default_not_found_action: Boolean = true, jetty_output_buffer_size: Int? = null, jetty_initial_session_recv_window: Int? = null, jetty_initial_stream_recv_window: Int? = null, enable_thread_pool_health_check: Boolean = false, unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null)
"},{"location":"0.x/misk/misk/misk.web/-web-config/acceptors/","title":"acceptors - Misk","text":"//misk/misk.web/WebConfig/acceptors
"},{"location":"0.x/misk/misk/misk.web/-web-config/acceptors/#acceptors","title":"acceptors","text":"[jvm]\\ val acceptors: Int? = null
Number of acceptor threads.
"},{"location":"0.x/misk/misk/misk.web/-web-config/action_exception_log_level/","title":"action_exception_log_level - Misk","text":"//misk/misk.web/WebConfig/action_exception_log_level
"},{"location":"0.x/misk/misk/misk.web/-web-config/action_exception_log_level/#action_exception_log_level","title":"action_exception_log_level","text":"[jvm]\\ val action_exception_log_level: ActionExceptionLogLevelConfig
"},{"location":"0.x/misk/misk/misk.web/-web-config/close_connection_percent/","title":"close_connection_percent - Misk","text":"//misk/misk.web/WebConfig/close_connection_percent
"},{"location":"0.x/misk/misk/misk.web/-web-config/close_connection_percent/#close_connection_percent","title":"close_connection_percent","text":"[jvm]\\ val close_connection_percent: Double = 0.0
A value in 0.0..100.0. Include \u2018Connection: close\u2019 in this percentage of responses.
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter/","title":"concurrency_limiter - Misk","text":"//misk/misk.web/WebConfig/concurrency_limiter
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter/#concurrency_limiter","title":"concurrency_limiter","text":"[jvm]\\ val concurrency_limiter: ConcurrencyLimiterConfig?
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_disabled/","title":"concurrency_limiter_disabled - Misk","text":"//misk/misk.web/WebConfig/concurrency_limiter_disabled
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_disabled/#concurrency_limiter_disabled","title":"concurrency_limiter_disabled","text":"[jvm]\\ val concurrency_limiter_disabled: Boolean = true
If true, disables automatic load shedding when degraded.
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_log_level/","title":"concurrency_limiter_log_level - Misk","text":"//misk/misk.web/WebConfig/concurrency_limiter_log_level
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_log_level/#concurrency_limiter_log_level","title":"concurrency_limiter_log_level","text":"[jvm]\\ val concurrency_limiter_log_level: Level
The level of log when concurrency shedding.
"},{"location":"0.x/misk/misk/misk.web/-web-config/cors/","title":"cors - Misk","text":"//misk/misk.web/WebConfig/cors
"},{"location":"0.x/misk/misk/misk.web/-web-config/cors/#cors","title":"cors","text":"[jvm]\\ val cors: Map<String, CorsConfig>
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_health_check/","title":"enable_thread_pool_health_check - Misk","text":"//misk/misk.web/WebConfig/enable_thread_pool_health_check
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_health_check/#enable_thread_pool_health_check","title":"enable_thread_pool_health_check","text":"[jvm]\\ val enable_thread_pool_health_check: Boolean = false
Wires up health checks on whether Jetty\u2019s thread pool is low on threads.
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_queue_metrics/","title":"enable_thread_pool_queue_metrics - Misk","text":"//misk/misk.web/WebConfig/enable_thread_pool_queue_metrics
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_queue_metrics/#enable_thread_pool_queue_metrics","title":"enable_thread_pool_queue_metrics","text":"[jvm]\\ val enable_thread_pool_queue_metrics: Boolean = false
Flag to enable thread pool queue metrics
"},{"location":"0.x/misk/misk/misk.web/-web-config/gzip/","title":"gzip - Misk","text":"//misk/misk.web/WebConfig/gzip
"},{"location":"0.x/misk/misk/misk.web/-web-config/gzip/#gzip","title":"gzip","text":"[jvm]\\ val gzip: Boolean = true
If true responses which are larger than the minGzipSize will be compressed.
"},{"location":"0.x/misk/misk/misk.web/-web-config/health_port/","title":"health_port - Misk","text":"//misk/misk.web/WebConfig/health_port
"},{"location":"0.x/misk/misk/misk.web/-web-config/health_port/#health_port","title":"health_port","text":"[jvm]\\ val health_port: Int
If >= 0, use a dedicated jetty thread pool for health checking.
A dedicated thread pool ensures that health checks are not queued or rejected when the service is saturated and queueing requests. If health checks are rejected and/or queued, the health checks may fail and k8s will kill the container, even though it might be perfectly healthy. This can cause cascading failures by sending more requests to other containers, resulting in longer queues and more health checks failures.
"},{"location":"0.x/misk/misk/misk.web/-web-config/host/","title":"host - Misk","text":"//misk/misk.web/WebConfig/host
"},{"location":"0.x/misk/misk/misk.web/-web-config/host/#host","title":"host","text":"[jvm]\\ val host: String? = null
The network interface to bind to. Null or 0.0.0.0 to bind to all interfaces.
"},{"location":"0.x/misk/misk/misk.web/-web-config/http2/","title":"http2 - Misk","text":"//misk/misk.web/WebConfig/http2
"},{"location":"0.x/misk/misk/misk.web/-web-config/http2/#http2","title":"http2","text":"[jvm]\\ val http2: Boolean = false
HTTP/2 support is currently opt-in because we can\u2019t load balance it dynamically.
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_header_cache_size/","title":"http_header_cache_size - Misk","text":"//misk/misk.web/WebConfig/http_header_cache_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_header_cache_size/#http_header_cache_size","title":"http_header_cache_size","text":"[jvm]\\ val http_header_cache_size: Int? = null
The size of Jetty\u2019s header field cache, in terms of unique character branches.
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_request_header_size/","title":"http_request_header_size - Misk","text":"//misk/misk.web/WebConfig/http_request_header_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_request_header_size/#http_request_header_size","title":"http_request_header_size","text":"[jvm]\\ val http_request_header_size: Int? = 32768
The maximum allowed size in bytes for the HTTP request line and HTTP request headers.
"},{"location":"0.x/misk/misk/misk.web/-web-config/idle_timeout/","title":"idle_timeout - Misk","text":"//misk/misk.web/WebConfig/idle_timeout
"},{"location":"0.x/misk/misk/misk.web/-web-config/idle_timeout/#idle_timeout","title":"idle_timeout","text":"[jvm]\\ val idle_timeout: Long = 0
If a connection is unused for this many milliseconds, it is closed. If zero, it is not closed.
"},{"location":"0.x/misk/misk/misk.web/-web-config/install_default_not_found_action/","title":"install_default_not_found_action - Misk","text":"//misk/misk.web/WebConfig/install_default_not_found_action
"},{"location":"0.x/misk/misk/misk.web/-web-config/install_default_not_found_action/#install_default_not_found_action","title":"install_default_not_found_action","text":"[jvm]\\ val install_default_not_found_action: Boolean = true
If true install NotFoundAction, the default action when a path is not found.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_session_recv_window/","title":"jetty_initial_session_recv_window - Misk","text":"//misk/misk.web/WebConfig/jetty_initial_session_recv_window
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_session_recv_window/#jetty_initial_session_recv_window","title":"jetty_initial_session_recv_window","text":"[jvm]\\ val jetty_initial_session_recv_window: Int? = null
The initial size of session\u2019s flow control receive window.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_stream_recv_window/","title":"jetty_initial_stream_recv_window - Misk","text":"//misk/misk.web/WebConfig/jetty_initial_stream_recv_window
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_stream_recv_window/#jetty_initial_stream_recv_window","title":"jetty_initial_stream_recv_window","text":"[jvm]\\ val jetty_initial_stream_recv_window: Int? = null
The initial size of stream\u2019s flow control receive window.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_concurrent_streams/","title":"jetty_max_concurrent_streams - Misk","text":"//misk/misk.web/WebConfig/jetty_max_concurrent_streams
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_concurrent_streams/#jetty_max_concurrent_streams","title":"jetty_max_concurrent_streams","text":"[jvm]\\ val jetty_max_concurrent_streams: Int? = null
The maximum number of streams per HTTP/2 connection.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_queue_size/","title":"jetty_max_thread_pool_queue_size - Misk","text":"//misk/misk.web/WebConfig/jetty_max_thread_pool_queue_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_queue_size/#jetty_max_thread_pool_queue_size","title":"jetty_max_thread_pool_queue_size","text":"[jvm]\\ val jetty_max_thread_pool_queue_size: Int = 300
Maximum number of items in the queue for Jetty\u2019s thread pool.
If 0, no queueing is used and requests are directly handed off to the thread pool. If a thread is not available (i.e max threads in use) the request is rejected. Unfortunately Jetty rejects requests by closing the socket instead of returning a 429. This can lead to confusing EOFExceptions for the client.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_size/","title":"jetty_max_thread_pool_size - Misk","text":"//misk/misk.web/WebConfig/jetty_max_thread_pool_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_size/#jetty_max_thread_pool_size","title":"jetty_max_thread_pool_size","text":"[jvm]\\ val jetty_max_thread_pool_size: Int = 200
Maximum number of threads in Jetty\u2019s thread pool.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_min_thread_pool_size/","title":"jetty_min_thread_pool_size - Misk","text":"//misk/misk.web/WebConfig/jetty_min_thread_pool_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_min_thread_pool_size/#jetty_min_thread_pool_size","title":"jetty_min_thread_pool_size","text":"[jvm]\\ val jetty_min_thread_pool_size: Int = 8
Minimum number of threads in Jetty\u2019s thread pool.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_output_buffer_size/","title":"jetty_output_buffer_size - Misk","text":"//misk/misk.web/WebConfig/jetty_output_buffer_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_output_buffer_size/#jetty_output_buffer_size","title":"jetty_output_buffer_size","text":"[jvm]\\ val jetty_output_buffer_size: Int? = null
The output buffer size of Jetty (default is 32KB).
"},{"location":"0.x/misk/misk/misk.web/-web-config/min-gzip-size/","title":"minGzipSize - Misk","text":"//misk/misk.web/WebConfig/minGzipSize
"},{"location":"0.x/misk/misk/misk.web/-web-config/min-gzip-size/#mingzipsize","title":"minGzipSize","text":"[jvm]\\ val minGzipSize: Int = 1024
The minimum size in bytes before the response body will be compressed.
"},{"location":"0.x/misk/misk/misk.web/-web-config/override_shutdown_idle_timeout/","title":"override_shutdown_idle_timeout - Misk","text":"//misk/misk.web/WebConfig/override_shutdown_idle_timeout
"},{"location":"0.x/misk/misk/misk.web/-web-config/override_shutdown_idle_timeout/#override_shutdown_idle_timeout","title":"override_shutdown_idle_timeout","text":"[jvm]\\ val override_shutdown_idle_timeout: Long? = null
The number of milliseconds a connection can be idling before commencing service shutdown. If zero, it is never closed and may cause ungraceful shutdown.
Note: There is an underlying strategy to determine the default shutdown idle timeout. Use this value only when necessary.
"},{"location":"0.x/misk/misk/misk.web/-web-config/port/","title":"port - Misk","text":"//misk/misk.web/WebConfig/port
"},{"location":"0.x/misk/misk/misk.web/-web-config/port/#port","title":"port","text":"[jvm]\\ val port: Int
HTTP port to listen on, or 0 for any available port.
"},{"location":"0.x/misk/misk/misk.web/-web-config/queue_size/","title":"queue_size - Misk","text":"//misk/misk.web/WebConfig/queue_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/queue_size/#queue_size","title":"queue_size","text":"[jvm]\\ val queue_size: Int? = null
The accept backlog.
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_max_age_ms/","title":"readiness_max_age_ms - Misk","text":"//misk/misk.web/WebConfig/readiness_max_age_ms
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_max_age_ms/#readiness_max_age_ms","title":"readiness_max_age_ms","text":"[jvm]\\ val readiness_max_age_ms: Int = 10000
Maximum age of readiness status. If exceeded readiness will return an error
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_refresh_interval_ms/","title":"readiness_refresh_interval_ms - Misk","text":"//misk/misk.web/WebConfig/readiness_refresh_interval_ms
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_refresh_interval_ms/#readiness_refresh_interval_ms","title":"readiness_refresh_interval_ms","text":"[jvm]\\ val readiness_refresh_interval_ms: Int = 1000
How often readiness will re-run its status check.
Ensure that readiness_refresh_interval_ms + \"readiness latency\" is less than readiness_max_age_ms or readiness will fail.\"
"},{"location":"0.x/misk/misk/misk.web/-web-config/selectors/","title":"selectors - Misk","text":"//misk/misk.web/WebConfig/selectors
"},{"location":"0.x/misk/misk/misk.web/-web-config/selectors/#selectors","title":"selectors","text":"[jvm]\\ val selectors: Int? = null
Number of NIO selector threads.
"},{"location":"0.x/misk/misk/misk.web/-web-config/shutdown_sleep_ms/","title":"shutdown_sleep_ms - Misk","text":"//misk/misk.web/WebConfig/shutdown_sleep_ms
"},{"location":"0.x/misk/misk/misk.web/-web-config/shutdown_sleep_ms/#shutdown_sleep_ms","title":"shutdown_sleep_ms","text":"[jvm]\\ val shutdown_sleep_ms: Int = 0
The number of milliseconds to sleep before commencing service shutdown.
"},{"location":"0.x/misk/misk/misk.web/-web-config/ssl/","title":"ssl - Misk","text":"//misk/misk.web/WebConfig/ssl
"},{"location":"0.x/misk/misk/misk.web/-web-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: WebSslConfig? = null
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_socket/","title":"unix_domain_socket - Misk","text":"//misk/misk.web/WebConfig/unix_domain_socket
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_socket/#unix_domain_socket","title":"unix_domain_socket","text":"[jvm]\\ val unix_domain_socket: WebUnixDomainSocketConfig? = null
Configuration to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (like Envoy).
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_sockets/","title":"unix_domain_sockets - Misk","text":"//misk/misk.web/WebConfig/unix_domain_sockets
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_sockets/#unix_domain_sockets","title":"unix_domain_sockets","text":"[jvm]\\ val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null
Configurations to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (e.g. envoy, istio)
"},{"location":"0.x/misk/misk/misk.web/-web-config/use_virtual_threads/","title":"use_virtual_threads - Misk","text":"//misk/misk.web/WebConfig/use_virtual_threads
"},{"location":"0.x/misk/misk/misk.web/-web-config/use_virtual_threads/#use_virtual_threads","title":"use_virtual_threads","text":"[jvm]\\ val use_virtual_threads: Boolean = false
If possible (e.g. running on JDK 21) misk will attempt to use a virtual thread executor for jetty.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/","title":"WebSslConfig - Misk","text":"//misk/misk.web/WebSslConfig
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#websslconfig","title":"WebSslConfig","text":"[jvm]\\ data class WebSslConfig@JvmOverloadsconstructor(val port: Int, val cert_store: CertStoreConfig, val trust_store: TrustStoreConfig? = null, val mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, val cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#constructors","title":"Constructors","text":"WebSslConfig [jvm]@JvmOverloadsconstructor(port: Int, cert_store: CertStoreConfig, trust_store: TrustStoreConfig? = null, mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#types","title":"Types","text":"Name Summary CipherCompatibility [jvm]enum CipherCompatibility : Enum<WebSslConfig.CipherCompatibility> MutualAuth [jvm]enum MutualAuth : Enum<WebSslConfig.MutualAuth>"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig cipher_compatibility [jvm]val cipher_compatibility: WebSslConfig.CipherCompatibility mutual_auth [jvm]val mutual_auth: WebSslConfig.MutualAuth port [jvm]val port: IntHTTPS port to listen on, or 0 for any available port. trust_store [jvm]val trust_store: TrustStoreConfig? = null"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-web-ssl-config/","title":"WebSslConfig - Misk","text":"//misk/misk.web/WebSslConfig/WebSslConfig
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-web-ssl-config/#websslconfig","title":"WebSslConfig","text":"[jvm]\\
@JvmOverloads
constructor(port: Int, cert_store: CertStoreConfig, trust_store: TrustStoreConfig? = null, mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cert_store/","title":"cert_store - Misk","text":"//misk/misk.web/WebSslConfig/cert_store
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cert_store/#cert_store","title":"cert_store","text":"[jvm]\\ val cert_store: CertStoreConfig
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cipher_compatibility/","title":"cipher_compatibility - Misk","text":"//misk/misk.web/WebSslConfig/cipher_compatibility
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cipher_compatibility/#cipher_compatibility","title":"cipher_compatibility","text":"[jvm]\\ val cipher_compatibility: WebSslConfig.CipherCompatibility
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/mutual_auth/","title":"mutual_auth - Misk","text":"//misk/misk.web/WebSslConfig/mutual_auth
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/mutual_auth/#mutual_auth","title":"mutual_auth","text":"[jvm]\\ val mutual_auth: WebSslConfig.MutualAuth
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/port/","title":"port - Misk","text":"//misk/misk.web/WebSslConfig/port
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/port/#port","title":"port","text":"[jvm]\\ val port: Int
HTTPS port to listen on, or 0 for any available port.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/trust_store/","title":"trust_store - Misk","text":"//misk/misk.web/WebSslConfig/trust_store
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/trust_store/#trust_store","title":"trust_store","text":"[jvm]\\ val trust_store: TrustStoreConfig? = null
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/","title":"CipherCompatibility - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#ciphercompatibility","title":"CipherCompatibility","text":"[jvm]\\ enum CipherCompatibility : Enum<WebSslConfig.CipherCompatibility>
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#entries","title":"Entries","text":"COMPATIBLE [jvm]COMPATIBLEAllows the broadest set of clients, including clients that support only out-of-date SSL features. MODERN [jvm]MODERNSupports a wide set of SSL features, allowing modern clients to negotiate SSL. RESTRICTED [jvm]RESTRICTEDSupports a reduced set of SSL features, intended to meet stricter compliance requirements."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<WebSslConfig.CipherCompatibility>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): WebSslConfig.CipherCompatibilityReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<WebSslConfig.CipherCompatibility>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/entries/","title":"entries - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/entries
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<WebSslConfig.CipherCompatibility>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/","title":"valueOf - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/valueOf
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): WebSslConfig.CipherCompatibility
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/values/","title":"values - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/values
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<WebSslConfig.CipherCompatibility>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/","title":"COMPATIBLE - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/COMPATIBLE
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/#compatible","title":"COMPATIBLE","text":"[jvm]\\ COMPATIBLE
Allows the broadest set of clients, including clients that support only out-of-date SSL features.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/","title":"MODERN - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/MODERN
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/#modern","title":"MODERN","text":"[jvm]\\ MODERN
Supports a wide set of SSL features, allowing modern clients to negotiate SSL.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/","title":"RESTRICTED - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/RESTRICTED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/#restricted","title":"RESTRICTED","text":"[jvm]\\ RESTRICTED
Supports a reduced set of SSL features, intended to meet stricter compliance requirements.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/","title":"MutualAuth - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#mutualauth","title":"MutualAuth","text":"[jvm]\\ enum MutualAuth : Enum<WebSslConfig.MutualAuth>
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#entries","title":"Entries","text":"NONE [jvm]NONE REQUIRED [jvm]REQUIRED DESIRED [jvm]DESIRED"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<WebSslConfig.MutualAuth>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): WebSslConfig.MutualAuthReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<WebSslConfig.MutualAuth>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/entries/","title":"entries - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/entries
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<WebSslConfig.MutualAuth>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/","title":"valueOf - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/valueOf
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): WebSslConfig.MutualAuth
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/values/","title":"values - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/values
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<WebSslConfig.MutualAuth>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/","title":"DESIRED - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/DESIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/#desired","title":"DESIRED","text":"[jvm]\\ DESIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/","title":"NONE - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/NONE
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/#none","title":"NONE","text":"[jvm]\\ NONE
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/","title":"REQUIRED - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/REQUIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/#required","title":"REQUIRED","text":"[jvm]\\ REQUIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/","title":"WebUnixDomainSocketConfig - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#webunixdomainsocketconfig","title":"WebUnixDomainSocketConfig","text":"[jvm]\\ data class WebUnixDomainSocketConfig@JvmOverloadsconstructor(val path: String, val h2c: Boolean? = true)
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#constructors","title":"Constructors","text":"WebUnixDomainSocketConfig [jvm]@JvmOverloadsconstructor(path: String, h2c: Boolean? = true)"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#properties","title":"Properties","text":"Name Summary h2c [jvm]val h2c: Boolean? = trueIf true, the listener will support H2C. path [jvm]val path: StringThe Unix Domain Socket to listen on. Will attempt to use the JEP-380 connector when supported (using Java 16+ and file path)"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/-web-unix-domain-socket-config/","title":"WebUnixDomainSocketConfig - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig/WebUnixDomainSocketConfig
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/-web-unix-domain-socket-config/#webunixdomainsocketconfig","title":"WebUnixDomainSocketConfig","text":"[jvm]\\
@JvmOverloads
constructor(path: String, h2c: Boolean? = true)
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/h2c/","title":"h2c - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig/h2c
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/h2c/#h2c","title":"h2c","text":"[jvm]\\ val h2c: Boolean? = true
If true, the listener will support H2C.
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/path/","title":"path - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig/path
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/path/#path","title":"path","text":"[jvm]\\ val path: String
The Unix Domain Socket to listen on. Will attempt to use the JEP-380 connector when supported (using Java 16+ and file path)
"},{"location":"0.x/misk/misk/misk.web.actions/","title":"Package-level declarations - Misk","text":"//misk/misk.web.actions
"},{"location":"0.x/misk/misk/misk.web.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.actions/#types","title":"Types","text":"Name Summary InternalErrorAction [jvm]@Singletonclass InternalErrorAction@Injectconstructor : WebAction LivenessCheckAction [jvm]@Singletonclass LivenessCheckAction : WebAction NotFoundAction [jvm]@Singletonclass NotFoundAction : WebAction ReadinessCheckAction [jvm]@Singletonclass ReadinessCheckAction : WebAction StatusAction [jvm]@Singletonclass StatusAction : WebActionReturns the current status of the service for programmatic tools that want to query for the current state of the server"},{"location":"0.x/misk/misk/misk.web.actions/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain"},{"location":"0.x/misk/misk/misk.web.actions/as-chain/","title":"asChain - Misk","text":"//misk/misk.web.actions/asChain
"},{"location":"0.x/misk/misk/misk.web.actions/as-chain/#aschain","title":"asChain","text":"[jvm]\\ fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/","title":"InternalErrorAction - Misk","text":"//misk/misk.web.actions/InternalErrorAction
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#internalerroraction","title":"InternalErrorAction","text":"[jvm]\\ @Singleton
class InternalErrorAction@Injectconstructor : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#constructors","title":"Constructors","text":"InternalErrorAction [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain error [jvm]fun error(): Nothing"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/-internal-error-action/","title":"InternalErrorAction - Misk","text":"//misk/misk.web.actions/InternalErrorAction/InternalErrorAction
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/-internal-error-action/#internalerroraction","title":"InternalErrorAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/error/","title":"error - Misk","text":"//misk/misk.web.actions/InternalErrorAction/error
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/error/#error","title":"error","text":"[jvm]\\ fun error(): Nothing
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/","title":"LivenessCheckAction - Misk","text":"//misk/misk.web.actions/LivenessCheckAction
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#livenesscheckaction","title":"LivenessCheckAction","text":"[jvm]\\ @Singleton
class LivenessCheckAction : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain livenessCheck [jvm]fun livenessCheck(): Response<String>"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/liveness-check/","title":"livenessCheck - Misk","text":"//misk/misk.web.actions/LivenessCheckAction/livenessCheck
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/liveness-check/#livenesscheck","title":"livenessCheck","text":"[jvm]\\ fun livenessCheck(): Response<String>
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/LivenessCheckAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/","title":"NotFoundAction - Misk","text":"//misk/misk.web.actions/NotFoundAction
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#notfoundaction","title":"NotFoundAction","text":"[jvm]\\ @Singleton
class NotFoundAction : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain notFound [jvm]fun notFound(path: String): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/not-found/","title":"notFound - Misk","text":"//misk/misk.web.actions/NotFoundAction/notFound
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/not-found/#notfound","title":"notFound","text":"[jvm]\\ fun notFound(path: String): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/NotFoundAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/#functions","title":"Functions","text":"Name Summary response [jvm]fun response(path: String): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/response/","title":"response - Misk","text":"//misk/misk.web.actions/NotFoundAction/Companion/response
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/response/#response","title":"response","text":"[jvm]\\ fun response(path: String): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/","title":"ReadinessCheckAction - Misk","text":"//misk/misk.web.actions/ReadinessCheckAction
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#readinesscheckaction","title":"ReadinessCheckAction","text":"[jvm]\\ @Singleton
class ReadinessCheckAction : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain readinessCheck [jvm]fun readinessCheck(): Response<String>"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/readiness-check/","title":"readinessCheck - Misk","text":"//misk/misk.web.actions/ReadinessCheckAction/readinessCheck
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/readiness-check/#readinesscheck","title":"readinessCheck","text":"[jvm]\\ fun readinessCheck(): Response<String>
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/ReadinessCheckAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/","title":"StatusAction - Misk","text":"//misk/misk.web.actions/StatusAction
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#statusaction","title":"StatusAction","text":"[jvm]\\ @Singleton
class StatusAction : WebAction
Returns the current status of the service for programmatic tools that want to query for the current state of the server
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ServerStatus [jvm]data class ServerStatus(val serviceStatus: Map<String, Service.State>, val healthCheckStatus: Map<String, HealthStatus>)"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain getStatus [jvm]fun getStatus(): StatusAction.ServerStatus"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/get-status/","title":"getStatus - Misk","text":"//misk/misk.web.actions/StatusAction/getStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/get-status/#getstatus","title":"getStatus","text":"[jvm]\\ fun getStatus(): StatusAction.ServerStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/StatusAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/","title":"ServerStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#serverstatus","title":"ServerStatus","text":"[jvm]\\ data class ServerStatus(val serviceStatus: Map<String, Service.State>, val healthCheckStatus: Map<String, HealthStatus>)
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#constructors","title":"Constructors","text":"ServerStatus [jvm]constructor(serviceStatus: Map<String, Service.State>, healthCheckStatus: Map<String, HealthStatus>)"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#properties","title":"Properties","text":"Name Summary healthCheckStatus [jvm]val healthCheckStatus: Map<String, HealthStatus> serviceStatus [jvm]val serviceStatus: Map<String, Service.State>"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/-server-status/","title":"ServerStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus/ServerStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/-server-status/#serverstatus","title":"ServerStatus","text":"[jvm]\\ constructor(serviceStatus: Map<String, Service.State>, healthCheckStatus: Map<String, HealthStatus>)
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/health-check-status/","title":"healthCheckStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus/healthCheckStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/health-check-status/#healthcheckstatus","title":"healthCheckStatus","text":"[jvm]\\ val healthCheckStatus: Map<String, HealthStatus>
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/service-status/","title":"serviceStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus/serviceStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/service-status/#servicestatus","title":"serviceStatus","text":"[jvm]\\ val serviceStatus: Map<String, Service.State>
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/","title":"Package-level declarations - Misk","text":"//misk/misk.web.concurrencylimits
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.concurrencylimits/#types","title":"Types","text":"Name Summary ConcurrencyLimiterFactory [jvm]interface ConcurrencyLimiterFactoryMultibind an instance to provide a custom Limiter for concurrency shedding. The first instance to return non-null is used. ConcurrencyLimiterStrategy [jvm]enum ConcurrencyLimiterStrategy : Enum<ConcurrencyLimiterStrategy> Per the Netflix library, strategies for calculating concurrency limits based on existing traffic. For more information, please consult the documentation. ConcurrencyLimitsModule [jvm]class ConcurrencyLimitsModule(config: ConcurrencyLimiterConfig) : KAbstractModule"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/","title":"ConcurrencyLimiterFactory - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterFactory
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/#concurrencylimiterfactory","title":"ConcurrencyLimiterFactory","text":"[jvm]\\ interface ConcurrencyLimiterFactory
Multibind an instance to provide a custom Limiter for concurrency shedding. The first instance to return non-null is used.
Misk\u2019s ConcurrencyLimitsInterceptor honors the Quota-Path HTTP header to give callers control of how their calls are aggregated when computing system throughput. The create function will be called for each unique Quota-Path received from an application. If the same Quota-Path header is used on different actions, create is only called for the first action that uses the header.
//misk/misk.web.concurrencylimits/ConcurrencyLimiterFactory/create
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action): Limiter<String>?
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/","title":"ConcurrencyLimiterStrategy - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#concurrencylimiterstrategy","title":"ConcurrencyLimiterStrategy","text":"[jvm]\\ enum ConcurrencyLimiterStrategy : Enum<ConcurrencyLimiterStrategy>
Per the Netflix library, strategies for calculating concurrency limits based on existing traffic. For more information, please consult the documentation.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#entries","title":"Entries","text":"VEGAS [jvm]VEGASA limiter based on TCP Vegas where the limit increases by alpha if the queue_use is small (< alpha) and decreases by alpha if the queue_use is large (> beta). See documentation for more information. GRADIENT [jvm]GRADIENTConcurrency limit algorithm that adjust the limits based on the gradient of change in the samples minimum RTT and absolute minimum RTT allowing for a queue of square root of the current limit. See documentation for more information. GRADIENT2 [jvm]GRADIENT2Concurrency limit algorithm that adjusts the limit based on the gradient of change of the current average RTT and a long term exponentially smoothed average RTT. See documentation for more information. AIMD [jvm]AIMDLoss based dynamic Limit that does an additive increment as long as there are no errors and a multiplicative decrement when there is an error. See documentation for more information. SETTABLE [jvm]SETTABLELimit to be used mostly for testing where the limit can be manually adjusted. See documentation for more information. FIXED [jvm]FIXEDNon dynamic limit with fixed value. See documentation for more information."},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<ConcurrencyLimiterStrategy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): ConcurrencyLimiterStrategyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<ConcurrencyLimiterStrategy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/entries/","title":"entries - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/entries
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<ConcurrencyLimiterStrategy>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/","title":"valueOf - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/valueOf
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): ConcurrencyLimiterStrategy
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/values/","title":"values - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/values
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<ConcurrencyLimiterStrategy>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/","title":"AIMD - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/AIMD
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/#aimd","title":"AIMD","text":"[jvm]\\ AIMD
Loss based dynamic Limit that does an additive increment as long as there are no errors and a multiplicative decrement when there is an error. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/","title":"FIXED - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/FIXED
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/#fixed","title":"FIXED","text":"[jvm]\\ FIXED
Non dynamic limit with fixed value. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/","title":"GRADIENT - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/GRADIENT
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/#gradient","title":"GRADIENT","text":"[jvm]\\ GRADIENT
Concurrency limit algorithm that adjust the limits based on the gradient of change in the samples minimum RTT and absolute minimum RTT allowing for a queue of square root of the current limit. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/","title":"GRADIENT2 - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/GRADIENT2
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/#gradient2","title":"GRADIENT2","text":"[jvm]\\ GRADIENT2
Concurrency limit algorithm that adjusts the limit based on the gradient of change of the current average RTT and a long term exponentially smoothed average RTT. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/","title":"SETTABLE - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/SETTABLE
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/#settable","title":"SETTABLE","text":"[jvm]\\ SETTABLE
Limit to be used mostly for testing where the limit can be manually adjusted. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/","title":"VEGAS - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/VEGAS
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/#vegas","title":"VEGAS","text":"[jvm]\\ VEGAS
A limiter based on TCP Vegas where the limit increases by alpha if the queue_use is small (< alpha) and decreases by alpha if the queue_use is large (> beta). See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/","title":"ConcurrencyLimitsModule - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#concurrencylimitsmodule","title":"ConcurrencyLimitsModule","text":"[jvm]\\ class ConcurrencyLimitsModule(config: ConcurrencyLimiterConfig) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#constructors","title":"Constructors","text":"ConcurrencyLimitsModule [jvm]constructor(config: ConcurrencyLimiterConfig)"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#functions","title":"Functions","text":"Name Summary concurrencyLimiterFactory [jvm]@ProvidesIntoSet@Singletonfun concurrencyLimiterFactory(limit: Provider<Limit>, clock: Clock): ConcurrencyLimiterFactoryThis will create the SimpleLimiter with the same Limit algorithm for each every action. This can be configured per action if needed. configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/-concurrency-limits-module/","title":"ConcurrencyLimitsModule - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule/ConcurrencyLimitsModule
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/-concurrency-limits-module/#concurrencylimitsmodule","title":"ConcurrencyLimitsModule","text":"[jvm]\\ constructor(config: ConcurrencyLimiterConfig)
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/concurrency-limiter-factory/","title":"concurrencyLimiterFactory - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule/concurrencyLimiterFactory
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/concurrency-limiter-factory/#concurrencylimiterfactory","title":"concurrencyLimiterFactory","text":"[jvm]\\
@ProvidesIntoSet
@Singleton
fun concurrencyLimiterFactory(limit: Provider<Limit>, clock: Clock): ConcurrencyLimiterFactory
This will create the SimpleLimiter with the same Limit algorithm for each every action. This can be configured per action if needed.
"},{"location":"0.x/misk/misk/misk.web.exceptions/","title":"Package-level declarations - Misk","text":"//misk/misk.web.exceptions
"},{"location":"0.x/misk/misk/misk.web.exceptions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.exceptions/#types","title":"Types","text":"Name Summary ActionExceptionLogLevelConfig [jvm]data class ActionExceptionLogLevelConfig@JvmOverloadsconstructor(val client_error_level: Level = Level.WARN, val server_error_level: Level = Level.ERROR) : ConfigConfigures the log Level for an ActionException. ExceptionHandlingInterceptor [jvm]class ExceptionHandlingInterceptor(actionName: String, mapperResolver: ExceptionMapperResolver) : NetworkInterceptorConverts and logs application and component level dispatch exceptions into the appropriate response format. Allows application and component code to control how exceptions are represented to clients; for example by setting the status code appropriately, or by returning a specialized response format specific to the error. Components can control how exceptions are mapped by installing ExceptionMapper via the ExceptionMapperModule ExceptionMapper [jvm]interface ExceptionMapper<in T : Throwable>Maps an exception to a Response ExceptionMapperModule [jvm]class ExceptionMapperModule<M : ExceptionMapper<T>, in T : Throwable>(exceptionClass: KClass<T>, mapperClass: KClass<M>) : KAbstractModuleBinds a Throwable to an ExceptionMapper. ExceptionMapperResolver [jvm]@Singletonclass ExceptionMapperResolver GrpcErrorResponse [jvm]data class GrpcErrorResponse@JvmOverloadsconstructor(val status: GrpcStatus, val message: String?, val details: List<AnyMessage> = listOf()) RequestBodyExceptionMapper [jvm]class RequestBodyExceptionMapper : ExceptionMapper<RequestBodyException>"},{"location":"0.x/misk/misk/misk.web.exceptions/#functions","title":"Functions","text":"Name Summary toGrpcStatus [jvm]fun toGrpcStatus(statusCode: Int): GrpcStatushttps://grpc.github.io/grpc/core/md_doc_http-grpc-status-mapping.html"},{"location":"0.x/misk/misk/misk.web.exceptions/to-grpc-status/","title":"toGrpcStatus - Misk","text":"//misk/misk.web.exceptions/toGrpcStatus
"},{"location":"0.x/misk/misk/misk.web.exceptions/to-grpc-status/#togrpcstatus","title":"toGrpcStatus","text":"[jvm]\\ fun toGrpcStatus(statusCode: Int): GrpcStatus
https://grpc.github.io/grpc/core/md_doc_http-grpc-status-mapping.html
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/","title":"ActionExceptionLogLevelConfig - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#actionexceptionloglevelconfig","title":"ActionExceptionLogLevelConfig","text":"[jvm]\\ data class ActionExceptionLogLevelConfig@JvmOverloadsconstructor(val client_error_level: Level = Level.WARN, val server_error_level: Level = Level.ERROR) : Config
Configures the log Level for an ActionException.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#constructors","title":"Constructors","text":"ActionExceptionLogLevelConfig [jvm]@JvmOverloadsconstructor(client_error_level: Level = Level.WARN, server_error_level: Level = Level.ERROR)"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#properties","title":"Properties","text":"Name Summary client_error_level [jvm]val client_error_level: Levelthe level used for 4xx error codes server_error_level [jvm]val server_error_level: Levelthe level used for 5xx error codes"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/-action-exception-log-level-config/","title":"ActionExceptionLogLevelConfig - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/ActionExceptionLogLevelConfig
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/-action-exception-log-level-config/#actionexceptionloglevelconfig","title":"ActionExceptionLogLevelConfig","text":"[jvm]\\
@JvmOverloads
constructor(client_error_level: Level = Level.WARN, server_error_level: Level = Level.ERROR)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/client_error_level/","title":"client_error_level - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/client_error_level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/client_error_level/#client_error_level","title":"client_error_level","text":"[jvm]\\ val client_error_level: Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/server_error_level/","title":"server_error_level - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/server_error_level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/server_error_level/#server_error_level","title":"server_error_level","text":"[jvm]\\ val server_error_level: Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/","title":"ExceptionHandlingInterceptor - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#exceptionhandlinginterceptor","title":"ExceptionHandlingInterceptor","text":"[jvm]\\ class ExceptionHandlingInterceptor(actionName: String, mapperResolver: ExceptionMapperResolver) : NetworkInterceptor
Converts and logs application and component level dispatch exceptions into the appropriate response format. Allows application and component code to control how exceptions are represented to clients; for example by setting the status code appropriately, or by returning a specialized response format specific to the error. Components can control how exceptions are mapped by installing ExceptionMapper via the ExceptionMapperModule
TODO(isabel): Set the response body in a ThreadLocal to log in RequestLoggingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#constructors","title":"Constructors","text":"ExceptionHandlingInterceptor [jvm]constructor(actionName: String, mapperResolver: ExceptionMapperResolver)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-exception-handling-interceptor/","title":"ExceptionHandlingInterceptor - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/ExceptionHandlingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-exception-handling-interceptor/#exceptionhandlinginterceptor","title":"ExceptionHandlingInterceptor","text":"[jvm]\\ constructor(actionName: String, mapperResolver: ExceptionMapperResolver)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): ExceptionHandlingInterceptor"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): ExceptionHandlingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/","title":"ExceptionMapper - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#exceptionmapper","title":"ExceptionMapper","text":"interface ExceptionMapper<in T : Throwable>
Maps an exception to a Response
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#inheritors","title":"Inheritors","text":"RequestBodyExceptionMapper"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open fun loggingLevel(th: T): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: T): GrpcErrorResponse? toResponse [jvm]abstract fun toResponse(th: T): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper/loggingLevel
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"[jvm]\\ open fun loggingLevel(th: T): Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/#return","title":"Return","text":"the level at which the given exception should be logged. defaults to ERROR but can be overridden by the mapper for the given exception
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-grpc-response/","title":"toGrpcResponse - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper/toGrpcResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-grpc-response/#togrpcresponse","title":"toGrpcResponse","text":"[jvm]\\ open fun toGrpcResponse(th: T): GrpcErrorResponse?
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper/toResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ abstract fun toResponse(th: T): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/#return","title":"Return","text":"the Response corresponding to the exception.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/","title":"ExceptionMapperModule - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#exceptionmappermodule","title":"ExceptionMapperModule","text":"[jvm]\\ class ExceptionMapperModule<M : ExceptionMapper<T>, in T : Throwable>(exceptionClass: KClass<T>, mapperClass: KClass<M>) : KAbstractModule
Binds a Throwable to an ExceptionMapper.
When an Exception occurs dispatching an Action, the bound ExceptionMapper is called to handle the Exception. If there is not an explicit binding for the thrown Exception, the mapper for the closest superclass is used.
Given the example code
install(ExceptionMapperModule.create<ActionException, ActionExceptionMapper>())\ninstall(ExceptionMapperModule.create<MyActionException, MyActionExceptionMapper>())\n\nclass MyActionException : ActionException {}\nclass MyOtherActionException : ActionException {}\nMyActionException maps to the specific MyActionExceptionMapper and MyOtherActionException maps to the ActionExceptionMapper since uses the binding of the closest bound superclass.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#constructors","title":"Constructors","text":"ExceptionMapperModule [jvm]constructor(exceptionClass: KClass<T>, mapperClass: KClass<M>)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-exception-mapper-module/","title":"ExceptionMapperModule - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule/ExceptionMapperModule
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-exception-mapper-module/#exceptionmappermodule","title":"ExceptionMapperModule","text":"[jvm]\\ constructor(exceptionClass: KClass<T>, mapperClass: KClass<M>)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/","title":"Companion - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule/Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Throwable, M : ExceptionMapper<T>> create(): ExceptionMapperModule<M, T>"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/create/","title":"create - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule/Companion/create
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Throwable, M : ExceptionMapper<T>> create(): ExceptionMapperModule<M, T>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/","title":"ExceptionMapperResolver - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperResolver
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/#exceptionmapperresolver","title":"ExceptionMapperResolver","text":"[jvm]\\ @Singleton
class ExceptionMapperResolver
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/#functions","title":"Functions","text":"Name Summary mapperFor [jvm]fun mapperFor(th: Throwable): ExceptionMapper<Throwable>?"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/mapper-for/","title":"mapperFor - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperResolver/mapperFor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/mapper-for/#mapperfor","title":"mapperFor","text":"[jvm]\\ fun mapperFor(th: Throwable): ExceptionMapper<Throwable>?
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/","title":"GrpcErrorResponse - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#grpcerrorresponse","title":"GrpcErrorResponse","text":"[jvm]\\ data class GrpcErrorResponse@JvmOverloadsconstructor(val status: GrpcStatus, val message: String?, val details: List<AnyMessage> = listOf())
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#constructors","title":"Constructors","text":"GrpcErrorResponse [jvm]@JvmOverloadsconstructor(status: GrpcStatus, message: String?, details: List<AnyMessage> = listOf())"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#properties","title":"Properties","text":"Name Summary details [jvm]val details: List<AnyMessage> message [jvm]val message: String? status [jvm]val status: GrpcStatus"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#functions","title":"Functions","text":"Name Summary copy [jvm]@JvmOverloadsfun copy(status: GrpcStatus = this.status, message: String? = this.message): GrpcErrorResponse"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-grpc-error-response/","title":"GrpcErrorResponse - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-grpc-error-response/#grpcerrorresponse","title":"GrpcErrorResponse","text":"[jvm]\\
@JvmOverloads
constructor(status: GrpcStatus, message: String?, details: List<AnyMessage> = listOf())
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/copy/","title":"copy - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/copy
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/copy/#copy","title":"copy","text":"[jvm]\\
@JvmOverloads
fun copy(status: GrpcStatus = this.status, message: String? = this.message): GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/details/","title":"details - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/details
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/details/#details","title":"details","text":"[jvm]\\ val details: List<AnyMessage>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/message/","title":"message - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/message
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/message/#message","title":"message","text":"[jvm]\\ val message: String?
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/status/","title":"status - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/status
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/status/#status","title":"status","text":"[jvm]\\ val status: GrpcStatus
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/","title":"Companion - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/#properties","title":"Properties","text":"Name Summary INTERNAL_SERVER_ERROR [jvm]val INTERNAL_SERVER_ERROR: GrpcErrorResponse"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/-i-n-t-e-r-n-a-l_-s-e-r-v-e-r_-e-r-r-o-r/","title":"INTERNAL_SERVER_ERROR - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/Companion/INTERNAL_SERVER_ERROR
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/-i-n-t-e-r-n-a-l_-s-e-r-v-e-r_-e-r-r-o-r/#internal_server_error","title":"INTERNAL_SERVER_ERROR","text":"[jvm]\\ val INTERNAL_SERVER_ERROR: GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/","title":"RequestBodyExceptionMapper - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#requestbodyexceptionmapper","title":"RequestBodyExceptionMapper","text":"[jvm]\\ class RequestBodyExceptionMapper : ExceptionMapper<RequestBodyException>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open override fun loggingLevel(th: RequestBodyException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: RequestBodyException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: RequestBodyException): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/loggingLevel
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"[jvm]\\ open override fun loggingLevel(th: RequestBodyException): Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/#return","title":"Return","text":"the level at which the given exception should be logged. defaults to ERROR but can be overridden by the mapper for the given exception
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/toResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ open override fun toResponse(th: RequestBodyException): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/#return","title":"Return","text":"the Response corresponding to the exception.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/","title":"Companion - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/#properties","title":"Properties","text":"Name Summary CLIENT_CLOSED_REQUEST [jvm]val CLIENT_CLOSED_REQUEST: Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/-c-l-i-e-n-t_-c-l-o-s-e-d_-r-e-q-u-e-s-t/","title":"CLIENT_CLOSED_REQUEST - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/Companion/CLIENT_CLOSED_REQUEST
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/-c-l-i-e-n-t_-c-l-o-s-e-d_-r-e-q-u-e-s-t/#client_closed_request","title":"CLIENT_CLOSED_REQUEST","text":"[jvm]\\ val CLIENT_CLOSED_REQUEST: Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.extractors/","title":"Package-level declarations - Misk","text":"//misk/misk.web.extractors
"},{"location":"0.x/misk/misk/misk.web.extractors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.extractors/#types","title":"Types","text":"Name Summary RequestBodyException [jvm]class RequestBodyException(cause: Throwable) : IOException StringConverter [jvm]typealias StringConverter = (String) -> Any?"},{"location":"0.x/misk/misk/misk.web.extractors/#functions","title":"Functions","text":"Name Summary converterFor [jvm]fun converterFor(type: KType): StringConverter?"},{"location":"0.x/misk/misk/misk.web.extractors/converter-for/","title":"converterFor - Misk","text":"//misk/misk.web.extractors/converterFor
"},{"location":"0.x/misk/misk/misk.web.extractors/converter-for/#converterfor","title":"converterFor","text":"[jvm]\\ fun converterFor(type: KType): StringConverter?
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/","title":"RequestBodyException - Misk","text":"//misk/misk.web.extractors/RequestBodyException
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#requestbodyexception","title":"RequestBodyException","text":"[jvm]\\ class RequestBodyException(cause: Throwable) : IOException
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#constructors","title":"Constructors","text":"RequestBodyException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/-request-body-exception/","title":"RequestBodyException - Misk","text":"//misk/misk.web.extractors/RequestBodyException/RequestBodyException
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/-request-body-exception/#requestbodyexception","title":"RequestBodyException","text":"[jvm]\\ constructor(cause: Throwable)
"},{"location":"0.x/misk/misk/misk.web.extractors/-string-converter/","title":"StringConverter - Misk","text":"//misk/misk.web.extractors/StringConverter
"},{"location":"0.x/misk/misk/misk.web.extractors/-string-converter/#stringconverter","title":"StringConverter","text":"[jvm]\\ typealias StringConverter = (String) -> Any?
"},{"location":"0.x/misk/misk/misk.web.formatter/","title":"Package-level declarations - Misk","text":"//misk/misk.web.formatter
"},{"location":"0.x/misk/misk/misk.web.formatter/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.formatter/#types","title":"Types","text":"Name Summary ClassNameFormatter [jvm]class ClassNameFormatter@Injectconstructor"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/","title":"ClassNameFormatter - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#classnameformatter","title":"ClassNameFormatter","text":"[jvm]\\ class ClassNameFormatter@Injectconstructor
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#constructors","title":"Constructors","text":"ClassNameFormatter [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-class-name-formatter/","title":"ClassNameFormatter - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter/ClassNameFormatter
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-class-name-formatter/#classnameformatter","title":"ClassNameFormatter","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/","title":"Companion - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter/Companion
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/#functions","title":"Functions","text":"Name Summary format [jvm]fun <T : Any> format(kclass: KClass<T>): String"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/format/","title":"format - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter/Companion/format
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/format/#format","title":"format","text":"[jvm]\\ fun <T : Any> format(kclass: KClass<T>): String
"},{"location":"0.x/misk/misk/misk.web.interceptors/","title":"Package-level declarations - Misk","text":"//misk/misk.web.interceptors
"},{"location":"0.x/misk/misk/misk.web.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.interceptors/#types","title":"Types","text":"Name Summary ActionLoggingConfig [jvm]data class ActionLoggingConfig@JvmOverloadsconstructor(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: List<String> = listOf(), val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)This class should have all the same config options as LogRequestResponse. See that class for details. BeforeContentEncoding [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class BeforeContentEncodingDenotes a target to be in the first order of execution before any content decoding happens. A NetworkInterceptor bound with BeforeContentEncoding is automatically installed before interceptors annotated with ForContentEncoding. InternalErrorInterceptorFactory [jvm]@Singletonclass InternalErrorInterceptorFactory@Injectconstructor : NetworkInterceptor.Factory LogRateLimiter [jvm]@Singletonclass LogRateLimiter@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)Holds rate limiters for logging success and error responses. There is a rate limiter for every action and service that calls it, for both success and error. The rate limiters are created according to the value set in LogRequestResponse annotation. MiskConcurrencyLimiterFeature [jvm]interface MiskConcurrencyLimiterFeatureInterface for a Feature flag that can dynamically enable/disable the concurrency limiter RebalancingInterceptor [jvm]class RebalancingInterceptor@Injectconstructor(random: ThreadLocalRandom, probability: Double) : NetworkInterceptorWhen we\u2019re deploying and redeploying our pods, we want to make sure that clients rebalance onto the new pods. This randomly closes connections so they will be recreated, naturally balancing connections across pods. RequestBodyLoggingInterceptor [jvm]class RequestBodyLoggingInterceptor : ApplicationInterceptorStores request and response information for an action in a ThreadLocal, to be logged in RequestLoggingInterceptor RequestLoggingConfig [jvm]data class RequestLoggingConfig(val actions: Map<String, ActionLoggingConfig>)A set of per-action logging config overrides. RequestLoggingInterceptor [jvm]class RequestLoggingInterceptor : NetworkInterceptorLogs request and response information for an action. Timing information doesn\u2019t count time writing the response to the remote client. RequestLoggingTransformer [jvm]interface RequestLoggingTransformerTransforms request and/or response bodies before they get logged by RequestLoggingInterceptor. Useful for things like stripping out noisy data. RequestResponseBody [jvm]data class RequestResponseBody@JvmOverloadsconstructor(val request: Any?, val response: Any?, val requestHeaders: Any? = null, val responseHeaders: Any? = null) ResponseBodyMarshallerFactory [jvm]@Singletonclass ResponseBodyMarshallerFactory WideOpenDevelopmentInterceptor [jvm]class WideOpenDevelopmentInterceptor@Injectconstructor : NetworkInterceptor WideOpenDevelopmentInterceptorFactory [jvm]class WideOpenDevelopmentInterceptorFactory@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment) : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/#functions","title":"Functions","text":"Name Summary tryTransform [jvm]fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?"},{"location":"0.x/misk/misk/misk.web.interceptors/try-transform/","title":"tryTransform - Misk","text":"//misk/misk.web.interceptors/tryTransform
"},{"location":"0.x/misk/misk/misk.web.interceptors/try-transform/#trytransform","title":"tryTransform","text":"[jvm]\\ fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/","title":"ActionLoggingConfig - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#actionloggingconfig","title":"ActionLoggingConfig","text":"[jvm]\\ data class ActionLoggingConfig@JvmOverloadsconstructor(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: List<String> = listOf(), val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)
This class should have all the same config options as LogRequestResponse. See that class for details.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#constructors","title":"Constructors","text":"ActionLoggingConfig [jvm]@JvmOverloadsconstructor(ratePerSecond: Long = 10, errorRatePerSecond: Long = 0, bodySampling: Double = 0.0, errorBodySampling: Double = 0.0, excludedEnvironments: List<String> = listOf(), requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#properties","title":"Properties","text":"Name Summary bodySampling [jvm]val bodySampling: Double = 0.0 errorBodySampling [jvm]val errorBodySampling: Double = 0.0 errorRatePerSecond [jvm]val errorRatePerSecond: Long = 0 excludedEnvironments [jvm]val excludedEnvironments: List<String> ratePerSecond [jvm]val ratePerSecond: Long = 10 requestLoggingMode [jvm]val requestLoggingMode: RequestLoggingMode"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-action-logging-config/","title":"ActionLoggingConfig - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-action-logging-config/#actionloggingconfig","title":"ActionLoggingConfig","text":"[jvm]\\
@JvmOverloads
constructor(ratePerSecond: Long = 10, errorRatePerSecond: Long = 0, bodySampling: Double = 0.0, errorBodySampling: Double = 0.0, excludedEnvironments: List<String> = listOf(), requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/body-sampling/","title":"bodySampling - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/bodySampling
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/body-sampling/#bodysampling","title":"bodySampling","text":"[jvm]\\ val bodySampling: Double = 0.0
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-body-sampling/","title":"errorBodySampling - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/errorBodySampling
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-body-sampling/#errorbodysampling","title":"errorBodySampling","text":"[jvm]\\ val errorBodySampling: Double = 0.0
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-rate-per-second/","title":"errorRatePerSecond - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/errorRatePerSecond
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-rate-per-second/#errorratepersecond","title":"errorRatePerSecond","text":"[jvm]\\ val errorRatePerSecond: Long = 0
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/excluded-environments/","title":"excludedEnvironments - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/excludedEnvironments
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/excluded-environments/#excludedenvironments","title":"excludedEnvironments","text":"[jvm]\\ val excludedEnvironments: List<String>
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/rate-per-second/","title":"ratePerSecond - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/ratePerSecond
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/rate-per-second/#ratepersecond","title":"ratePerSecond","text":"[jvm]\\ val ratePerSecond: Long = 10
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/request-logging-mode/","title":"requestLoggingMode - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/requestLoggingMode
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/request-logging-mode/#requestloggingmode","title":"requestLoggingMode","text":"[jvm]\\ val requestLoggingMode: RequestLoggingMode
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/","title":"Companion - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/Companion
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/#functions","title":"Functions","text":"Name Summary fromAnnotation [jvm]fun fromAnnotation(logRequestResponse: LogRequestResponse): ActionLoggingConfig fromConfigMapOrAnnotation [jvm]fun fromConfigMapOrAnnotation(action: Action, configs: Set<RequestLoggingConfig>, annotation: LogRequestResponse): ActionLoggingConfig"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-annotation/","title":"fromAnnotation - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/Companion/fromAnnotation
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-annotation/#fromannotation","title":"fromAnnotation","text":"[jvm]\\ fun fromAnnotation(logRequestResponse: LogRequestResponse): ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-config-map-or-annotation/","title":"fromConfigMapOrAnnotation - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/Companion/fromConfigMapOrAnnotation
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-config-map-or-annotation/#fromconfigmaporannotation","title":"fromConfigMapOrAnnotation","text":"[jvm]\\ fun fromConfigMapOrAnnotation(action: Action, configs: Set<RequestLoggingConfig>, annotation: LogRequestResponse): ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-before-content-encoding/","title":"BeforeContentEncoding - Misk","text":"//misk/misk.web.interceptors/BeforeContentEncoding
"},{"location":"0.x/misk/misk/misk.web.interceptors/-before-content-encoding/#beforecontentencoding","title":"BeforeContentEncoding","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class BeforeContentEncoding
Denotes a target to be in the first order of execution before any content decoding happens. A NetworkInterceptor bound with BeforeContentEncoding is automatically installed before interceptors annotated with ForContentEncoding.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/","title":"InternalErrorInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/InternalErrorInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#internalerrorinterceptorfactory","title":"InternalErrorInterceptorFactory","text":"[jvm]\\ @Singleton
class InternalErrorInterceptorFactory@Injectconstructor : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#constructors","title":"Constructors","text":"InternalErrorInterceptorFactory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/-internal-error-interceptor-factory/","title":"InternalErrorInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/InternalErrorInterceptorFactory/InternalErrorInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/-internal-error-interceptor-factory/#internalerrorinterceptorfactory","title":"InternalErrorInterceptorFactory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/InternalErrorInterceptorFactory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/","title":"LogRateLimiter - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#logratelimiter","title":"LogRateLimiter","text":"[jvm]\\ @Singleton
class LogRateLimiter@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)
Holds rate limiters for logging success and error responses. There is a rate limiter for every action and service that calls it, for both success and error. The rate limiters are created according to the value set in LogRequestResponse annotation.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#constructors","title":"Constructors","text":"LogRateLimiter [jvm]@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#types","title":"Types","text":"Name Summary LogBucketId [jvm]data class LogBucketId(val actionClass: String, val isError: Boolean) : Comparable<LogRateLimiter.LogBucketId>"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#functions","title":"Functions","text":"Name Summary tryAcquire [jvm]fun tryAcquire(bucketId: LogRateLimiter.LogBucketId, ratePerSecond: Long): Boolean"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-rate-limiter/","title":"LogRateLimiter - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogRateLimiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-rate-limiter/#logratelimiter","title":"LogRateLimiter","text":"[jvm]\\
@Inject
constructor(rateLimiterFactory: RateLimiter.Factory)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/tryAcquire
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"[jvm]\\ fun tryAcquire(bucketId: LogRateLimiter.LogBucketId, ratePerSecond: Long): Boolean
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/","title":"LogBucketId - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#logbucketid","title":"LogBucketId","text":"[jvm]\\ data class LogBucketId(val actionClass: String, val isError: Boolean) : Comparable<LogRateLimiter.LogBucketId>
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#constructors","title":"Constructors","text":"LogBucketId [jvm]constructor(actionClass: String, isError: Boolean)"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: StringActionClass from which we can grab the LogRequestResponse isError [jvm]val isError: BooleanIf the response code is error, we look up the errorRateLimiter"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: LogRateLimiter.LogBucketId): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/-log-bucket-id/","title":"LogBucketId - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/LogBucketId
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/-log-bucket-id/#logbucketid","title":"LogBucketId","text":"[jvm]\\ constructor(actionClass: String, isError: Boolean)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/action-class/","title":"actionClass - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/actionClass
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/action-class/#actionclass","title":"actionClass","text":"[jvm]\\ val actionClass: String
ActionClass from which we can grab the LogRequestResponse
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/compare-to/","title":"compareTo - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/compareTo
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: LogRateLimiter.LogBucketId): Int
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/is-error/","title":"isError - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/isError
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/is-error/#iserror","title":"isError","text":"[jvm]\\ val isError: Boolean
If the response code is error, we look up the errorRateLimiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/to-string/","title":"toString - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/toString
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/","title":"MiskConcurrencyLimiterFeature - Misk","text":"//misk/misk.web.interceptors/MiskConcurrencyLimiterFeature
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/#miskconcurrencylimiterfeature","title":"MiskConcurrencyLimiterFeature","text":"[jvm]\\ interface MiskConcurrencyLimiterFeature
Interface for a Feature flag that can dynamically enable/disable the concurrency limiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/#functions","title":"Functions","text":"Name Summary enabled [jvm]abstract fun enabled(): Boolean"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/enabled/","title":"enabled - Misk","text":"//misk/misk.web.interceptors/MiskConcurrencyLimiterFeature/enabled
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/enabled/#enabled","title":"enabled","text":"[jvm]\\ abstract fun enabled(): Boolean
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/","title":"RebalancingInterceptor - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#rebalancinginterceptor","title":"RebalancingInterceptor","text":"[jvm]\\ class RebalancingInterceptor@Injectconstructor(random: ThreadLocalRandom, probability: Double) : NetworkInterceptor
When we\u2019re deploying and redeploying our pods, we want to make sure that clients rebalance onto the new pods. This randomly closes connections so they will be recreated, naturally balancing connections across pods.
This does not close Unix domain socket connections. This interceptor is intended to mitigate imbalanced load from long-lived client connections maintained from client apps. Connections over UDS are oriented towards service mesh sidecars that employ sufficient client-side load balancing.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#constructors","title":"Constructors","text":"RebalancingInterceptor [jvm]@Injectconstructor(random: ThreadLocalRandom, probability: Double)"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-rebalancing-interceptor/","title":"RebalancingInterceptor - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/RebalancingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-rebalancing-interceptor/#rebalancinginterceptor","title":"RebalancingInterceptor","text":"[jvm]\\
@Inject
constructor(random: ThreadLocalRandom, probability: Double)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/","title":"RequestBodyLoggingInterceptor - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#requestbodylogginginterceptor","title":"RequestBodyLoggingInterceptor","text":"[jvm]\\ class RequestBodyLoggingInterceptor : ApplicationInterceptor
Stores request and response information for an action in a ThreadLocal, to be logged in RequestLoggingInterceptor
Timing information doesn\u2019t count time writing the response to the remote client.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : ApplicationInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Chain): Any
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : ApplicationInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): ApplicationInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): ApplicationInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/","title":"RequestLoggingConfig - Misk","text":"//misk/misk.web.interceptors/RequestLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#requestloggingconfig","title":"RequestLoggingConfig","text":"[jvm]\\ data class RequestLoggingConfig(val actions: Map<String, ActionLoggingConfig>)
A set of per-action logging config overrides.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#constructors","title":"Constructors","text":"RequestLoggingConfig [jvm]constructor(actions: Map<String, ActionLoggingConfig>)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#properties","title":"Properties","text":"Name Summary actions [jvm]val actions: Map<String, ActionLoggingConfig>"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/-request-logging-config/","title":"RequestLoggingConfig - Misk","text":"//misk/misk.web.interceptors/RequestLoggingConfig/RequestLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/-request-logging-config/#requestloggingconfig","title":"RequestLoggingConfig","text":"[jvm]\\ constructor(actions: Map<String, ActionLoggingConfig>)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/actions/","title":"actions - Misk","text":"//misk/misk.web.interceptors/RequestLoggingConfig/actions
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/actions/#actions","title":"actions","text":"[jvm]\\ val actions: Map<String, ActionLoggingConfig>
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/","title":"RequestLoggingInterceptor - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#requestlogginginterceptor","title":"RequestLoggingInterceptor","text":"[jvm]\\ class RequestLoggingInterceptor : NetworkInterceptor
Logs request and response information for an action. Timing information doesn\u2019t count time writing the response to the remote client.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain) maybeLog [jvm]fun maybeLog(httpCall: HttpCall, stopwatch: Stopwatch, error: Throwable?)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/maybe-log/","title":"maybeLog - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/maybeLog
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/maybe-log/#maybelog","title":"maybeLog","text":"[jvm]\\ fun maybeLog(httpCall: HttpCall, stopwatch: Stopwatch, error: Throwable?)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/","title":"RequestLoggingTransformer - Misk","text":"//misk/misk.web.interceptors/RequestLoggingTransformer
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/#requestloggingtransformer","title":"RequestLoggingTransformer","text":"[jvm]\\ interface RequestLoggingTransformer
Transforms request and/or response bodies before they get logged by RequestLoggingInterceptor. Useful for things like stripping out noisy data.
Note that the order in which RequestLoggingTransformers get applied is considered undefined and cannot be reliably controlled.
//misk/misk.web.interceptors/RequestLoggingTransformer/transform
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/transform/#transform","title":"transform","text":"[jvm]\\ abstract fun transform(requestResponseBody: RequestResponseBody?): RequestResponseBody?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/","title":"RequestResponseBody - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#requestresponsebody","title":"RequestResponseBody","text":"[jvm]\\ data class RequestResponseBody@JvmOverloadsconstructor(val request: Any?, val response: Any?, val requestHeaders: Any? = null, val responseHeaders: Any? = null)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#constructors","title":"Constructors","text":"RequestResponseBody [jvm]@JvmOverloadsconstructor(request: Any?, response: Any?, requestHeaders: Any? = null, responseHeaders: Any? = null)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#properties","title":"Properties","text":"Name Summary request [jvm]val request: Any? requestHeaders [jvm]val requestHeaders: Any? = null response [jvm]val response: Any? responseHeaders [jvm]val responseHeaders: Any? = null"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/-request-response-body/","title":"RequestResponseBody - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/RequestResponseBody
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/-request-response-body/#requestresponsebody","title":"RequestResponseBody","text":"[jvm]\\
@JvmOverloads
constructor(request: Any?, response: Any?, requestHeaders: Any? = null, responseHeaders: Any? = null)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request-headers/","title":"requestHeaders - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/requestHeaders
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request-headers/#requestheaders","title":"requestHeaders","text":"[jvm]\\ val requestHeaders: Any? = null
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request/","title":"request - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/request
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request/#request","title":"request","text":"[jvm]\\ val request: Any?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response-headers/","title":"responseHeaders - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/responseHeaders
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response-headers/#responseheaders","title":"responseHeaders","text":"[jvm]\\ val responseHeaders: Any? = null
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response/","title":"response - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/response
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response/#response","title":"response","text":"[jvm]\\ val response: Any?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/","title":"ResponseBodyMarshallerFactory - Misk","text":"//misk/misk.web.interceptors/ResponseBodyMarshallerFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/#responsebodymarshallerfactory","title":"ResponseBodyMarshallerFactory","text":"[jvm]\\ @Singleton
class ResponseBodyMarshallerFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(action: Action): Marshaller<Any>Returns a marshaller for action, or null if it has no response to marshal."},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/ResponseBodyMarshallerFactory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/create/#create","title":"create","text":"[jvm]\\ fun create(action: Action): Marshaller<Any>
Returns a marshaller for action, or null if it has no response to marshal.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/","title":"WideOpenDevelopmentInterceptor - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#wideopendevelopmentinterceptor","title":"WideOpenDevelopmentInterceptor","text":"[jvm]\\ class WideOpenDevelopmentInterceptor@Injectconstructor : NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#constructors","title":"Constructors","text":"WideOpenDevelopmentInterceptor [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/-wide-open-development-interceptor/","title":"WideOpenDevelopmentInterceptor - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor/WideOpenDevelopmentInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/-wide-open-development-interceptor/#wideopendevelopmentinterceptor","title":"WideOpenDevelopmentInterceptor","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/","title":"WideOpenDevelopmentInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#wideopendevelopmentinterceptorfactory","title":"WideOpenDevelopmentInterceptorFactory","text":"[jvm]\\ class WideOpenDevelopmentInterceptorFactory@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment) : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#constructors","title":"Constructors","text":"WideOpenDevelopmentInterceptorFactory [jvm]@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment)"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/-wide-open-development-interceptor-factory/","title":"WideOpenDevelopmentInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory/WideOpenDevelopmentInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/-wide-open-development-interceptor-factory/#wideopendevelopmentinterceptorfactory","title":"WideOpenDevelopmentInterceptorFactory","text":"[jvm]\\
@Inject
constructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.jetty/","title":"Package-level declarations - Misk","text":"//misk/misk.web.jetty
"},{"location":"0.x/misk/misk/misk.web.jetty/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.jetty/#types","title":"Types","text":"Name Summary JettyService [jvm]@Singletonclass JettyService : AbstractIdleService MeasuredQueuedThreadPool [jvm]class MeasuredQueuedThreadPool(threadPool: QueuedThreadPool) : MeasuredThreadPoolA MeasuredThreadPool for a QueuedThreadPool MeasuredThreadPool [jvm]interface MeasuredThreadPoolA common interface that can emit metrics about a thread pool. MeasuredThreadPoolExecutor [jvm]class MeasuredThreadPoolExecutor(threadPool: ThreadPoolExecutor) : MeasuredThreadPoolA MeasuredThreadPool for a ThreadPoolExecutor ThreadPoolQueueMetrics [jvm]@Singletonclass ThreadPoolQueueMetrics"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/","title":"JettyService - Misk","text":"//misk/misk.web.jetty/JettyService
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#jettyservice","title":"JettyService","text":"[jvm]\\ @Singleton
class JettyService : AbstractIdleService
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#properties","title":"Properties","text":"Name Summary healthServerUrl [jvm]val healthServerUrl: HttpUrl? httpServerUrl [jvm]val httpServerUrl: HttpUrl httpsServerUrl [jvm]val httpsServerUrl: HttpUrl?"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/health-server-url/","title":"healthServerUrl - Misk","text":"//misk/misk.web.jetty/JettyService/healthServerUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/health-server-url/#healthserverurl","title":"healthServerUrl","text":"[jvm]\\ val healthServerUrl: HttpUrl?
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/http-server-url/","title":"httpServerUrl - Misk","text":"//misk/misk.web.jetty/JettyService/httpServerUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/http-server-url/#httpserverurl","title":"httpServerUrl","text":"[jvm]\\ val httpServerUrl: HttpUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/https-server-url/","title":"httpsServerUrl - Misk","text":"//misk/misk.web.jetty/JettyService/httpsServerUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/https-server-url/#httpsserverurl","title":"httpsServerUrl","text":"[jvm]\\ val httpsServerUrl: HttpUrl?
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/-companion/","title":"Companion - Misk","text":"//misk/misk.web.jetty/JettyService/Companion
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/","title":"MeasuredQueuedThreadPool - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#measuredqueuedthreadpool","title":"MeasuredQueuedThreadPool","text":"[jvm]\\ class MeasuredQueuedThreadPool(threadPool: QueuedThreadPool) : MeasuredThreadPool
A MeasuredThreadPool for a QueuedThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#constructors","title":"Constructors","text":"MeasuredQueuedThreadPool [jvm]constructor(threadPool: QueuedThreadPool)"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#functions","title":"Functions","text":"Name Summary activeCount [jvm]open override fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]open override fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]open override fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]open override fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/-measured-queued-thread-pool/","title":"MeasuredQueuedThreadPool - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/MeasuredQueuedThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/-measured-queued-thread-pool/#measuredqueuedthreadpool","title":"MeasuredQueuedThreadPool","text":"[jvm]\\ constructor(threadPool: QueuedThreadPool)
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/active-count/","title":"activeCount - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/activeCount
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/active-count/#activecount","title":"activeCount","text":"[jvm]\\ open override fun activeCount(): Int
The number of active threads.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/max-pool-size/","title":"maxPoolSize - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/maxPoolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"[jvm]\\ open override fun maxPoolSize(): Int
The maximum size the pool can grow to.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/pool-size/","title":"poolSize - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/poolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/pool-size/#poolsize","title":"poolSize","text":"[jvm]\\ open override fun poolSize(): Int
The current size of the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/queue-size/","title":"queueSize - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/queueSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ open override fun queueSize(): Int
The current number of tasks in the queue waiting to be processed by the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/","title":"MeasuredThreadPool - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#measuredthreadpool","title":"MeasuredThreadPool","text":"interface MeasuredThreadPool
A common interface that can emit metrics about a thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#inheritors","title":"Inheritors","text":"MeasuredQueuedThreadPool MeasuredThreadPoolExecutor"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#functions","title":"Functions","text":"Name Summary activeCount [jvm]abstract fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]abstract fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]abstract fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]abstract fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/active-count/","title":"activeCount - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/activeCount
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/active-count/#activecount","title":"activeCount","text":"[jvm]\\ abstract fun activeCount(): Int
The number of active threads.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/max-pool-size/","title":"maxPoolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/maxPoolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"[jvm]\\ abstract fun maxPoolSize(): Int
The maximum size the pool can grow to.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/pool-size/","title":"poolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/poolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/pool-size/#poolsize","title":"poolSize","text":"[jvm]\\ abstract fun poolSize(): Int
The current size of the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/queue-size/","title":"queueSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/queueSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ abstract fun queueSize(): Int
The current number of tasks in the queue waiting to be processed by the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/","title":"MeasuredThreadPoolExecutor - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#measuredthreadpoolexecutor","title":"MeasuredThreadPoolExecutor","text":"[jvm]\\ class MeasuredThreadPoolExecutor(threadPool: ThreadPoolExecutor) : MeasuredThreadPool
A MeasuredThreadPool for a ThreadPoolExecutor
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#constructors","title":"Constructors","text":"MeasuredThreadPoolExecutor [jvm]constructor(threadPool: ThreadPoolExecutor)"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#functions","title":"Functions","text":"Name Summary activeCount [jvm]open override fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]open override fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]open override fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]open override fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/-measured-thread-pool-executor/","title":"MeasuredThreadPoolExecutor - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/MeasuredThreadPoolExecutor
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/-measured-thread-pool-executor/#measuredthreadpoolexecutor","title":"MeasuredThreadPoolExecutor","text":"[jvm]\\ constructor(threadPool: ThreadPoolExecutor)
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/active-count/","title":"activeCount - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/activeCount
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/active-count/#activecount","title":"activeCount","text":"[jvm]\\ open override fun activeCount(): Int
The number of active threads.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/max-pool-size/","title":"maxPoolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/maxPoolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"[jvm]\\ open override fun maxPoolSize(): Int
The maximum size the pool can grow to.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/pool-size/","title":"poolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/poolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/pool-size/#poolsize","title":"poolSize","text":"[jvm]\\ open override fun poolSize(): Int
The current size of the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/queue-size/","title":"queueSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/queueSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ open override fun queueSize(): Int
The current number of tasks in the queue waiting to be processed by the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/","title":"ThreadPoolQueueMetrics - Misk","text":"//misk/misk.web.jetty/ThreadPoolQueueMetrics
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/#threadpoolqueuemetrics","title":"ThreadPoolQueueMetrics","text":"[jvm]\\ @Singleton
class ThreadPoolQueueMetrics
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/#functions","title":"Functions","text":"Name Summary recordQueueLatency [jvm]fun recordQueueLatency(latency: Duration)"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/record-queue-latency/","title":"recordQueueLatency - Misk","text":"//misk/misk.web.jetty/ThreadPoolQueueMetrics/recordQueueLatency
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/record-queue-latency/#recordqueuelatency","title":"recordQueueLatency","text":"[jvm]\\ fun recordQueueLatency(latency: Duration)
"},{"location":"0.x/misk/misk/misk.web.marshal/","title":"Package-level declarations - Misk","text":"//misk/misk.web.marshal
"},{"location":"0.x/misk/misk/misk.web.marshal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.marshal/#types","title":"Types","text":"Name Summary GenericMarshallers [jvm]object GenericMarshallersHandles generic marshalling, for cases where the action doesn\u2019t explicitly specify return content GenericUnmarshallers [jvm]object GenericUnmarshallersHandles generic unmarshalling, for cases where the action can accept anything JsonMarshaller [jvm]class JsonMarshaller<T>(val adapter: JsonAdapter<T>) : Marshaller<T> JsonUnmarshaller [jvm]class JsonUnmarshaller(val adapter: JsonAdapter<Any>) : Unmarshaller Marshaller [jvm]interface Marshaller<in T>Marshalls typed kotlin objects into a ResponseBody MultipartUnmarshaller [jvm]object MultipartUnmarshaller : Unmarshaller PlainTextMarshaller [jvm]object PlainTextMarshaller : Marshaller<Any> PlainTextUnmarshaller [jvm]object PlainTextUnmarshaller ProtobufMarshaller [jvm]class ProtobufMarshaller<T>(val adapter: ProtoAdapter<T>) : Marshaller<T> ProtobufUnmarshaller [jvm]class ProtobufUnmarshaller(val adapter: ProtoAdapter<Any>) : Unmarshaller Unmarshaller [jvm]interface UnmarshallerUnmarshalls a typed object from an incoming source"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/","title":"GenericMarshallers - Misk","text":"//misk/misk.web.marshal/GenericMarshallers
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#genericmarshallers","title":"GenericMarshallers","text":"[jvm]\\ object GenericMarshallers
Handles generic marshalling, for cases where the action doesn\u2019t explicitly specify return content
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#types","title":"Types","text":"Name Summary FromByteString [jvm]class FromByteString(contentType: MediaType?) : Marshaller<ByteString> ToNothing [jvm]class ToNothing(contentType: MediaType?) : Marshaller<Nothing> ToUnit [jvm]class ToUnit(contentType: MediaType?) : Marshaller<Unit>"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#functions","title":"Functions","text":"Name Summary canHandle [jvm]fun canHandle(type: Type): Booleanfun canHandle(type: KType): Boolean from [jvm]fun from(contentType: MediaType?, returnType: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/can-handle/","title":"canHandle - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/canHandle
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/can-handle/#canhandle","title":"canHandle","text":"[jvm]\\ fun canHandle(type: KType): Boolean
fun canHandle(type: Type): Boolean
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/from/","title":"from - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/from
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/from/#from","title":"from","text":"[jvm]\\ fun from(contentType: MediaType?, returnType: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/","title":"FromByteString - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#frombytestring","title":"FromByteString","text":"[jvm]\\ class FromByteString(contentType: MediaType?) : Marshaller<ByteString>
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#constructors","title":"Constructors","text":"FromByteString [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: ByteString): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/-from-byte-string/","title":"FromByteString - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString/FromByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/-from-byte-string/#frombytestring","title":"FromByteString","text":"[jvm]\\ constructor(contentType: MediaType?)
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: ByteString): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/","title":"ToNothing - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#tonothing","title":"ToNothing","text":"[jvm]\\ class ToNothing(contentType: MediaType?) : Marshaller<Nothing>
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#constructors","title":"Constructors","text":"ToNothing [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: Nothing): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/-to-nothing/","title":"ToNothing - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing/ToNothing
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/-to-nothing/#tonothing","title":"ToNothing","text":"[jvm]\\ constructor(contentType: MediaType?)
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: Nothing): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/","title":"ToUnit - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#tounit","title":"ToUnit","text":"[jvm]\\ class ToUnit(contentType: MediaType?) : Marshaller<Unit>
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#constructors","title":"Constructors","text":"ToUnit [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: Unit): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/-to-unit/","title":"ToUnit - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit/ToUnit
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/-to-unit/#tounit","title":"ToUnit","text":"[jvm]\\ constructor(contentType: MediaType?)
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: Unit): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/","title":"GenericUnmarshallers - Misk","text":"//misk/misk.web.marshal/GenericUnmarshallers
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/#genericunmarshallers","title":"GenericUnmarshallers","text":"[jvm]\\ object GenericUnmarshallers
Handles generic unmarshalling, for cases where the action can accept anything
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/#functions","title":"Functions","text":"Name Summary canHandle [jvm]fun canHandle(type: Type): Booleanfun canHandle(type: KType): Boolean into [jvm]fun into(parameter: KParameter): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/can-handle/","title":"canHandle - Misk","text":"//misk/misk.web.marshal/GenericUnmarshallers/canHandle
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/can-handle/#canhandle","title":"canHandle","text":"[jvm]\\ fun canHandle(type: KType): Boolean
fun canHandle(type: Type): Boolean
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/into/","title":"into - Misk","text":"//misk/misk.web.marshal/GenericUnmarshallers/into
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/into/#into","title":"into","text":"[jvm]\\ fun into(parameter: KParameter): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/","title":"JsonMarshaller - Misk","text":"//misk/misk.web.marshal/JsonMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#jsonmarshaller","title":"JsonMarshaller","text":"[jvm]\\ class JsonMarshaller<T>(val adapter: JsonAdapter<T>) : Marshaller<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#constructors","title":"Constructors","text":"JsonMarshaller [jvm]constructor(adapter: JsonAdapter<T>)"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: JsonAdapter<T>"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-json-marshaller/","title":"JsonMarshaller - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/JsonMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-json-marshaller/#jsonmarshaller","title":"JsonMarshaller","text":"[jvm]\\ constructor(adapter: JsonAdapter<T>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: JsonAdapter<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: T): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : Marshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/moshi/","title":"moshi - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/Factory/moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/","title":"JsonUnmarshaller - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#jsonunmarshaller","title":"JsonUnmarshaller","text":"[jvm]\\ class JsonUnmarshaller(val adapter: JsonAdapter<Any>) : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#constructors","title":"Constructors","text":"JsonUnmarshaller [jvm]constructor(adapter: JsonAdapter<Any>)"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: JsonAdapter<Any>"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-json-unmarshaller/","title":"JsonUnmarshaller - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/JsonUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-json-unmarshaller/#jsonunmarshaller","title":"JsonUnmarshaller","text":"[jvm]\\ constructor(adapter: JsonAdapter<Any>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: JsonAdapter<Any>
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/moshi/","title":"moshi - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/Factory/moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/","title":"Marshaller - Misk","text":"//misk/misk.web.marshal/Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#marshaller","title":"Marshaller","text":"interface Marshaller<in T>
Marshalls typed kotlin objects into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#inheritors","title":"Inheritors","text":"FromByteString ToNothing ToUnit JsonMarshaller PlainTextMarshaller ProtobufMarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]abstract fun contentType(): MediaType? responseBody [jvm]abstract fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/Marshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ abstract fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/Marshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ abstract fun responseBody(o: T): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/","title":"Companion - Misk","text":"//misk/misk.web.marshal/Marshaller/Companion
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/#functions","title":"Functions","text":"Name Summary actualResponseType [jvm]fun actualResponseType(type: KType): Type"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/actual-response-type/","title":"actualResponseType - Misk","text":"//misk/misk.web.marshal/Marshaller/Companion/actualResponseType
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/actual-response-type/#actualresponsetype","title":"actualResponseType","text":"[jvm]\\ fun actualResponseType(type: KType): Type
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/Marshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/#factory","title":"Factory","text":"interface Factory
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<Marshaller.Factory>().to<MyFactory>()\n//misk/misk.web.marshal/Marshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/","title":"MultipartUnmarshaller - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#multipartunmarshaller","title":"MultipartUnmarshaller","text":"[jvm]\\ object MultipartUnmarshaller : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): MultipartReader"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): MultipartReader
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/moshi/","title":"moshi - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/Factory/moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/","title":"PlainTextMarshaller - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#plaintextmarshaller","title":"PlainTextMarshaller","text":"[jvm]\\ object PlainTextMarshaller : Marshaller<Any>
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: Any): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: Any): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor : Marshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/","title":"PlainTextUnmarshaller - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/#plaintextunmarshaller","title":"PlainTextUnmarshaller","text":"[jvm]\\ object PlainTextUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor : Unmarshaller.Factory ToByteString [jvm]object ToByteString : Unmarshaller ToString [jvm]object ToString : Unmarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory@Injectconstructor : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/","title":"ToByteString - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/#tobytestring","title":"ToByteString","text":"[jvm]\\ object ToByteString : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): ByteString"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToByteString/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): ByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/","title":"ToString - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToString
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/#tostring","title":"ToString","text":"[jvm]\\ object ToString : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): String"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToString/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): String
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/","title":"ProtobufMarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#protobufmarshaller","title":"ProtobufMarshaller","text":"[jvm]\\ class ProtobufMarshaller<T>(val adapter: ProtoAdapter<T>) : Marshaller<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#constructors","title":"Constructors","text":"ProtobufMarshaller [jvm]constructor(adapter: ProtoAdapter<T>)"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: ProtoAdapter<T>"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-protobuf-marshaller/","title":"ProtobufMarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/ProtobufMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-protobuf-marshaller/#protobufmarshaller","title":"ProtobufMarshaller","text":"[jvm]\\ constructor(adapter: ProtoAdapter<T>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: ProtoAdapter<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: T): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor : Marshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/","title":"ProtobufUnmarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#protobufunmarshaller","title":"ProtobufUnmarshaller","text":"[jvm]\\ class ProtobufUnmarshaller(val adapter: ProtoAdapter<Any>) : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#constructors","title":"Constructors","text":"ProtobufUnmarshaller [jvm]constructor(adapter: ProtoAdapter<Any>)"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: ProtoAdapter<Any>"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-protobuf-unmarshaller/","title":"ProtobufUnmarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/ProtobufUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-protobuf-unmarshaller/#protobufunmarshaller","title":"ProtobufUnmarshaller","text":"[jvm]\\ constructor(adapter: ProtoAdapter<Any>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: ProtoAdapter<Any>
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/","title":"Unmarshaller - Misk","text":"//misk/misk.web.marshal/Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#unmarshaller","title":"Unmarshaller","text":"interface Unmarshaller
Unmarshalls a typed object from an incoming source
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#inheritors","title":"Inheritors","text":"JsonUnmarshaller MultipartUnmarshaller ToString ToByteString ProtobufUnmarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]abstract fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/Unmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ abstract fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/Unmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/#factory","title":"Factory","text":"interface Factory
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<Unmarshaller.Factory>().to<MyFactory>()\n//misk/misk.web.marshal/Unmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.mdc/","title":"Package-level declarations - Misk","text":"//misk/misk.web.mdc
"},{"location":"0.x/misk/misk/misk.web.mdc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.mdc/#types","title":"Types","text":"Name Summary LogContextProvider [jvm]interface LogContextProvider"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/","title":"LogContextProvider - Misk","text":"//misk/misk.web.mdc/LogContextProvider
"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/#logcontextprovider","title":"LogContextProvider","text":"[jvm]\\ interface LogContextProvider
"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(request: HttpServletRequest): String?"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/get/","title":"get - Misk","text":"//misk/misk.web.mdc/LogContextProvider/get
"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/get/#get","title":"get","text":"[jvm]\\ abstract fun get(request: HttpServletRequest): String?
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/","title":"Package-level declarations - Misk","text":"//misk/misk.web.metadata.guice
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.metadata.guice/#types","title":"Types","text":"Name Summary GuiceMetadata [jvm]data class GuiceMetadata(val guice: GuiceMetadataProvider.Metadata) : Metadata GuiceMetadataProvider [jvm]class GuiceMetadataProvider@Injectconstructor : MetadataProvider<GuiceMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/","title":"GuiceMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#guicemetadata","title":"GuiceMetadata","text":"[jvm]\\ data class GuiceMetadata(val guice: GuiceMetadataProvider.Metadata) : Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#constructors","title":"Constructors","text":"GuiceMetadata [jvm]constructor(guice: GuiceMetadataProvider.Metadata)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String guice [jvm]val guice: GuiceMetadataProvider.Metadata metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/-guice-metadata/","title":"GuiceMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadata/GuiceMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/-guice-metadata/#guicemetadata","title":"GuiceMetadata","text":"[jvm]\\ constructor(guice: GuiceMetadataProvider.Metadata)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/guice/","title":"guice - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadata/guice
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/guice/#guice","title":"guice","text":"[jvm]\\ val guice: GuiceMetadataProvider.Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/","title":"GuiceMetadataProvider - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#guicemetadataprovider","title":"GuiceMetadataProvider","text":"[jvm]\\ class GuiceMetadataProvider@Injectconstructor : MetadataProvider<GuiceMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#constructors","title":"Constructors","text":"GuiceMetadataProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#types","title":"Types","text":"Name Summary BindingMetadata [jvm]data class BindingMetadata(val type: String, val source: String, val scope: String?, val provider: String, val annotation: String?) Metadata [jvm]data class Metadata(val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#properties","title":"Properties","text":"Name Summary allBindings [jvm]val allBindings: MutableMap<Key<>, Binding<>> id [jvm]open override val id: String injector [jvm]@Injectlateinit var injector: Injector"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): GuiceMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-guice-metadata-provider/","title":"GuiceMetadataProvider - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/GuiceMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-guice-metadata-provider/#guicemetadataprovider","title":"GuiceMetadataProvider","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/all-bindings/","title":"allBindings - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/allBindings
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/all-bindings/#allbindings","title":"allBindings","text":"[jvm]\\ val allBindings: MutableMap<Key<>, Binding<>>
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/get/","title":"get - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/get
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): GuiceMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/id/","title":"id - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/id
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/id/#id","title":"id","text":"[jvm]\\ open override val id: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/injector/","title":"injector - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/injector
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/injector/#injector","title":"injector","text":"[jvm]\\
@Inject
lateinit var injector: Injector
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/","title":"BindingMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#bindingmetadata","title":"BindingMetadata","text":"[jvm]\\ data class BindingMetadata(val type: String, val source: String, val scope: String?, val provider: String, val annotation: String?)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#constructors","title":"Constructors","text":"BindingMetadata [jvm]constructor(type: String, source: String, scope: String?, provider: String, annotation: String?)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#properties","title":"Properties","text":"Name Summary annotation [jvm]val annotation: String? provider [jvm]val provider: String scope [jvm]val scope: String? source [jvm]val source: String type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/-binding-metadata/","title":"BindingMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/BindingMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/-binding-metadata/#bindingmetadata","title":"BindingMetadata","text":"[jvm]\\ constructor(type: String, source: String, scope: String?, provider: String, annotation: String?)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/annotation/","title":"annotation - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/annotation
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/provider/","title":"provider - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/provider
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/provider/#provider","title":"provider","text":"[jvm]\\ val provider: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/scope/","title":"scope - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/scope
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/scope/#scope","title":"scope","text":"[jvm]\\ val scope: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/source/","title":"source - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/source
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/source/#source","title":"source","text":"[jvm]\\ val source: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/to-string/","title":"toString - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/toString
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type/","title":"type - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/type
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/","title":"Metadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#metadata","title":"Metadata","text":"[jvm]\\ data class Metadata(val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#constructors","title":"Constructors","text":"Metadata [jvm]constructor(bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#properties","title":"Properties","text":"Name Summary bindingMetadata [jvm]val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/-metadata/","title":"Metadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata/Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/-metadata/#metadata","title":"Metadata","text":"[jvm]\\ constructor(bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/binding-metadata/","title":"bindingMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata/bindingMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/binding-metadata/#bindingmetadata","title":"bindingMetadata","text":"[jvm]\\ val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/","title":"Package-level declarations - Misk","text":"//misk/misk.web.metadata.webaction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.metadata.webaction/#types","title":"Types","text":"Name Summary WebActionMetadata [jvm]data class WebActionMetadata(val name: String, val function: String, val packageName: String?, val description: String?, val functionAnnotations: List<String>, val requestMediaTypes: List<String>, val responseMediaType: String?, val parameterTypes: List<String>, val parameters: List<WebActionMetadata.ParameterMetaData>, val requestType: String?, val returnType: String, val responseType: String, val types: Map<String, MiskWebFormBuilder.Type>, val responseTypes: Map<String, MiskWebFormBuilder.Type>, val returnTypes: Map<String, MiskWebFormBuilder.Type>, val pathPattern: String, val applicationInterceptors: List<String>, val networkInterceptors: List<String>, val httpMethod: String, val allowedServices: Set<String>, val allowedCapabilities: Set<String>)Metadata front end model for Web Action Misk-Web Tab WebActionMetadataAction [jvm]@Singletonclass WebActionMetadataAction@Injectconstructor : WebAction WebActionsMetadata [jvm]data class WebActionsMetadata(val webActions: List<WebActionMetadata>) : Metadata WebActionsMetadataProvider [jvm]@Singletonclass WebActionsMetadataProvider : MetadataProvider<WebActionsMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/","title":"WebActionMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#webactionmetadata","title":"WebActionMetadata","text":"[jvm]\\ data class WebActionMetadata(val name: String, val function: String, val packageName: String?, val description: String?, val functionAnnotations: List<String>, val requestMediaTypes: List<String>, val responseMediaType: String?, val parameterTypes: List<String>, val parameters: List<WebActionMetadata.ParameterMetaData>, val requestType: String?, val returnType: String, val responseType: String, val types: Map<String, MiskWebFormBuilder.Type>, val responseTypes: Map<String, MiskWebFormBuilder.Type>, val returnTypes: Map<String, MiskWebFormBuilder.Type>, val pathPattern: String, val applicationInterceptors: List<String>, val networkInterceptors: List<String>, val httpMethod: String, val allowedServices: Set<String>, val allowedCapabilities: Set<String>)
Metadata front end model for Web Action Misk-Web Tab
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#constructors","title":"Constructors","text":"WebActionMetadata [jvm]constructor(name: String, function: KFunction<*>, functionAnnotations: List<Annotation>, description: String?, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameterTypes: List<KType>, parameters: List<KParameter>, requestType: KType?, returnType: KType, responseType: KType?, pathPattern: PathPattern, applicationInterceptors: List<ApplicationInterceptor>, networkInterceptors: List<NetworkInterceptor>, dispatchMechanism: DispatchMechanism, allowedServices: Set<String>, allowedCapabilities: Set<String>)constructor(name: String, function: String, packageName: String?, description: String?, functionAnnotations: List<String>, requestMediaTypes: List<String>, responseMediaType: String?, parameterTypes: List<String>, parameters: List<WebActionMetadata.ParameterMetaData>, requestType: String?, returnType: String, responseType: String, types: Map<String, MiskWebFormBuilder.Type>, responseTypes: Map<String, MiskWebFormBuilder.Type>, returnTypes: Map<String, MiskWebFormBuilder.Type>, pathPattern: String, applicationInterceptors: List<String>, networkInterceptors: List<String>, httpMethod: String, allowedServices: Set<String>, allowedCapabilities: Set<String>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#types","title":"Types","text":"Name Summary ParameterMetaData [jvm]data class ParameterMetaData(val name: String?, val annotations: List<String>, val type: String)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#properties","title":"Properties","text":"Name Summary allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String> applicationInterceptors [jvm]val applicationInterceptors: List<String> description [jvm]val description: String? function [jvm]val function: String functionAnnotations [jvm]val functionAnnotations: List<String> httpMethod [jvm]val httpMethod: String name [jvm]val name: String networkInterceptors [jvm]val networkInterceptors: List<String> packageName [jvm]val packageName: String? parameters [jvm]val parameters: List<WebActionMetadata.ParameterMetaData> parameterTypes [jvm]val parameterTypes: List<String> pathPattern [jvm]val pathPattern: String requestMediaTypes [jvm]val requestMediaTypes: List<String> requestType [jvm]val requestType: String? responseMediaType [jvm]val responseMediaType: String? responseType [jvm]val responseType: String responseTypes [jvm]val responseTypes: Map<String, MiskWebFormBuilder.Type> returnType [jvm]val returnType: String returnTypes [jvm]val returnTypes: Map<String, MiskWebFormBuilder.Type> types [jvm]val types: Map<String, MiskWebFormBuilder.Type>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-web-action-metadata/","title":"WebActionMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/WebActionMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-web-action-metadata/#webactionmetadata","title":"WebActionMetadata","text":"[jvm]\\ constructor(name: String, function: KFunction<*>, functionAnnotations: List<Annotation>, description: String?, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameterTypes: List<KType>, parameters: List<KParameter>, requestType: KType?, returnType: KType, responseType: KType?, pathPattern: PathPattern, applicationInterceptors: List<ApplicationInterceptor>, networkInterceptors: List<NetworkInterceptor>, dispatchMechanism: DispatchMechanism, allowedServices: Set<String>, allowedCapabilities: Set<String>)
constructor(name: String, function: String, packageName: String?, description: String?, functionAnnotations: List<String>, requestMediaTypes: List<String>, responseMediaType: String?, parameterTypes: List<String>, parameters: List<WebActionMetadata.ParameterMetaData>, requestType: String?, returnType: String, responseType: String, types: Map<String, MiskWebFormBuilder.Type>, responseTypes: Map<String, MiskWebFormBuilder.Type>, returnTypes: Map<String, MiskWebFormBuilder.Type>, pathPattern: String, applicationInterceptors: List<String>, networkInterceptors: List<String>, httpMethod: String, allowedServices: Set<String>, allowedCapabilities: Set<String>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/allowedCapabilities
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"[jvm]\\ val allowedCapabilities: Set<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-services/","title":"allowedServices - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/allowedServices
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-services/#allowedservices","title":"allowedServices","text":"[jvm]\\ val allowedServices: Set<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/application-interceptors/","title":"applicationInterceptors - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/applicationInterceptors
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/application-interceptors/#applicationinterceptors","title":"applicationInterceptors","text":"[jvm]\\ val applicationInterceptors: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/description/","title":"description - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/description
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/description/#description","title":"description","text":"[jvm]\\ val description: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function-annotations/","title":"functionAnnotations - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/functionAnnotations
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function-annotations/#functionannotations","title":"functionAnnotations","text":"[jvm]\\ val functionAnnotations: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function/","title":"function - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/function
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function/#function","title":"function","text":"[jvm]\\ val function: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/http-method/","title":"httpMethod - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/httpMethod
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/http-method/#httpmethod","title":"httpMethod","text":"[jvm]\\ val httpMethod: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/name/","title":"name - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/name
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/network-interceptors/","title":"networkInterceptors - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/networkInterceptors
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/network-interceptors/#networkinterceptors","title":"networkInterceptors","text":"[jvm]\\ val networkInterceptors: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/package-name/","title":"packageName - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/packageName
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/package-name/#packagename","title":"packageName","text":"[jvm]\\ val packageName: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameter-types/","title":"parameterTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/parameterTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameter-types/#parametertypes","title":"parameterTypes","text":"[jvm]\\ val parameterTypes: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameters/","title":"parameters - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/parameters
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameters/#parameters","title":"parameters","text":"[jvm]\\ val parameters: List<WebActionMetadata.ParameterMetaData>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/path-pattern/","title":"pathPattern - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/pathPattern
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-media-types/","title":"requestMediaTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/requestMediaTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-media-types/#requestmediatypes","title":"requestMediaTypes","text":"[jvm]\\ val requestMediaTypes: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-type/","title":"requestType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/requestType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-type/#requesttype","title":"requestType","text":"[jvm]\\ val requestType: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-media-type/","title":"responseMediaType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/responseMediaType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-media-type/#responsemediatype","title":"responseMediaType","text":"[jvm]\\ val responseMediaType: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-type/","title":"responseType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/responseType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-type/#responsetype","title":"responseType","text":"[jvm]\\ val responseType: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-types/","title":"responseTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/responseTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-types/#responsetypes","title":"responseTypes","text":"[jvm]\\ val responseTypes: Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-type/","title":"returnType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/returnType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-type/#returntype","title":"returnType","text":"[jvm]\\ val returnType: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-types/","title":"returnTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/returnTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-types/#returntypes","title":"returnTypes","text":"[jvm]\\ val returnTypes: Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/types/","title":"types - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/types
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/types/#types","title":"types","text":"[jvm]\\ val types: Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/","title":"ParameterMetaData - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#parametermetadata","title":"ParameterMetaData","text":"[jvm]\\ data class ParameterMetaData(val name: String?, val annotations: List<String>, val type: String)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#constructors","title":"Constructors","text":"ParameterMetaData [jvm]constructor(name: String?, annotations: List<String>, type: String)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#properties","title":"Properties","text":"Name Summary annotations [jvm]val annotations: List<String> name [jvm]val name: String? type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/-parameter-meta-data/","title":"ParameterMetaData - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/ParameterMetaData
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/-parameter-meta-data/#parametermetadata","title":"ParameterMetaData","text":"[jvm]\\ constructor(name: String?, annotations: List<String>, type: String)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/annotations/","title":"annotations - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/annotations
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/annotations/#annotations","title":"annotations","text":"[jvm]\\ val annotations: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/name/","title":"name - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/name
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/name/#name","title":"name","text":"[jvm]\\ val name: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/type/","title":"type - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/type
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/","title":"WebActionMetadataAction - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#webactionmetadataaction","title":"WebActionMetadataAction","text":"[jvm]\\ @Singleton
class WebActionMetadataAction@Injectconstructor : WebAction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#constructors","title":"Constructors","text":"WebActionMetadataAction [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#types","title":"Types","text":"Name Summary Response [jvm]data class Response(val webActionMetadata: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain getAll [jvm]fun getAll(): WebActionMetadataAction.Response"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-web-action-metadata-action/","title":"WebActionMetadataAction - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/WebActionMetadataAction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-web-action-metadata-action/#webactionmetadataaction","title":"WebActionMetadataAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/get-all/","title":"getAll - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/getAll
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(): WebActionMetadataAction.Response
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/","title":"Response - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val webActionMetadata: List<WebActionMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(webActionMetadata: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#properties","title":"Properties","text":"Name Summary webActionMetadata [jvm]val webActionMetadata: List<WebActionMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response/Response
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(webActionMetadata: List<WebActionMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/web-action-metadata/","title":"webActionMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response/webActionMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/web-action-metadata/#webactionmetadata","title":"webActionMetadata","text":"[jvm]\\ val webActionMetadata: List<WebActionMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/","title":"WebActionsMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#webactionsmetadata","title":"WebActionsMetadata","text":"[jvm]\\ data class WebActionsMetadata(val webActions: List<WebActionMetadata>) : Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#constructors","title":"Constructors","text":"WebActionsMetadata [jvm]constructor(webActions: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String webActions [jvm]val webActions: List<WebActionMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open override fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/-web-actions-metadata/","title":"WebActionsMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata/WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/-web-actions-metadata/#webactionsmetadata","title":"WebActionsMetadata","text":"[jvm]\\ constructor(webActions: List<WebActionMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/description-block/","title":"descriptionBlock - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata/descriptionBlock
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/description-block/#descriptionblock","title":"descriptionBlock","text":"[jvm]\\ open override fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/web-actions/","title":"webActions - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata/webActions
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/web-actions/#webactions","title":"webActions","text":"[jvm]\\ val webActions: List<WebActionMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/","title":"WebActionsMetadataProvider - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#webactionsmetadataprovider","title":"WebActionsMetadataProvider","text":"[jvm]\\ @Singleton
class WebActionsMetadataProvider : MetadataProvider<WebActionsMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#constructors","title":"Constructors","text":"WebActionsMetadataProvider [jvm]constructor()"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: String metadata [jvm]val metadata: WebActionsMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): WebActionsMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/-web-actions-metadata-provider/","title":"WebActionsMetadataProvider - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/WebActionsMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/-web-actions-metadata-provider/#webactionsmetadataprovider","title":"WebActionsMetadataProvider","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/get/","title":"get - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/get
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/id/","title":"id - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/id
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/id/#id","title":"id","text":"[jvm]\\ open override val id: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/metadata/","title":"metadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/metadata/#metadata","title":"metadata","text":"[jvm]\\ val metadata: WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.proxy/","title":"Package-level declarations - Misk","text":"//misk/misk.web.proxy
"},{"location":"0.x/misk/misk/misk.web.proxy/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.proxy/#types","title":"Types","text":"Name Summary OptionalBinder [jvm]@Singletonclass OptionalBinder@Injectconstructorhttps://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor WebProxyAction [jvm]@Singletonclass WebProxyAction@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder) : WebActionWebProxyAction WebProxyEntry [jvm]data class WebProxyEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", val web_proxy_url: HttpUrl) : ValidWebEntryMaps URLs requested against this server to URLs of servers to delegate to"},{"location":"0.x/misk/misk/misk.web.proxy/#functions","title":"Functions","text":"Name Summary WebProxyEntry [jvm]fun WebProxyEntry(url_path_prefix: String = \"/\", web_proxy_url: String): WebProxyEntry"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"//misk/misk.web.proxy/WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"[jvm]\\ fun WebProxyEntry(url_path_prefix: String = \"/\", web_proxy_url: String): WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk/misk.web.proxy/OptionalBinder
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\ @Singleton
class OptionalBinder@Injectconstructor
https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#constructors","title":"Constructors","text":"OptionalBinder [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#properties","title":"Properties","text":"Name Summary proxyClient [jvm]@Inject(optional = true)@Named(value = \"web_proxy_action\")var proxyClient: OkHttpClient"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk/misk.web.proxy/OptionalBinder/OptionalBinder
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/proxy-client/","title":"proxyClient - Misk","text":"//misk/misk.web.proxy/OptionalBinder/proxyClient
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/proxy-client/#proxyclient","title":"proxyClient","text":"[jvm]\\
@Inject(optional = true)
@Named(value = \"web_proxy_action\")
var proxyClient: OkHttpClient
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/","title":"WebProxyAction - Misk","text":"//misk/misk.web.proxy/WebProxyAction
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/#webproxyaction","title":"WebProxyAction","text":"[jvm]\\ @Singleton
class WebProxyAction@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder) : WebAction
WebProxyAction
Guidelines
/_admin/config/, /_admin/config/subtab/ Request: /_admin/config/subtab/app.js will resolve to the /_admin/config/subtab/ entryExpected Functionality
//misk/misk.web.proxy/WebProxyAction/WebProxyAction
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/-web-proxy-action/#webproxyaction","title":"WebProxyAction","text":"[jvm]\\
@Inject
constructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder)
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/action/","title":"action - Misk","text":"//misk/misk.web.proxy/WebProxyAction/action
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/action/#action","title":"action","text":"[jvm]\\ fun action(): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"//misk/misk.web.proxy/WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"[jvm]\\ data class WebProxyEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", val web_proxy_url: HttpUrl) : ValidWebEntry
Maps URLs requested against this server to URLs of servers to delegate to
url_path_prefix: /_admin/ web_proxy_url: http://localhost:3000/
An incoming request then for /_admin/config.js would route to http://localhost:3000/_admin/config.js.
This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<WebProxyEntry>().toInstance(WebProxyEntry(...))\n//misk/misk.web.proxy/WebProxyEntry/WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"[jvm]\\
@JvmOverloads
constructor(url_path_prefix: String = \"/\", web_proxy_url: HttpUrl)
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk/misk.web.proxy/WebProxyEntry/url_path_prefix
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/web_proxy_url/","title":"web_proxy_url - Misk","text":"//misk/misk.web.proxy/WebProxyEntry/web_proxy_url
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/web_proxy_url/#web_proxy_url","title":"web_proxy_url","text":"[jvm]\\ val web_proxy_url: HttpUrl
"},{"location":"0.x/misk/misk/misk.web.resources/","title":"Package-level declarations - Misk","text":"//misk/misk.web.resources
"},{"location":"0.x/misk/misk/misk.web.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.resources/#types","title":"Types","text":"Name Summary ResourceEntryFinder [jvm]class ResourceEntryFinder@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>) StaticResourceAction [jvm]@Singletonclass StaticResourceAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder) : WebActionStaticResourceAction StaticResourceEntry [jvm]data class StaticResourceEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", resourcePath: String) : ValidWebEntryThis data class is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/","title":"ResourceEntryFinder - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#resourceentryfinder","title":"ResourceEntryFinder","text":"[jvm]\\ class ResourceEntryFinder@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#constructors","title":"Constructors","text":"ResourceEntryFinder [jvm]@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#functions","title":"Functions","text":"Name Summary staticResource [jvm]fun staticResource(url: HttpUrl): ValidWebEntry? webProxy [jvm]fun webProxy(url: HttpUrl): ValidWebEntry?"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/-resource-entry-finder/","title":"ResourceEntryFinder - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder/ResourceEntryFinder
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/-resource-entry-finder/#resourceentryfinder","title":"ResourceEntryFinder","text":"[jvm]\\
@Inject
constructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/","title":"staticResource - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder/staticResource
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/#staticresource","title":"staticResource","text":"[jvm]\\ fun staticResource(url: HttpUrl): ValidWebEntry?
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/#return","title":"Return","text":"entry whose url_path_prefix most closely matches given url; longest match wins
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/","title":"webProxy - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder/webProxy
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/#webproxy","title":"webProxy","text":"[jvm]\\ fun webProxy(url: HttpUrl): ValidWebEntry?
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/#return","title":"Return","text":"entry whose url_path_prefix most closely matches given url; longest match wins
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/","title":"StaticResourceAction - Misk","text":"//misk/misk.web.resources/StaticResourceAction
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/#staticresourceaction","title":"StaticResourceAction","text":"[jvm]\\ @Singleton
class StaticResourceAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder) : WebAction
StaticResourceAction
This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<StaticResourceEntry>()\n .toInstance(\n StaticResourceEntry(\n url_path_prefix = \"/static/\",\n resourcePath = \"classpath:/web/static/\"\n )\n )\ninstall(WebActionModule.createWithPrefix<StaticResourceAction>(url_path_prefix = \"/static/\"))\n//misk/misk.web.resources/StaticResourceAction/StaticResourceAction
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/-static-resource-action/#staticresourceaction","title":"StaticResourceAction","text":"[jvm]\\
@Inject
constructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder)
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/action/","title":"action - Misk","text":"//misk/misk.web.resources/StaticResourceAction/action
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/action/#action","title":"action","text":"[jvm]\\ fun action(): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/get-response/","title":"getResponse - Misk","text":"//misk/misk.web.resources/StaticResourceAction/getResponse
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/get-response/#getresponse","title":"getResponse","text":"[jvm]\\ fun getResponse(httpCall: HttpCall): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/","title":"StaticResourceEntry - Misk","text":"//misk/misk.web.resources/StaticResourceEntry
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/#staticresourceentry","title":"StaticResourceEntry","text":"[jvm]\\ data class StaticResourceEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", resourcePath: String) : ValidWebEntry
This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<StaticResourceEntry>().toInstance(StaticResourceEntry(...))\n//misk/misk.web.resources/StaticResourceEntry/StaticResourceEntry
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/-static-resource-entry/#staticresourceentry","title":"StaticResourceEntry","text":"[jvm]\\
@JvmOverloads
constructor(url_path_prefix: String = \"/\", resourcePath: String)
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/resource-path/","title":"resourcePath - Misk","text":"//misk/misk.web.resources/StaticResourceEntry/resourcePath
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/resource-path/#resourcepath","title":"resourcePath","text":"[jvm]\\ fun resourcePath(urlPath: String): String
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk/misk.web.resources/StaticResourceEntry/url_path_prefix
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-action-scopes/","title":"misk-action-scopes - Misk","text":"//misk-action-scopes
"},{"location":"0.x/misk-action-scopes/#misk-action-scopes","title":"misk-action-scopes","text":""},{"location":"0.x/misk-action-scopes/#packages","title":"Packages","text":"Name misk.concurrent misk.scope misk.scope.executor"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk-action-scopes/misk.concurrent
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/#types","title":"Types","text":"Name Summary WrappingListeningExecutorService [jvm]abstract class WrappingListeningExecutorService : ForwardingListeningExecutorServiceListeningExecutorService which wraps all calls"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"abstract class WrappingListeningExecutorService : ForwardingListeningExecutorService
ListeningExecutorService which wraps all calls
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#inheritors","title":"Inheritors","text":"ActionScopedExecutorService"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#constructors","title":"Constructors","text":"WrappingListeningExecutorService [jvm]constructor()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/WrappingListeningExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/execute/","title":"execute - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/execute
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(runnable: Runnable)
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-all/","title":"invokeAll - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/invokeAll
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-all/#invokeall","title":"invokeAll","text":"[jvm]\\ open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>
open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>>
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-any/","title":"invokeAny - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/invokeAny
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-any/#invokeany","title":"invokeAny","text":"[jvm]\\ open override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Any
open override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/submit/","title":"submit - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/submit
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/submit/#submit","title":"submit","text":"[jvm]\\ open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>
open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T>
open override fun submit(runnable: Runnable): ListenableFuture<*>
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/","title":"Package-level declarations - Misk","text":"//misk-action-scopes/misk.scope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/#types","title":"Types","text":"Name Summary ActionScope [jvm]@Singletonclass ActionScope : AutoCloseable ActionScopedProviderModule [jvm]abstract class ActionScopedProviderModule : KAbstractModuleModule used by components and applications to provide ActionScoped context objects SeedDataTransformer [jvm]interface SeedDataTransformerWhile executing, actions have ActionScoped values that can be injected by anything running within the action."},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/","title":"ActionScope - Misk","text":"//misk-action-scopes/misk.scope/ActionScope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#actionscope","title":"ActionScope","text":"[jvm]\\ @Singleton
class ActionScope : AutoCloseable
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Instance [jvm]class Instance : AutoCloseable"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#functions","title":"Functions","text":"Name Summary asContextElement [jvm]fun asContextElement(): CoroutineContext.ElementConverts the action scope into a CoroutineContext.Element to maintain the given ActionScope context for coroutines regardless of the actual thread they run on. close [jvm]open override fun close() create [jvm]fun create(seedData: Map<Key<*>, Any?>): ActionScope.InstanceCreates a new scope on the current thread with the provided seed data get [jvm]fun <T> get(key: Key<T>): TReturns the action scoped value for the given key inScope [jvm]fun inScope(): BooleanReturns true if currently in the scope propagate [jvm]fun <T> propagate(c: Callable<T>): Callable<T>Wraps a Callable that will be called on another thread, propagating the current scoped data onto that thread[jvm]fun <T> propagate(f: () -> T): () -> TWraps a function or lambda that will be called on another thread, propagating the current scoped data onto that thread[jvm]fun <T> propagate(f: KFunction<T>): KFunction<T>Wraps a KFunction that will be called on another thread, propagating the current scoped data onto that thread runBlocking [jvm]fun <T> runBlocking(block: suspend CoroutineScope.() -> T): Tfun <T> runBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> T): TWraps a kotlinx.coroutines.runBlocking to propagate the current action scope. snapshotActionScopeInstance [jvm]fun snapshotActionScopeInstance(): ActionScope.Instance"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/as-context-element/","title":"asContextElement - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/asContextElement
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/as-context-element/#ascontextelement","title":"asContextElement","text":"[jvm]\\ fun asContextElement(): CoroutineContext.Element
Converts the action scope into a CoroutineContext.Element to maintain the given ActionScope context for coroutines regardless of the actual thread they run on.
Example usage:
scope.enter(seedData).use {\n runBlocking(scope.asContextElement()) {\n async(Dispatchers.IO) {\n tester.fooValue()\n }.await()\n }\n}\n//misk-action-scopes/misk.scope/ActionScope/close
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/close/#close","title":"close","text":"[jvm]\\ open override fun close()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/create/","title":"create - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/create
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/create/#create","title":"create","text":"[jvm]\\ fun create(seedData: Map<Key<*>, Any?>): ActionScope.Instance
Creates a new scope on the current thread with the provided seed data
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/get/","title":"get - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/get
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/get/#get","title":"get","text":"[jvm]\\ fun <T> get(key: Key<T>): T
Returns the action scoped value for the given key
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/in-scope/","title":"inScope - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/inScope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/in-scope/#inscope","title":"inScope","text":"[jvm]\\ fun inScope(): Boolean
Returns true if currently in the scope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/propagate/","title":"propagate - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/propagate
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/propagate/#propagate","title":"propagate","text":"[jvm]\\ fun <T> propagate(c: Callable<T>): Callable<T>
Wraps a Callable that will be called on another thread, propagating the current scoped data onto that thread
[jvm]\\ fun <T> propagate(f: KFunction<T>): KFunction<T>
Wraps a KFunction that will be called on another thread, propagating the current scoped data onto that thread
[jvm]\\ fun <T> propagate(f: () -> T): () -> T
Wraps a function or lambda that will be called on another thread, propagating the current scoped data onto that thread
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/run-blocking/","title":"runBlocking - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/runBlocking
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/run-blocking/#runblocking","title":"runBlocking","text":"[jvm]\\ fun <T> runBlocking(block: suspend CoroutineScope.() -> T): T
fun <T> runBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> T): T
Wraps a kotlinx.coroutines.runBlocking to propagate the current action scope.
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/snapshot-action-scope-instance/","title":"snapshotActionScopeInstance - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/snapshotActionScopeInstance
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/snapshot-action-scope-instance/#snapshotactionscopeinstance","title":"snapshotActionScopeInstance","text":"[jvm]\\ fun snapshotActionScopeInstance(): ActionScope.Instance
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-companion/","title":"Companion - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/","title":"Instance - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Instance
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/#instance","title":"Instance","text":"[jvm]\\ class Instance : AutoCloseable
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/#functions","title":"Functions","text":"Name Summary close [jvm]open override fun close() enter [jvm]fun enter() inScope [jvm]fun <T> inScope(block: () -> T): T"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/enter/","title":"enter - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Instance/enter
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/enter/#enter","title":"enter","text":"[jvm]\\ fun enter()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/in-scope/","title":"inScope - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Instance/inScope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/in-scope/#inscope","title":"inScope","text":"[jvm]\\ fun <T> inScope(block: () -> T): T
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/","title":"ActionScopedProviderModule - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#actionscopedprovidermodule","title":"ActionScopedProviderModule","text":"[jvm]\\ abstract class ActionScopedProviderModule : KAbstractModule
Module used by components and applications to provide ActionScoped context objects
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#constructors","title":"Constructors","text":"ActionScopedProviderModule [jvm]constructor()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#functions","title":"Functions","text":"Name Summary bindConstant [jvm]@JvmOverloadsfun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation? = null)@JvmOverloadsfun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation? = null)Binds a provider that returns a constant value on every invocation. bindProvider [jvm]fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)@JvmOverloadsfun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)@JvmOverloadsfun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)Binds an annotation qualified ActionScoped along with its provider bindSeedData [jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>)fun <T : Any> bindSeedData(kclass: KClass<T>)Binds an ActionScoped which only pulls from data seeded at the scope entry[jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>)Binds an annotation qualified ActionScoped which only pulls from data seeded at the scope entry configure [jvm]override fun configure(builder: Binder) configureProviders [jvm]abstract fun configureProviders()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-action-scoped-provider-module/","title":"ActionScopedProviderModule - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/ActionScopedProviderModule
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-action-scoped-provider-module/#actionscopedprovidermodule","title":"ActionScopedProviderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-constant/","title":"bindConstant - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindConstant
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-constant/#bindconstant","title":"bindConstant","text":"[jvm]\\
@JvmOverloads
fun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation? = null)
@JvmOverloads
fun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation? = null)
Binds a provider that returns a constant value on every invocation.
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-provider/","title":"bindProvider - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindProvider
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-provider/#bindprovider","title":"bindProvider","text":"[jvm]\\
@JvmOverloads
fun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)
@JvmOverloads
fun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)
fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)
fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)
Binds an annotation qualified ActionScoped along with its provider
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-seed-data/","title":"bindSeedData - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindSeedData
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-seed-data/#bindseeddata","title":"bindSeedData","text":"[jvm]\\ fun <T : Any> bindSeedData(kclass: KClass<T>)
fun <T : Any> bindSeedData(type: TypeLiteral<T>)
Binds an ActionScoped which only pulls from data seeded at the scope entry
[jvm]\\ fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)
fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)
fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>)
Binds an annotation qualified ActionScoped which only pulls from data seeded at the scope entry
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/configure-providers/","title":"configureProviders - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/configureProviders
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/configure-providers/#configureproviders","title":"configureProviders","text":"[jvm]\\ abstract fun configureProviders()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-companion/","title":"Companion - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/","title":"SeedDataTransformer - Misk","text":"//misk-action-scopes/misk.scope/SeedDataTransformer
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/#seeddatatransformer","title":"SeedDataTransformer","text":"[jvm]\\ interface SeedDataTransformer
While executing, actions have ActionScoped values that can be injected by anything running within the action.
For example, these values are seeded by default for web actions:
HttpCallHttpServletRequestThese types are the initial keys in the seedData map; they map to the corresponding instances. Implementations of this interface may modify this map.
To add new seed data keys, you must also subclass ActionScopedProviderModule and call ActionScopedProviderModule.bindSeedData. This makes the seed data type injectable by Guice.
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/#functions","title":"Functions","text":"Name Summary transform [jvm]abstract fun transform(seedData: Map<Key<>, Any?>): Map<Key<>, Any?>"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/transform/","title":"transform - Misk","text":"//misk-action-scopes/misk.scope/SeedDataTransformer/transform
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/transform/#transform","title":"transform","text":"[jvm]\\ abstract fun transform(seedData: Map<Key<>, Any?>): Map<Key<>, Any?>
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/","title":"Package-level declarations - Misk","text":"//misk-action-scopes/misk.scope.executor
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/#types","title":"Types","text":"Name Summary ActionScopedExecutorService [jvm]class ActionScopedExecutorService(target: ExecutorService, scope: ActionScope) : WrappingListeningExecutorServiceWraps a ListeningExecutorService to propagate the current action scope to any tasks submitted by the current thread"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/","title":"ActionScopedExecutorService - Misk","text":"//misk-action-scopes/misk.scope.executor/ActionScopedExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#actionscopedexecutorservice","title":"ActionScopedExecutorService","text":"[jvm]\\ class ActionScopedExecutorService(target: ExecutorService, scope: ActionScope) : WrappingListeningExecutorService
Wraps a ListeningExecutorService to propagate the current action scope to any tasks submitted by the current thread
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#constructors","title":"Constructors","text":"ActionScopedExecutorService [jvm]constructor(target: ExecutorService, scope: ActionScope)"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/-action-scoped-executor-service/","title":"ActionScopedExecutorService - Misk","text":"//misk-action-scopes/misk.scope.executor/ActionScopedExecutorService/ActionScopedExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/-action-scoped-executor-service/#actionscopedexecutorservice","title":"ActionScopedExecutorService","text":"[jvm]\\ constructor(target: ExecutorService, scope: ActionScope)
"},{"location":"0.x/misk-actions/","title":"misk-actions - Misk","text":"//misk-actions
"},{"location":"0.x/misk-actions/#misk-actions","title":"misk-actions","text":""},{"location":"0.x/misk-actions/#packages","title":"Packages","text":"Name misk misk.exceptions misk.security.authz misk.web misk.web.actions misk.web.dashboard misk.web.interceptors"},{"location":"0.x/misk-actions/misk-actions/misk/","title":"Package-level declarations - Misk","text":"//misk-actions/misk
"},{"location":"0.x/misk-actions/misk-actions/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk/#types","title":"Types","text":"Name Summary MiskCaller [jvm]data class MiskCaller@JvmOverloadsconstructor(val service: String? = null, val user: String? = null, val capabilities: Set<String> = setOf())Information about the authenticated caller of a given action"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/","title":"MiskCaller - Misk","text":"//misk-actions/misk/MiskCaller
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#miskcaller","title":"MiskCaller","text":"[jvm]\\ data class MiskCaller@JvmOverloadsconstructor(val service: String? = null, val user: String? = null, val capabilities: Set<String> = setOf())
Information about the authenticated caller of a given action
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#constructors","title":"Constructors","text":"MiskCaller [jvm]@JvmOverloadsconstructor(service: String? = null, user: String? = null, capabilities: Set<String> = setOf())"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#properties","title":"Properties","text":"Name Summary capabilities [jvm]val capabilities: Set<String>Set of capabilities given to a human user, typically provided by the SSO infrastructure principal [jvm]val principal: StringThe identity of the calling principal, regardless of whether they are a service or a user service [jvm]val service: String? = nullPresent if the caller is an authenticated peer service user [jvm]val user: String? = nullPresent if the caller is a human user, typically from an SSO proxy"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#functions","title":"Functions","text":"Name Summary hasCapability [jvm]fun hasCapability(allowedCapabilities: Set<String>): BooleanCheck whether the caller has one of allowedCapabilities. isService [jvm]fun isService(allowedServices: Set<String>): BooleanCheck whether this is a service-to-service call from one of allowedServices. toString [jvm]open override fun toString(): StringWe don\u2019t like to log usernames."},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/-misk-caller/","title":"MiskCaller - Misk","text":"//misk-actions/misk/MiskCaller/MiskCaller
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/-misk-caller/#miskcaller","title":"MiskCaller","text":"[jvm]\\
@JvmOverloads
constructor(service: String? = null, user: String? = null, capabilities: Set<String> = setOf())
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/capabilities/","title":"capabilities - Misk","text":"//misk-actions/misk/MiskCaller/capabilities
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Set<String>
Set of capabilities given to a human user, typically provided by the SSO infrastructure
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/has-capability/","title":"hasCapability - Misk","text":"//misk-actions/misk/MiskCaller/hasCapability
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/has-capability/#hascapability","title":"hasCapability","text":"[jvm]\\ fun hasCapability(allowedCapabilities: Set<String>): Boolean
Check whether the caller has one of allowedCapabilities.
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/is-service/","title":"isService - Misk","text":"//misk-actions/misk/MiskCaller/isService
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/is-service/#isservice","title":"isService","text":"[jvm]\\ fun isService(allowedServices: Set<String>): Boolean
Check whether this is a service-to-service call from one of allowedServices.
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/principal/","title":"principal - Misk","text":"//misk-actions/misk/MiskCaller/principal
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/principal/#principal","title":"principal","text":"[jvm]\\ val principal: String
The identity of the calling principal, regardless of whether they are a service or a user
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/service/","title":"service - Misk","text":"//misk-actions/misk/MiskCaller/service
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/service/#service","title":"service","text":"[jvm]\\ val service: String? = null
Present if the caller is an authenticated peer service
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/to-string/","title":"toString - Misk","text":"//misk-actions/misk/MiskCaller/toString
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
We don\u2019t like to log usernames.
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/user/","title":"user - Misk","text":"//misk-actions/misk/MiskCaller/user
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/user/#user","title":"user","text":"[jvm]\\ val user: String? = null
Present if the caller is a human user, typically from an SSO proxy
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.exceptions
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#types","title":"Types","text":"Name Summary BadGatewayException [jvm]open class BadGatewayException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a server is acting as a gateway and gets invalid response from upstream. The message is not exposed to the caller. BadRequestException [jvm]open class BadRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for bad client requests ClientClosedRequestException [jvm]open class ClientClosedRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. ConflictException [jvm]open class ConflictException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a request causes a conflict GatewayTimeoutException [jvm]open class GatewayTimeoutException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a server is acting as a gateway and cannot get a response in time. The message is not exposed to the caller. NotFoundException [jvm]open class NotFoundException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when resources are not found PayloadTooLargeException [jvm]open class PayloadTooLargeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException ResourceUnavailableException [jvm]open class ResourceUnavailableException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a resource is unavailable. The message is not exposed to the caller. TooManyRequestsException [jvm]open class TooManyRequestsException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. UnauthenticatedException [jvm]open class UnauthenticatedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when authentication fails UnauthorizedException [jvm]open class UnauthorizedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when authenticated credentials lack access to a resource UnprocessableEntityException [jvm]open class UnprocessableEntityException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. UnsupportedMediaTypeException [jvm]open class UnsupportedMediaTypeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException WebActionException [jvm]open class WebActionException(val code: Int, val responseBody: String, message: String, cause: Throwable? = null, val grpcStatus: GrpcStatus? = null, val details: List<AnyMessage> = listOf()) : RuntimeExceptionEven though all kotlin exceptions are runtime exceptions. To ensure java inter-op all exception need to extend from RuntimeException."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#functions","title":"Functions","text":"Name Summary requireRequest [jvm]inline fun requireRequest(check: Boolean, lazyMessage: () -> String)Similar to kotlin.require, but throws BadRequestException if the check fails requireRequestNotNull [jvm]inline fun <T : Any> requireRequestNotNull(value: T?, lazyMessage: () -> String): TSimilar to kotlin.requireNotNull, but throws BadRequestException if the check fails"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request-not-null/","title":"requireRequestNotNull - Misk","text":"//misk-actions/misk.exceptions/requireRequestNotNull
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request-not-null/#requirerequestnotnull","title":"requireRequestNotNull","text":"[jvm]\\ inline fun <T : Any> requireRequestNotNull(value: T?, lazyMessage: () -> String): T
Similar to kotlin.requireNotNull, but throws BadRequestException if the check fails
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request/","title":"requireRequest - Misk","text":"//misk-actions/misk.exceptions/requireRequest
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request/#requirerequest","title":"requireRequest","text":"[jvm]\\ inline fun requireRequest(check: Boolean, lazyMessage: () -> String)
Similar to kotlin.require, but throws BadRequestException if the check fails
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/","title":"BadGatewayException - Misk","text":"//misk-actions/misk.exceptions/BadGatewayException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#badgatewayexception","title":"BadGatewayException","text":"[jvm]\\ open class BadGatewayException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a server is acting as a gateway and gets invalid response from upstream. The message is not exposed to the caller.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#constructors","title":"Constructors","text":"BadGatewayException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/-bad-gateway-exception/","title":"BadGatewayException - Misk","text":"//misk-actions/misk.exceptions/BadGatewayException/BadGatewayException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/-bad-gateway-exception/#badgatewayexception","title":"BadGatewayException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/","title":"BadRequestException - Misk","text":"//misk-actions/misk.exceptions/BadRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#badrequestexception","title":"BadRequestException","text":"[jvm]\\ open class BadRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for bad client requests
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#constructors","title":"Constructors","text":"BadRequestException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/-bad-request-exception/","title":"BadRequestException - Misk","text":"//misk-actions/misk.exceptions/BadRequestException/BadRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/-bad-request-exception/#badrequestexception","title":"BadRequestException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/","title":"ClientClosedRequestException - Misk","text":"//misk-actions/misk.exceptions/ClientClosedRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#clientclosedrequestexception","title":"ClientClosedRequestException","text":"[jvm]\\ open class ClientClosedRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
This exception is custom to Misk.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#constructors","title":"Constructors","text":"ClientClosedRequestException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/-client-closed-request-exception/","title":"ClientClosedRequestException - Misk","text":"//misk-actions/misk.exceptions/ClientClosedRequestException/ClientClosedRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/-client-closed-request-exception/#clientclosedrequestexception","title":"ClientClosedRequestException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/","title":"ConflictException - Misk","text":"//misk-actions/misk.exceptions/ConflictException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#conflictexception","title":"ConflictException","text":"[jvm]\\ open class ConflictException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a request causes a conflict
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#constructors","title":"Constructors","text":"ConflictException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/-conflict-exception/","title":"ConflictException - Misk","text":"//misk-actions/misk.exceptions/ConflictException/ConflictException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/-conflict-exception/#conflictexception","title":"ConflictException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/","title":"GatewayTimeoutException - Misk","text":"//misk-actions/misk.exceptions/GatewayTimeoutException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#gatewaytimeoutexception","title":"GatewayTimeoutException","text":"[jvm]\\ open class GatewayTimeoutException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a server is acting as a gateway and cannot get a response in time. The message is not exposed to the caller.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#constructors","title":"Constructors","text":"GatewayTimeoutException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/-gateway-timeout-exception/","title":"GatewayTimeoutException - Misk","text":"//misk-actions/misk.exceptions/GatewayTimeoutException/GatewayTimeoutException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/-gateway-timeout-exception/#gatewaytimeoutexception","title":"GatewayTimeoutException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/","title":"NotFoundException - Misk","text":"//misk-actions/misk.exceptions/NotFoundException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#notfoundexception","title":"NotFoundException","text":"[jvm]\\ open class NotFoundException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when resources are not found
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#constructors","title":"Constructors","text":"NotFoundException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/-not-found-exception/","title":"NotFoundException - Misk","text":"//misk-actions/misk.exceptions/NotFoundException/NotFoundException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/-not-found-exception/#notfoundexception","title":"NotFoundException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/","title":"PayloadTooLargeException - Misk","text":"//misk-actions/misk.exceptions/PayloadTooLargeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#payloadtoolargeexception","title":"PayloadTooLargeException","text":"[jvm]\\ open class PayloadTooLargeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#constructors","title":"Constructors","text":"PayloadTooLargeException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/-payload-too-large-exception/","title":"PayloadTooLargeException - Misk","text":"//misk-actions/misk.exceptions/PayloadTooLargeException/PayloadTooLargeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/-payload-too-large-exception/#payloadtoolargeexception","title":"PayloadTooLargeException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/","title":"ResourceUnavailableException - Misk","text":"//misk-actions/misk.exceptions/ResourceUnavailableException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#resourceunavailableexception","title":"ResourceUnavailableException","text":"[jvm]\\ open class ResourceUnavailableException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a resource is unavailable. The message is not exposed to the caller.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#constructors","title":"Constructors","text":"ResourceUnavailableException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/-resource-unavailable-exception/","title":"ResourceUnavailableException - Misk","text":"//misk-actions/misk.exceptions/ResourceUnavailableException/ResourceUnavailableException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/-resource-unavailable-exception/#resourceunavailableexception","title":"ResourceUnavailableException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/","title":"TooManyRequestsException - Misk","text":"//misk-actions/misk.exceptions/TooManyRequestsException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#toomanyrequestsexception","title":"TooManyRequestsException","text":"[jvm]\\ open class TooManyRequestsException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
This exception is custom to Misk.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#constructors","title":"Constructors","text":"TooManyRequestsException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/-too-many-requests-exception/","title":"TooManyRequestsException - Misk","text":"//misk-actions/misk.exceptions/TooManyRequestsException/TooManyRequestsException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/-too-many-requests-exception/#toomanyrequestsexception","title":"TooManyRequestsException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/","title":"UnauthenticatedException - Misk","text":"//misk-actions/misk.exceptions/UnauthenticatedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#unauthenticatedexception","title":"UnauthenticatedException","text":"[jvm]\\ open class UnauthenticatedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when authentication fails
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#constructors","title":"Constructors","text":"UnauthenticatedException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/-unauthenticated-exception/","title":"UnauthenticatedException - Misk","text":"//misk-actions/misk.exceptions/UnauthenticatedException/UnauthenticatedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/-unauthenticated-exception/#unauthenticatedexception","title":"UnauthenticatedException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/","title":"UnauthorizedException - Misk","text":"//misk-actions/misk.exceptions/UnauthorizedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#unauthorizedexception","title":"UnauthorizedException","text":"[jvm]\\ open class UnauthorizedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when authenticated credentials lack access to a resource
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#constructors","title":"Constructors","text":"UnauthorizedException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/-unauthorized-exception/","title":"UnauthorizedException - Misk","text":"//misk-actions/misk.exceptions/UnauthorizedException/UnauthorizedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/-unauthorized-exception/#unauthorizedexception","title":"UnauthorizedException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/","title":"UnprocessableEntityException - Misk","text":"//misk-actions/misk.exceptions/UnprocessableEntityException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#unprocessableentityexception","title":"UnprocessableEntityException","text":"[jvm]\\ open class UnprocessableEntityException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
This exception is custom to Misk.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#constructors","title":"Constructors","text":"UnprocessableEntityException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/-unprocessable-entity-exception/","title":"UnprocessableEntityException - Misk","text":"//misk-actions/misk.exceptions/UnprocessableEntityException/UnprocessableEntityException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/-unprocessable-entity-exception/#unprocessableentityexception","title":"UnprocessableEntityException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/","title":"UnsupportedMediaTypeException - Misk","text":"//misk-actions/misk.exceptions/UnsupportedMediaTypeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#unsupportedmediatypeexception","title":"UnsupportedMediaTypeException","text":"[jvm]\\ open class UnsupportedMediaTypeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#constructors","title":"Constructors","text":"UnsupportedMediaTypeException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/-unsupported-media-type-exception/","title":"UnsupportedMediaTypeException - Misk","text":"//misk-actions/misk.exceptions/UnsupportedMediaTypeException/UnsupportedMediaTypeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/-unsupported-media-type-exception/#unsupportedmediatypeexception","title":"UnsupportedMediaTypeException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/","title":"WebActionException - Misk","text":"//misk-actions/misk.exceptions/WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#webactionexception","title":"WebActionException","text":"open class WebActionException(val code: Int, val responseBody: String, message: String, cause: Throwable? = null, val grpcStatus: GrpcStatus? = null, val details: List<AnyMessage> = listOf()) : RuntimeException
Even though all kotlin exceptions are runtime exceptions. To ensure java inter-op all exception need to extend from RuntimeException.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#inheritors","title":"Inheritors","text":"NotFoundException UnauthenticatedException UnauthorizedException ResourceUnavailableException BadRequestException ConflictException UnprocessableEntityException TooManyRequestsException ClientClosedRequestException BadGatewayException GatewayTimeoutException PayloadTooLargeException UnsupportedMediaTypeException"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#constructors","title":"Constructors","text":"WebActionException [jvm]constructor(code: Int, message: String, cause: Throwable? = null)constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null)constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null, grpcStatus: GrpcStatus? = null, details: List<AnyMessage> = listOf())"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/-web-action-exception/","title":"WebActionException - Misk","text":"//misk-actions/misk.exceptions/WebActionException/WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/-web-action-exception/#webactionexception","title":"WebActionException","text":"[jvm]\\ constructor(code: Int, message: String, cause: Throwable? = null)
constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null)
constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null, grpcStatus: GrpcStatus? = null, details: List<AnyMessage> = listOf())
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/code/","title":"code - Misk","text":"//misk-actions/misk.exceptions/WebActionException/code
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/code/#code","title":"code","text":"[jvm]\\ val code: Int
The HTTP status code. Should be 400..599.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/details/","title":"details - Misk","text":"//misk-actions/misk.exceptions/WebActionException/details
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/details/#details","title":"details","text":"[jvm]\\ val details: List<AnyMessage>
Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses.
Reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/grpc-status/","title":"grpcStatus - Misk","text":"//misk-actions/misk.exceptions/WebActionException/grpcStatus
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/grpc-status/#grpcstatus","title":"grpcStatus","text":"[jvm]\\ val grpcStatus: GrpcStatus? = null
The gPRC status code. If unset, it will be inferred from code.
Reference: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-client-error/","title":"isClientError - Misk","text":"//misk-actions/misk.exceptions/WebActionException/isClientError
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-client-error/#isclienterror","title":"isClientError","text":"[jvm]\\ val isClientError: Boolean
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-server-error/","title":"isServerError - Misk","text":"//misk-actions/misk.exceptions/WebActionException/isServerError
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-server-error/#isservererror","title":"isServerError","text":"[jvm]\\ val isServerError: Boolean
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/response-body/","title":"responseBody - Misk","text":"//misk-actions/misk.exceptions/WebActionException/responseBody
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ val responseBody: String
This is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body.
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.security.authz
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/#types","title":"Types","text":"Name Summary Authenticated [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Authenticated(val services: Array<String> = [], val capabilities: Array<String> = [], val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)Annotation indicating that a given action requires an authenticated caller - either a human in a specific capability, or one of a set of services Unauthenticated [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class UnauthenticatedAnnotation indicating that a given action supports unauthenticated access"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/","title":"Authenticated - Misk","text":"//misk-actions/misk.security.authz/Authenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/#authenticated","title":"Authenticated","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Authenticated(val services: Array<String> = [], val capabilities: Array<String> = [], val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)
Annotation indicating that a given action requires an authenticated caller - either a human in a specific capability, or one of a set of services
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/#properties","title":"Properties","text":"Name Summary allowAnyService [jvm]val allowAnyService: Boolean = falseAllow any service to be authenticated. allowAnyUser [jvm]val allowAnyUser: Boolean = falseAllow any user to be authenticated. capabilities [jvm]val capabilities: Array<String>Calling users must have at least one of these capabilities to be authenticated services [jvm]val services: Array<String>Calling services must be listed here to be authenticated"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-service/","title":"allowAnyService - Misk","text":"//misk-actions/misk.security.authz/Authenticated/allowAnyService
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-service/#allowanyservice","title":"allowAnyService","text":"[jvm]\\ val allowAnyService: Boolean = false
Allow any service to be authenticated.
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-user/","title":"allowAnyUser - Misk","text":"//misk-actions/misk.security.authz/Authenticated/allowAnyUser
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-user/#allowanyuser","title":"allowAnyUser","text":"[jvm]\\ val allowAnyUser: Boolean = false
Allow any user to be authenticated.
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/capabilities/","title":"capabilities - Misk","text":"//misk-actions/misk.security.authz/Authenticated/capabilities
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Array<String>
Calling users must have at least one of these capabilities to be authenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/services/","title":"services - Misk","text":"//misk-actions/misk.security.authz/Authenticated/services
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/services/#services","title":"services","text":"[jvm]\\ val services: Array<String>
Calling services must be listed here to be authenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-unauthenticated/","title":"Unauthenticated - Misk","text":"//misk-actions/misk.security.authz/Unauthenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-unauthenticated/#unauthenticated","title":"Unauthenticated","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Unauthenticated
Annotation indicating that a given action supports unauthenticated access
"},{"location":"0.x/misk-actions/misk-actions/misk.web/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web
"},{"location":"0.x/misk-actions/misk-actions/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web/#types","title":"Types","text":"Name Summary AvailableWhenDegraded [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AvailableWhenDegradedWhen the service is overloaded Misk will intervene and reject calls by returning \"HTTP 503 Service Unavailable\". We call this load shedding and it works similarly to flow control in TCP. ConnectWebSocket [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class ConnectWebSocket(val pathPattern: String) Delete [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Delete(val pathPattern: String) Description [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Description(val text: String) FormField [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class FormField(val name: String) FormValue [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class FormValue Get [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Get(val pathPattern: String) Grpc [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Grpc(val pathPattern: String) Patch [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Patch(val pathPattern: String) PathParam [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class PathParam(val value: String = \"\") Post [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Post(val pathPattern: String) Put [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Put(val pathPattern: String) QueryParam [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class QueryParam(val value: String = \"\") RequestBody [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class RequestBody RequestContentType [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class RequestContentType(val value: String) RequestHeaders [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class RequestHeaders Response [jvm]data class Response<out T>@JvmOverloadsconstructor(val body: T, val headers: Headers = headersOf(), val statusCode: Int = 200, val trailers: () -> Headers? = { null })An HTTP response body, headers, and status code. ResponseBody [jvm]interface ResponseBody ResponseContentType [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class ResponseContentType(val value: String)Indicates what response content types the action can produce. WebActionModule [jvm]class WebActionModule<A : WebAction> : KAbstractModule"},{"location":"0.x/misk-actions/misk-actions/misk.web/-available-when-degraded/","title":"AvailableWhenDegraded - Misk","text":"//misk-actions/misk.web/AvailableWhenDegraded
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-available-when-degraded/#availablewhendegraded","title":"AvailableWhenDegraded","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class AvailableWhenDegraded
When the service is overloaded Misk will intervene and reject calls by returning \"HTTP 503 Service Unavailable\". We call this load shedding and it works similarly to flow control in TCP.
We must not shed calls to status endpoints like health checks as doing so may create cascading failures: overloaded instances that do not respond to health checks will be killed, and this further overloads the remaining peers.
Only put this on endpoints that must never be rejected. Such endpoints must not do RPCs, database queries or other I/O because unexpected latency there can take down the entire service.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/","title":"ConnectWebSocket - Misk","text":"//misk-actions/misk.web/ConnectWebSocket
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/#connectwebsocket","title":"ConnectWebSocket","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class ConnectWebSocket(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/ConnectWebSocket/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/","title":"Delete - Misk","text":"//misk-actions/misk.web/Delete
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/#delete","title":"Delete","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Delete(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Delete/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/","title":"Description - Misk","text":"//misk-actions/misk.web/Description
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/#description","title":"Description","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Description(val text: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/#properties","title":"Properties","text":"Name Summary text [jvm]val text: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/text/","title":"text - Misk","text":"//misk-actions/misk.web/Description/text
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/","title":"FormField - Misk","text":"//misk-actions/misk.web/FormField
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/#formfield","title":"FormField","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class FormField(val name: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/name/","title":"name - Misk","text":"//misk-actions/misk.web/FormField/name
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-value/","title":"FormValue - Misk","text":"//misk-actions/misk.web/FormValue
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-value/#formvalue","title":"FormValue","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class FormValue
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/","title":"Get - Misk","text":"//misk-actions/misk.web/Get
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/#get","title":"Get","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Get(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Get/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/","title":"Grpc - Misk","text":"//misk-actions/misk.web/Grpc
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/#grpc","title":"Grpc","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Grpc(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Grpc/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/","title":"Patch - Misk","text":"//misk-actions/misk.web/Patch
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/#patch","title":"Patch","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Patch(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Patch/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/","title":"PathParam - Misk","text":"//misk-actions/misk.web/PathParam
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/#pathparam","title":"PathParam","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class PathParam(val value: String = \"\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/value/","title":"value - Misk","text":"//misk-actions/misk.web/PathParam/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/","title":"Post - Misk","text":"//misk-actions/misk.web/Post
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/#post","title":"Post","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Post(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Post/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/","title":"Put - Misk","text":"//misk-actions/misk.web/Put
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/#put","title":"Put","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Put(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Put/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/","title":"QueryParam - Misk","text":"//misk-actions/misk.web/QueryParam
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/#queryparam","title":"QueryParam","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class QueryParam(val value: String = \"\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/value/","title":"value - Misk","text":"//misk-actions/misk.web/QueryParam/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-body/","title":"RequestBody - Misk","text":"//misk-actions/misk.web/RequestBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-body/#requestbody","title":"RequestBody","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class RequestBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/","title":"RequestContentType - Misk","text":"//misk-actions/misk.web/RequestContentType
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/#requestcontenttype","title":"RequestContentType","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class RequestContentType(val value: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/#properties","title":"Properties","text":"Name Summary value [jvm]val value: Array<out String>"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/value/","title":"value - Misk","text":"//misk-actions/misk.web/RequestContentType/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/value/#value","title":"value","text":"[jvm]\\ val value: Array<out String>
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-headers/","title":"RequestHeaders - Misk","text":"//misk-actions/misk.web/RequestHeaders
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-headers/#requestheaders","title":"RequestHeaders","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class RequestHeaders
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/","title":"Response - Misk","text":"//misk-actions/misk.web/Response
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#response","title":"Response","text":"[jvm]\\ data class Response<out T>@JvmOverloadsconstructor(val body: T, val headers: Headers = headersOf(), val statusCode: Int = 200, val trailers: () -> Headers? = { null })
An HTTP response body, headers, and status code.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#constructors","title":"Constructors","text":"Response [jvm]@JvmOverloadsconstructor(body: T, headers: Headers = headersOf(), statusCode: Int = 200, trailers: () -> Headers? = { null })"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#properties","title":"Properties","text":"Name Summary body [jvm]val body: T headers [jvm]val headers: Headers statusCode [jvm]val statusCode: Int = 200 trailers [jvm]val trailers: () -> Headers?"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/-response/","title":"Response - Misk","text":"//misk-actions/misk.web/Response/Response
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/-response/#response","title":"Response","text":"[jvm]\\
@JvmOverloads
constructor(body: T, headers: Headers = headersOf(), statusCode: Int = 200, trailers: () -> Headers? = { null })
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/body/","title":"body - Misk","text":"//misk-actions/misk.web/Response/body
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/body/#body","title":"body","text":"[jvm]\\ val body: T
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/headers/","title":"headers - Misk","text":"//misk-actions/misk.web/Response/headers
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/headers/#headers","title":"headers","text":"[jvm]\\ val headers: Headers
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/status-code/","title":"statusCode - Misk","text":"//misk-actions/misk.web/Response/statusCode
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/status-code/#statuscode","title":"statusCode","text":"[jvm]\\ val statusCode: Int = 200
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/to-string/","title":"toString - Misk","text":"//misk-actions/misk.web/Response/toString
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/trailers/","title":"trailers - Misk","text":"//misk-actions/misk.web/Response/trailers
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/trailers/#trailers","title":"trailers","text":"[jvm]\\ val trailers: () -> Headers?
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/","title":"ResponseBody - Misk","text":"//misk-actions/misk.web/ResponseBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/#responsebody","title":"ResponseBody","text":"[jvm]\\ interface ResponseBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/#functions","title":"Functions","text":"Name Summary writeTo [jvm]abstract fun writeTo(sink: BufferedSink)"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/write-to/","title":"writeTo - Misk","text":"//misk-actions/misk.web/ResponseBody/writeTo
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/write-to/#writeto","title":"writeTo","text":"[jvm]\\ abstract fun writeTo(sink: BufferedSink)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/","title":"ResponseContentType - Misk","text":"//misk-actions/misk.web/ResponseContentType
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/#responsecontenttype","title":"ResponseContentType","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class ResponseContentType(val value: String)
Indicates what response content types the action can produce.
Clients can specify what content type they prefer by setting the Accept header. If the action supports multiple content types but no Accept header is specified, the first content type is used.
//misk-actions/misk.web/ResponseContentType/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/value/#value","title":"value","text":"[jvm]\\ val value: Array<out String>
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/","title":"WebActionModule - Misk","text":"//misk-actions/misk.web/WebActionModule
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#webactionmodule","title":"WebActionModule","text":"[jvm]\\ class WebActionModule<A : WebAction> : KAbstractModule
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: KClass<A> url_path_prefix [jvm]val url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/action-class/","title":"actionClass - Misk","text":"//misk-actions/misk.web/WebActionModule/actionClass
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/action-class/#actionclass","title":"actionClass","text":"[jvm]\\ val actionClass: KClass<A>
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-actions/misk.web/WebActionModule/url_path_prefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/","title":"Companion - Misk","text":"//misk-actions/misk.web/WebActionModule/Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <A : WebAction> create(): WebActionModule<A>@JvmStaticfun <A : WebAction> create(actionClass: Class<A>): WebActionModule<A>[jvm]fun <A : WebAction> create(actionClass: KClass<A>): WebActionModule<A>Registers a web action. createWithPrefix [jvm]inline fun <A : WebAction> createWithPrefix(url_path_prefix: String): WebActionModule<A>@JvmStaticfun <A : WebAction> createWithPrefix(actionClass: Class<A>, url_path_prefix: String): WebActionModule<A>[jvm]fun <A : WebAction> createWithPrefix(actionClass: KClass<A>, url_path_prefix: String): WebActionModule<A>Registers a web action with a path prefix."},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/","title":"createWithPrefix - Misk","text":"//misk-actions/misk.web/WebActionModule/Companion/createWithPrefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/#createwithprefix","title":"createWithPrefix","text":"[jvm]\\ inline fun <A : WebAction> createWithPrefix(url_path_prefix: String): WebActionModule<A>
@JvmStatic
fun <A : WebAction> createWithPrefix(actionClass: Class<A>, url_path_prefix: String): WebActionModule<A>
[jvm]\\ fun <A : WebAction> createWithPrefix(actionClass: KClass<A>, url_path_prefix: String): WebActionModule<A>
Registers a web action with a path prefix.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/#parameters","title":"Parameters","text":"jvm
actionClass : The web action to register. url_path_prefix : Defaults to \"/\". If not empty, must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/","title":"create - Misk","text":"//misk-actions/misk.web/WebActionModule/Companion/create
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <A : WebAction> create(): WebActionModule<A>
@JvmStatic
fun <A : WebAction> create(actionClass: Class<A>): WebActionModule<A>
[jvm]\\ fun <A : WebAction> create(actionClass: KClass<A>): WebActionModule<A>
Registers a web action.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/#parameters","title":"Parameters","text":"jvm
actionClass : The web action to register."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web.actions
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/#types","title":"Types","text":"Name Summary WebAction [jvm]interface WebAction WebActionEntry [jvm]data class WebActionEntry(val actionClass: KClass<out WebAction>, val url_path_prefix: String) : ValidWebEntryWebActionEntry WebSocket [jvm]interface WebSocketA non-blocking interface to a web socket. WebSocketListener [jvm]open class WebSocketListener"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action/","title":"WebAction - Misk","text":"//misk-actions/misk.web.actions/WebAction
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action/#webaction","title":"WebAction","text":"[jvm]\\ interface WebAction
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/","title":"WebActionEntry - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#webactionentry","title":"WebActionEntry","text":"data class WebActionEntry(val actionClass: KClass<out WebAction>, val url_path_prefix: String) : ValidWebEntry
WebActionEntry
A registration of a web action with optional configuration to customize.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#parameters","title":"Parameters","text":"jvm
actionClass : WebAction to multibind to WebServlet url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#constructors","title":"Constructors","text":"WebActionEntry [jvm]constructor(actionClass: KClass<out WebAction>, url_path_prefix: String)"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: KClass<out WebAction> url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/","title":"WebActionEntry - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry/WebActionEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/#webactionentry","title":"WebActionEntry","text":"[jvm]\\ constructor(actionClass: KClass<out WebAction>, url_path_prefix: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/#parameters","title":"Parameters","text":"jvm
actionClass : WebAction to multibind to WebServlet url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/","title":"actionClass - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry/actionClass
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/#actionclass","title":"actionClass","text":"[jvm]\\ val actionClass: KClass<out WebAction>
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/#parameters","title":"Parameters","text":"jvm
actionClass : WebAction to multibind to WebServlet"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry/url_path_prefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/#parameters","title":"Parameters","text":"jvm
url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/","title":"WebSocket - Misk","text":"//misk-actions/misk.web.actions/WebSocket
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/#websocket","title":"WebSocket","text":"[jvm]\\ interface WebSocket
A non-blocking interface to a web socket.
Web Socket LifecycleUpon normal operation each web socket progresses through a sequence of states:
Web sockets may fail due to HTTP upgrade problems, connectivity problems, or if either peer chooses to short-circuit the graceful shutdown process:
Note that the state progression is independent for each peer. Arriving at a gracefully-closed state indicates that a peer has sent all of its outgoing messages and received all of its incoming messages. But it does not guarantee that the other peer will successfully receive all of its incoming messages.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/#functions","title":"Functions","text":"Name Summary cancel [jvm]abstract fun cancel()Immediately and violently release resources held by this web socket, discarding any enqueued messages. This does nothing if the web socket has already been closed or canceled. close [jvm]abstract fun close(code: Int, reason: String?): BooleanAttempts to initiate a graceful shutdown of this web socket. Any already-enqueued messages will be transmitted before the close message is sent but subsequent calls to {@link #send} will return false and their messages will not be enqueued. queueSize [jvm]abstract fun queueSize(): LongReturns the size in bytes of all messages enqueued to be transmitted to the server. This doesn\u2019t include framing overhead. It also doesn\u2019t include any bytes buffered by the operating system or network intermediaries. This method returns 0 if no messages are waiting in the queue. If may return a nonzero value after the web socket has been canceled; this indicates that enqueued messages were not transmitted. send [jvm]abstract fun send(text: String): BooleanAttempts to enqueue {@code bytes} to be sent as a the data of a binary (type {@code 0x2}) message.[jvm]abstract fun send(bytes: ByteString): BooleanAttempts to enqueue {@code text} to be UTF-8 encoded and sent as a the data of a text (type {@code 0x1}) message."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/cancel/","title":"cancel - Misk","text":"//misk-actions/misk.web.actions/WebSocket/cancel
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/cancel/#cancel","title":"cancel","text":"[jvm]\\ abstract fun cancel()
Immediately and violently release resources held by this web socket, discarding any enqueued messages. This does nothing if the web socket has already been closed or canceled.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/close/","title":"close - Misk","text":"//misk-actions/misk.web.actions/WebSocket/close
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/close/#close","title":"close","text":"[jvm]\\ abstract fun close(code: Int, reason: String?): Boolean
Attempts to initiate a graceful shutdown of this web socket. Any already-enqueued messages will be transmitted before the close message is sent but subsequent calls to {@link #send} will return false and their messages will not be enqueued.
This returns true if a graceful shutdown was initiated by this call. It returns false and if a graceful shutdown was already underway or if the web socket is already closed or canceled. #### Parameters jvm | | | |---|---| | code | Status code as defined by Section 7.4 of RFC 6455. | | reason | Reason for shutting down or {@code null}. |"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/queue-size/","title":"queueSize - Misk","text":"
//misk-actions/misk.web.actions/WebSocket/queueSize
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ abstract fun queueSize(): Long
Returns the size in bytes of all messages enqueued to be transmitted to the server. This doesn\u2019t include framing overhead. It also doesn\u2019t include any bytes buffered by the operating system or network intermediaries. This method returns 0 if no messages are waiting in the queue. If may return a nonzero value after the web socket has been canceled; this indicates that enqueued messages were not transmitted.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/send/","title":"send - Misk","text":"//misk-actions/misk.web.actions/WebSocket/send
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/send/#send","title":"send","text":"[jvm]\\ abstract fun send(bytes: ByteString): Boolean
Attempts to enqueue {@code text} to be UTF-8 encoded and sent as a the data of a text (type {@code 0x1}) message.
This method returns true if the message was enqueued. Messages that would overflow the outgoing message buffer will be rejected and trigger a {@linkplain #close graceful shutdown} of this web socket. This method returns false in that case, and in any other case where this web socket is closing, closed, or canceled.
This method returns immediately. [jvm]\\ abstract fun [send](send.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) Attempts to enqueue {@code bytes} to be sent as a the data of a binary (type {@code 0x2}) message.
This method returns true if the message was enqueued. Messages that would overflow the outgoing message buffer will be rejected and trigger a {@linkplain #close graceful shutdown} of this web socket. This method returns false in that case, and in any other case where this web socket is closing, closed, or canceled.
This method returns immediately."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/","title":"WebSocketListener - Misk","text":"
//misk-actions/misk.web.actions/WebSocketListener
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/#websocketlistener","title":"WebSocketListener","text":"[jvm]\\ open class WebSocketListener
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/#constructors","title":"Constructors","text":"WebSocketListener [jvm]constructor()"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/#functions","title":"Functions","text":"Name Summary onClosed [jvm]open fun onClosed(webSocket: WebSocket, code: Int, reason: String?)Invoked when both peers have indicated that no more messages will be transmitted and the connection has been successfully released. No further calls to this listener will be made. onClosing [jvm]open fun onClosing(webSocket: WebSocket, code: Int, reason: String?)Invoked when the remote peer has indicated that no more incoming messages will be transmitted. onFailure [jvm]open fun onFailure(webSocket: WebSocket, t: Throwable)Invoked when a web socket has been closed due to an error reading from or writing to the network. Both outgoing and incoming messages may have been lost. No further calls to this listener will be made. onMessage [jvm]open fun onMessage(webSocket: WebSocket, text: String)Invoked when a text (type {@code 0x1}) message has been received.[jvm]open fun onMessage(webSocket: WebSocket, bytes: ByteString)Invoked when a binary (type {@code 0x2}) message has been received."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/-web-socket-listener/","title":"WebSocketListener - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/WebSocketListener
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/-web-socket-listener/#websocketlistener","title":"WebSocketListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closed/","title":"onClosed - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onClosed
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closed/#onclosed","title":"onClosed","text":"[jvm]\\ open fun onClosed(webSocket: WebSocket, code: Int, reason: String?)
Invoked when both peers have indicated that no more messages will be transmitted and the connection has been successfully released. No further calls to this listener will be made.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closing/","title":"onClosing - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onClosing
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closing/#onclosing","title":"onClosing","text":"[jvm]\\ open fun onClosing(webSocket: WebSocket, code: Int, reason: String?)
Invoked when the remote peer has indicated that no more incoming messages will be transmitted.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-failure/","title":"onFailure - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onFailure
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-failure/#onfailure","title":"onFailure","text":"[jvm]\\ open fun onFailure(webSocket: WebSocket, t: Throwable)
Invoked when a web socket has been closed due to an error reading from or writing to the network. Both outgoing and incoming messages may have been lost. No further calls to this listener will be made.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-message/","title":"onMessage - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onMessage
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-message/#onmessage","title":"onMessage","text":"[jvm]\\ open fun onMessage(webSocket: WebSocket, text: String)
Invoked when a text (type {@code 0x1}) message has been received.
[jvm]\\ open fun onMessage(webSocket: WebSocket, bytes: ByteString)
Invoked when a binary (type {@code 0x2}) message has been received.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web.dashboard
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/#types","title":"Types","text":"Name Summary ValidWebEntry [jvm]open class ValidWebEntry@JvmOverloadsconstructor(val valid_slug: String = \"\", val valid_url_path_prefix: String = \"/\")"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/","title":"ValidWebEntry - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#validwebentry","title":"ValidWebEntry","text":"open class ValidWebEntry@JvmOverloadsconstructor(val valid_slug: String = \"\", val valid_url_path_prefix: String = \"/\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#inheritors","title":"Inheritors","text":"WebActionEntry"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#constructors","title":"Constructors","text":"ValidWebEntry [jvm]@JvmOverloadsconstructor(valid_slug: String = \"\", valid_url_path_prefix: String = \"/\")"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#properties","title":"Properties","text":"Name Summary valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-valid-web-entry/","title":"ValidWebEntry - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/ValidWebEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-valid-web-entry/#validwebentry","title":"ValidWebEntry","text":"[jvm]\\
@JvmOverloads
constructor(valid_slug: String = \"\", valid_url_path_prefix: String = \"/\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_slug/","title":"valid_slug - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/valid_slug
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_slug/#valid_slug","title":"valid_slug","text":"[jvm]\\ val valid_slug: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_url_path_prefix/","title":"valid_url_path_prefix - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/valid_url_path_prefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_url_path_prefix/#valid_url_path_prefix","title":"valid_url_path_prefix","text":"[jvm]\\ val valid_url_path_prefix: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/","title":"Companion - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/#functions","title":"Functions","text":"Name Summary slugify [jvm]inline fun <A : Annotation> slugify(): Stringfun slugify(annotation: KClass<out Annotation>): StringGenerate a valid slug from an Annotation class.[jvm]fun String.slugify(): StringGenerate a valid slug from a String."},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/slugify/","title":"slugify - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/Companion/slugify
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/slugify/#slugify","title":"slugify","text":"[jvm]\\ fun slugify(annotation: KClass<out Annotation>): String
inline fun <A : Annotation> slugify(): String
Generate a valid slug from an Annotation class.
[jvm]\\ fun String.slugify(): String
Generate a valid slug from a String.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web.interceptors
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/#types","title":"Types","text":"Name Summary LogRequestResponse [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class LogRequestResponse(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: Array<String> = [], val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)Annotation indicating that request and response information should be logged. RequestLoggingMode [jvm]enum RequestLoggingMode : Enum<RequestLoggingMode>"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/","title":"LogRequestResponse - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/#logrequestresponse","title":"LogRequestResponse","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class LogRequestResponse(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: Array<String> = [], val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)
Annotation indicating that request and response information should be logged.
Rate limiting is used to sample the number of requests logged. The value specified is the log events per sec allotted per action.
By default we set rate limiting for successes to 10 log events per second, enough to show things are happening without sending too many logs. By default rate limiting is off for errors, as we would want to surface such logs for investigation.
If you would like to turn off rate limiting and emit all logs, set ratePerSecond and/or errorRatePerSecond to 0.
If you would like to turn off logging for all non-error requests, set requestLoggingMode to ERROR_ONLY. otherwise, all requests will be logged (excluding those otherwise rate limited, etc).
Percentage sampling is used to sample request and response bodies, with 0.0 for none and 1.0 for all. Valid values are in the range 0.0, 1.0.
You can exclude logging in particular environments by using the all-lowercase names of the environments. See the wisp-deployment module for details of supported environment names.
If arguments and responses may include sensitive information, it is expected that the toString() methods of these objects will redact it.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/#properties","title":"Properties","text":"Name Summary bodySampling [jvm]val bodySampling: Double = 0.0By default do not log request and response bodies errorBodySampling [jvm]val errorBodySampling: Double = 0.0 errorRatePerSecond [jvm]val errorRatePerSecond: Long = 0By default, rate limiting is off for error logs excludedEnvironments [jvm]val excludedEnvironments: Array<String>which deploy environments will not have request/response logging enabled ratePerSecond [jvm]val ratePerSecond: Long = 10 requestLoggingMode [jvm]val requestLoggingMode: RequestLoggingModeBy default log non-error responses"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/body-sampling/","title":"bodySampling - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/bodySampling
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/body-sampling/#bodysampling","title":"bodySampling","text":"[jvm]\\ val bodySampling: Double = 0.0
By default do not log request and response bodies
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-body-sampling/","title":"errorBodySampling - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/errorBodySampling
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-body-sampling/#errorbodysampling","title":"errorBodySampling","text":"[jvm]\\ val errorBodySampling: Double = 0.0
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-rate-per-second/","title":"errorRatePerSecond - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/errorRatePerSecond
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-rate-per-second/#errorratepersecond","title":"errorRatePerSecond","text":"[jvm]\\ val errorRatePerSecond: Long = 0
By default, rate limiting is off for error logs
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/excluded-environments/","title":"excludedEnvironments - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/excludedEnvironments
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/excluded-environments/#excludedenvironments","title":"excludedEnvironments","text":"[jvm]\\ val excludedEnvironments: Array<String>
which deploy environments will not have request/response logging enabled
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/rate-per-second/","title":"ratePerSecond - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/ratePerSecond
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/rate-per-second/#ratepersecond","title":"ratePerSecond","text":"[jvm]\\ val ratePerSecond: Long = 10
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/request-logging-mode/","title":"requestLoggingMode - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/requestLoggingMode
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/request-logging-mode/#requestloggingmode","title":"requestLoggingMode","text":"[jvm]\\ val requestLoggingMode: RequestLoggingMode
By default log non-error responses
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/","title":"RequestLoggingMode - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#requestloggingmode","title":"RequestLoggingMode","text":"[jvm]\\ enum RequestLoggingMode : Enum<RequestLoggingMode>
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#entries","title":"Entries","text":"ALL [jvm]ALLLog all requests and responses, rate limiting, etc still apply. ERROR_ONLY [jvm]ERROR_ONLYLog only error requests and responses, rate limiting, etc still apply."},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<RequestLoggingMode>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): RequestLoggingModeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<RequestLoggingMode>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/entries/","title":"entries - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/entries
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<RequestLoggingMode>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/value-of/","title":"valueOf - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/valueOf
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): RequestLoggingMode
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/values/","title":"values - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/values
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<RequestLoggingMode>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-a-l-l/","title":"ALL - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/ALL
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-a-l-l/#all","title":"ALL","text":"[jvm]\\ ALL
Log all requests and responses, rate limiting, etc still apply.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-a-l-l/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-e-r-r-o-r_-o-n-l-y/","title":"ERROR_ONLY - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/ERROR_ONLY
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-e-r-r-o-r_-o-n-l-y/#error_only","title":"ERROR_ONLY","text":"[jvm]\\ ERROR_ONLY
Log only error requests and responses, rate limiting, etc still apply.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-e-r-r-o-r_-o-n-l-y/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/","title":"misk-admin - Misk","text":"//misk-admin
"},{"location":"0.x/misk-admin/#misk-admin","title":"misk-admin","text":""},{"location":"0.x/misk-admin/#packages","title":"Packages","text":"Name misk.web.dashboard misk.web.metadata misk.web.metadata.all misk.web.metadata.config misk.web.metadata.database misk.web.metadata.guice misk.web.metadata.webaction misk.web.v2"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/","title":"Index","text":"//misk-admin/misk.web.dashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/#types","title":"Types","text":"Name Summary AdminDashboard [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class AdminDashboardDashboard Annotation used for all tabs bound in the Misk Admin Dashboard AdminDashboardModule [jvm]class AdminDashboardModule@JvmOverloadsconstructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE) : KAbstractModuleInstalls default Admin Dashboard that runs at multibound DashboardHomeUrl AdminDashboardTestingModule [jvm]class AdminDashboardTestingModule : KAbstractModule BaseDashboardModule [jvm]class BaseDashboardModule(isDevelopment: Boolean) : KAbstractModuleInstalls base functionality for the Admin Dashboard including: DashboardHomeUrl [jvm]data class DashboardHomeUrl@JvmOverloadsconstructor(val dashboard_slug: String, val url: String, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : ValidWebEntryUrl to link to for the home button in the dashboard navbar 1 DashboardHomeUrl should be bound per dashboard DashboardModule [jvm]class DashboardModule@JvmOverloadsconstructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf()) : KAbstractModuleHandles installation of Misk Dashboard components (admin dashboard or custom\u2026). DashboardTab [jvm]data class DashboardTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val menuLabel: String, val menuCategory: String = \"\", val menuUrl: String = url_path_prefix, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : WebTabA WebTab with additional fields to bind to a specific Dashboard that has a tabs menu DashboardTabLoader [jvm]sealed class DashboardTabLoader DashboardTabLoaderEntry [jvm]data class DashboardTabLoaderEntry(val urlPathPrefix: String, val loader: DashboardTabLoader) DashboardTabProvider [jvm]class DashboardTabProvider@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val menuLabel: (appName: String, deployment: Deployment) -> String, val menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, val menuCategory: String = \"Admin\", val dashboard_slug: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>) : ValidWebEntry, Provider<DashboardTab> Sets the tab\u2019s authentication capabilities/services by the multibound AccessAnnotationEntry MiskWebColor [jvm]enum MiskWebColor : Enum<MiskWebColor> Matches the Misk-Web Color enum in @misk/core/src/utilities/css.ts MiskWebTabIndexAction [jvm]@Singletonclass MiskWebTabIndexAction@Injectconstructor(dashboardTabs: List<DashboardTab>) : WebActionKotlin backed tab loader, equivalent to /_tab/slug/index.html WebTab [jvm]open class WebTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf()) : ValidWebEntry WebTabResourceModule [jvm]class WebTabResourceModule@JvmOverloadsconstructor(isDevelopment: Boolean = false, val slug: String, val web_proxy_url: String? = null, val url_path_prefix: String = \"/_tab/\", val resourcePath: String = \"classpath:/web/_tab/\") : KAbstractModuleDeclare how to serve the resources for a WebTab (JS, HTML, CSS\u2026)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/#functions","title":"Functions","text":"Name Summary DashboardHomeUrl [jvm]inline fun <DA : Annotation> DashboardHomeUrl(urlPathPrefix: String): DashboardHomeUrl DashboardTabProvider [jvm]inline fun <DA : Annotation, AA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\"): DashboardTabProviderBinds a DashboardTab for Dashboard DA with access annotation AA[jvm]inline fun <DA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\", capabilities: Set<String> = setOf(), services: Set<String> = setOf()): DashboardTabProviderBinds a DashboardTab for Dashboard DA with optional access capabilities and services HtmlLayout [jvm]fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)Default setup of HTML for a page including head and install of CSS/JS dependencies."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/","title":"DashboardHomeUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#dashboardhomeurl","title":"DashboardHomeUrl","text":"[jvm]\\ inline fun <DA : Annotation> DashboardHomeUrl(urlPathPrefix: String): DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/","title":"DashboardTabProvider - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#dashboardtabprovider","title":"DashboardTabProvider","text":"[jvm]\\ inline fun <DA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\", capabilities: Set<String> = setOf(), services: Set<String> = setOf()): DashboardTabProvider
Binds a DashboardTab for Dashboard DA with optional access capabilities and services
[jvm]\\ inline fun <DA : Annotation, AA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\"): DashboardTabProvider
Binds a DashboardTab for Dashboard DA with access annotation AA
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-html-layout/","title":"html layout","text":"//misk-admin/misk.web.dashboard/HtmlLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-html-layout/#htmllayout","title":"HtmlLayout","text":"[jvm]\\ fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)
Default setup of HTML for a page including head and install of CSS/JS dependencies.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard/","title":"AdminDashboard - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard/#admindashboard","title":"AdminDashboard","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])
annotation class AdminDashboard
Dashboard Annotation used for all tabs bound in the Misk Admin Dashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/","title":"AdminDashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/#admindashboardmodule","title":"AdminDashboardModule","text":"[jvm]\\ class AdminDashboardModule@JvmOverloadsconstructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE) : KAbstractModule
Installs default Admin Dashboard that runs at multibound DashboardHomeUrl
Each Misk included tab in dashboard is installed with the respective:
To add tabs to the Misk Admin Dashboard, bind the DashboardTab with the Dashboard Annotation AdminDashboard. Tabs are then included in the admin dashboard menu grouping according to the DashboardTab.category field and sorting by DashboardTab.name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/#constructors","title":"Constructors","text":"AdminDashboardModule [jvm]@JvmOverloadsconstructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/-admin-dashboard-module/","title":"AdminDashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardModule/AdminDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/-admin-dashboard-module/#admindashboardmodule","title":"AdminDashboardModule","text":"[jvm]\\
@JvmOverloads
constructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/","title":"AdminDashboardTestingModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardTestingModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/#admindashboardtestingmodule","title":"AdminDashboardTestingModule","text":"[jvm]\\ class AdminDashboardTestingModule : KAbstractModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/#constructors","title":"Constructors","text":"AdminDashboardTestingModule [jvm]constructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/-admin-dashboard-testing-module/","title":"AdminDashboardTestingModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardTestingModule/AdminDashboardTestingModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/-admin-dashboard-testing-module/#admindashboardtestingmodule","title":"AdminDashboardTestingModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-base-dashboard-module/","title":"BaseDashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/BaseDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-base-dashboard-module/#basedashboardmodule","title":"BaseDashboardModule","text":"[jvm]\\ class BaseDashboardModule(isDevelopment: Boolean) : KAbstractModule
Installs base functionality for the Admin Dashboard including:
admin-dashboard tab which loads all other tabs and provides navbar, menu links, auth@misk packages used by Misk-Web tabs from window to provide faster tab loads//misk-admin/misk.web.dashboard/BaseDashboardModule/BaseDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-base-dashboard-module/-base-dashboard-module/#basedashboardmodule","title":"BaseDashboardModule","text":"[jvm]\\ constructor(isDevelopment: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/","title":"DashboardHomeUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#dashboardhomeurl","title":"DashboardHomeUrl","text":"[jvm]\\ data class DashboardHomeUrl@JvmOverloadsconstructor(val dashboard_slug: String, val url: String, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : ValidWebEntry
Url to link to for the home button in the dashboard navbar 1 DashboardHomeUrl should be bound per dashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#constructors","title":"Constructors","text":"DashboardHomeUrl [jvm]@JvmOverloadsconstructor(dashboard_slug: String, url: String, dashboardAnnotationKClass: KClass<out Annotation>? = null)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#properties","title":"Properties","text":"Name Summary dashboard_slug [jvm]val dashboard_slug: String dashboardAnnotationKClass [jvm]val dashboardAnnotationKClass: KClass<out Annotation>? = null url [jvm]val url: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/-dashboard-home-url/","title":"DashboardHomeUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/-dashboard-home-url/#dashboardhomeurl","title":"DashboardHomeUrl","text":"[jvm]\\
@JvmOverloads
constructor(dashboard_slug: String, url: String, dashboardAnnotationKClass: KClass<out Annotation>? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard-annotation-k-class/","title":"dashboardAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/dashboardAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard-annotation-k-class/#dashboardannotationkclass","title":"dashboardAnnotationKClass","text":"[jvm]\\ val dashboardAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/url/","title":"url - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/url
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/url/#url","title":"url","text":"[jvm]\\ val url: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/","title":"DashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#dashboardmodule","title":"DashboardModule","text":"[jvm]\\ class DashboardModule@JvmOverloadsconstructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf()) : KAbstractModule
Handles installation of Misk Dashboard components (admin dashboard or custom\u2026).
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#constructors","title":"Constructors","text":"DashboardModule [jvm]@JvmOverloadsconstructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf())"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-dashboard-module/","title":"DashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-dashboard-module/#dashboardmodule","title":"DashboardModule","text":"[jvm]\\
@JvmOverloads
constructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/#functions","title":"Functions","text":"Name Summary addIndexAccessBlocks [jvm]fun addIndexAccessBlocks(vararg blocks: DashboardIndexAccessBlock): DashboardModuleAdd access blocks to dashboard index. addIndexBlocks [jvm]fun addIndexBlocks(vararg blocks: DashboardIndexBlock): DashboardModuleAdd access blocks to dashboard index. createHotwireTab [jvm]inline fun <DA : Annotation, AA : Annotation> createHotwireTab(slug: String, urlPathPrefix: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule createIFrameTab [jvm]inline fun <DA : Annotation, AA : Annotation> createIFrameTab(slug: String, urlPathPrefix: String, resourcePathPrefix: String = \"/_tab/\", iframePath: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule createMenuLink [jvm]inline fun <DA : Annotation, AA : Annotation> createMenuLink(noinline label: (appName: String, deployment: Deployment) -> String, noinline url: (appName: String, deployment: Deployment) -> String, category: String = \"\"): DashboardModuleinline fun <DA : Annotation, AA : Annotation> createMenuLink(label: String, url: String, category: String = \"\"): DashboardModuleCreate menu link with label for url under menu category for a dashboard DA with access AA. createMiskWebDashboard [jvm]inline fun <DA : Annotation, AA : Annotation> createMiskWebDashboard(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModuleInstalls a Misk-Web app for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory. createMiskWebTab [jvm]inline fun <DA : Annotation, AA : Annotation> createMiskWebTab(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", iframePath: String = \"/\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModuleInstalls a Misk-Web tab for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-access-blocks/","title":"addIndexAccessBlocks - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/addIndexAccessBlocks
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-access-blocks/#addindexaccessblocks","title":"addIndexAccessBlocks","text":"[jvm]\\ fun addIndexAccessBlocks(vararg blocks: DashboardIndexAccessBlock): DashboardModule
Add access blocks to dashboard index.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-blocks/","title":"addIndexBlocks - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/addIndexBlocks
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-blocks/#addindexblocks","title":"addIndexBlocks","text":"[jvm]\\ fun addIndexBlocks(vararg blocks: DashboardIndexBlock): DashboardModule
Add access blocks to dashboard index.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-hotwire-tab/","title":"createHotwireTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createHotwireTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-hotwire-tab/#createhotwiretab","title":"createHotwireTab","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createHotwireTab(slug: String, urlPathPrefix: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-hotwire-tab/#parameters","title":"Parameters","text":"jvm
slug : unique slug to identify the tab namespace, it must match the tab\u2019s corresponding DashboardTab multibinding urlPathPrefix : path prefix which when used in a user\u2019s navigation URL will route to this tab. menuLabel : tab name which appears in the dashboard menu, usually titlecase menuCategory : menu category which the tab appears under"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-i-frame-tab/","title":"createIFrameTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createIFrameTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-i-frame-tab/#createiframetab","title":"createIFrameTab","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createIFrameTab(slug: String, urlPathPrefix: String, resourcePathPrefix: String = \"/_tab/\", iframePath: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-i-frame-tab/#parameters","title":"Parameters","text":"jvm
slug : unique slug to identify the tab namespace, it must match the tab\u2019s corresponding DashboardTab multibinding urlPathPrefix : path prefix which when used in a user\u2019s navigation URL will route to this tab. resourcePathPrefix : path prefix used for background network requests to get resources (HTML, CSS\u2026) for the tab from a resource provider (classpath, filesystem, web proxy\u2026). iframePath : complete path including file and extension if necessary which is set as the iframe src attribute in the generated HTML. name : tab name which appears in the dashboard menu, usually titlecase category : menu category which the tab appears under"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-menu-link/","title":"createMenuLink - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createMenuLink
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-menu-link/#createmenulink","title":"createMenuLink","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createMenuLink(label: String, url: String, category: String = \"\"): DashboardModule
inline fun <DA : Annotation, AA : Annotation> createMenuLink(noinline label: (appName: String, deployment: Deployment) -> String, noinline url: (appName: String, deployment: Deployment) -> String, category: String = \"\"): DashboardModule
Create menu link with label for url under menu category for a dashboard DA with access AA.
If category is empty, it will appear at the top of the menu list.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-dashboard/","title":"createMiskWebDashboard - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createMiskWebDashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-dashboard/#createmiskwebdashboard","title":"createMiskWebDashboard","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createMiskWebDashboard(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
Installs a Misk-Web app for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-tab/","title":"createMiskWebTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createMiskWebTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-tab/#createmiskwebtab","title":"createMiskWebTab","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createMiskWebTab(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", iframePath: String = \"/\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
Installs a Misk-Web tab for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/","title":"DashboardTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#dashboardtab","title":"DashboardTab","text":"[jvm]\\ data class DashboardTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val menuLabel: String, val menuCategory: String = \"\", val menuUrl: String = url_path_prefix, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : WebTab
A WebTab with additional fields to bind to a specific Dashboard that has a tabs menu
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#constructors","title":"Constructors","text":"DashboardTab [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, dashboard_slug: String, menuLabel: String, menuCategory: String = \"\", menuUrl: String = url_path_prefix, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>? = null)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#properties","title":"Properties","text":"Name Summary accessAnnotationKClass [jvm]val accessAnnotationKClass: KClass<out Annotation>? = null capabilities [jvm]open override val capabilities: Set<String>Set to show the tab only for authenticated capabilities, else shows always dashboard_slug [jvm]val dashboard_slug: StringA slug that identifies which dashboard the tab is installed to, generated from a slugified Dashboard Annotation class simple name dashboardAnnotationKClass [jvm]val dashboardAnnotationKClass: KClass<out Annotation>? = null menuCategory [jvm]val menuCategory: StringA title case category used to group tabs in the dashboard menu menuLabel [jvm]val menuLabel: StringA title case name used in the dashboard menu for the link to the tab menuUrl [jvm]val menuUrl: StringUrl to the tab, by default url_path_prefix services [jvm]open override val services: Set<String>Set to show the tab only for authenticated services, else shows always slug [jvm]open override val slug: StringA unique slug to identify the tab namespace. Note: this slug must match the slug for the tab\u2019s corresponding WebTabResourceModule url_path_prefix [jvm]open override val url_path_prefix: StringA unique url path prefix to namespace tab URLs valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#functions","title":"Functions","text":"Name Summary toMetadata [jvm]fun DashboardTab.toMetadata(): DashboardMetadataAction.DashboardTabMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/-dashboard-tab/","title":"DashboardTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/DashboardTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/-dashboard-tab/#dashboardtab","title":"DashboardTab","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, dashboard_slug: String, menuLabel: String, menuCategory: String = \"\", menuUrl: String = url_path_prefix, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/access-annotation-k-class/","title":"accessAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/accessAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/access-annotation-k-class/#accessannotationkclass","title":"accessAnnotationKClass","text":"[jvm]\\ val accessAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ open override val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard-annotation-k-class/","title":"dashboardAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/dashboardAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard-annotation-k-class/#dashboardannotationkclass","title":"dashboardAnnotationKClass","text":"[jvm]\\ val dashboardAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-category/","title":"menuCategory - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/menuCategory
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-category/#menucategory","title":"menuCategory","text":"[jvm]\\ val menuCategory: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-label/","title":"menuLabel - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/menuLabel
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-label/#menulabel","title":"menuLabel","text":"[jvm]\\ val menuLabel: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-url/","title":"menuUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/menuUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-url/#menuurl","title":"menuUrl","text":"[jvm]\\ val menuUrl: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/services/","title":"services - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/services/#services","title":"services","text":"[jvm]\\ open override val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/slug/#slug","title":"slug","text":"[jvm]\\ open override val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ open override val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/","title":"DashboardTabLoader - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#dashboardtabloader","title":"DashboardTabLoader","text":"sealed class DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#inheritors","title":"Inheritors","text":"HotwireTab IframeTab"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#types","title":"Types","text":"Name Summary HotwireTab [jvm]data class HotwireTab(val urlPathPrefix: String) : DashboardTabLoader IframeTab [jvm]data class IframeTab(val urlPathPrefix: String, val iframePath: String) : DashboardTabLoader"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#properties","title":"Properties","text":"Name Summary urlPathPrefix [jvm]abstract val urlPathPrefix: StringPath prefix which resolves to the tab when visited in the browser."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ abstract val urlPathPrefix: String
Path prefix which resolves to the tab when visited in the browser.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/","title":"HotwireTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/HotwireTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/#hotwiretab","title":"HotwireTab","text":"[jvm]\\ data class HotwireTab(val urlPathPrefix: String) : DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/#constructors","title":"Constructors","text":"HotwireTab [jvm]constructor(urlPathPrefix: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/#properties","title":"Properties","text":"Name Summary urlPathPrefix [jvm]open override val urlPathPrefix: StringPath prefix which resolves to the tab when visited in the browser."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/-hotwire-tab/","title":"HotwireTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/HotwireTab/HotwireTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/-hotwire-tab/#hotwiretab","title":"HotwireTab","text":"[jvm]\\ constructor(urlPathPrefix: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/HotwireTab/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ open override val urlPathPrefix: String
Path prefix which resolves to the tab when visited in the browser.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/","title":"IframeTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/#iframetab","title":"IframeTab","text":"[jvm]\\ data class IframeTab(val urlPathPrefix: String, val iframePath: String) : DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/#constructors","title":"Constructors","text":"IframeTab [jvm]constructor(urlPathPrefix: String, iframePath: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/#properties","title":"Properties","text":"Name Summary iframePath [jvm]val iframePath: String urlPathPrefix [jvm]open override val urlPathPrefix: StringPath prefix which resolves to the tab when visited in the browser."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/-iframe-tab/","title":"IframeTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab/IframeTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/-iframe-tab/#iframetab","title":"IframeTab","text":"[jvm]\\ constructor(urlPathPrefix: String, iframePath: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/iframe-path/","title":"iframePath - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab/iframePath
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/iframe-path/#iframepath","title":"iframePath","text":"[jvm]\\ val iframePath: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ open override val urlPathPrefix: String
Path prefix which resolves to the tab when visited in the browser.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/","title":"DashboardTabLoaderEntry - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/#dashboardtabloaderentry","title":"DashboardTabLoaderEntry","text":"[jvm]\\ data class DashboardTabLoaderEntry(val urlPathPrefix: String, val loader: DashboardTabLoader)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/#constructors","title":"Constructors","text":"DashboardTabLoaderEntry [jvm]constructor(urlPathPrefix: String, loader: DashboardTabLoader)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/#properties","title":"Properties","text":"Name Summary loader [jvm]val loader: DashboardTabLoader urlPathPrefix [jvm]val urlPathPrefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/-dashboard-tab-loader-entry/","title":"DashboardTabLoaderEntry - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry/DashboardTabLoaderEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/-dashboard-tab-loader-entry/#dashboardtabloaderentry","title":"DashboardTabLoaderEntry","text":"[jvm]\\ constructor(urlPathPrefix: String, loader: DashboardTabLoader)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/loader/","title":"loader - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry/loader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/loader/#loader","title":"loader","text":"[jvm]\\ val loader: DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ val urlPathPrefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/","title":"DashboardTabProvider - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#dashboardtabprovider","title":"DashboardTabProvider","text":"[jvm]\\ class DashboardTabProvider@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val menuLabel: (appName: String, deployment: Deployment) -> String, val menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, val menuCategory: String = \"Admin\", val dashboard_slug: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>) : ValidWebEntry, Provider<DashboardTab>
Sets the tab\u2019s authentication capabilities/services by the multibound AccessAnnotationEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#constructors","title":"Constructors","text":"DashboardTabProvider [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, menuLabel: (appName: String, deployment: Deployment) -> String, menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, menuCategory: String = \"Admin\", dashboard_slug: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#properties","title":"Properties","text":"Name Summary accessAnnotationEntries [jvm]@Injectlateinit var accessAnnotationEntries: List<AccessAnnotationEntry> accessAnnotationKClass [jvm]val accessAnnotationKClass: KClass<out Annotation>? = null appName [jvm]@Injectlateinit var appName: String capabilities [jvm]val capabilities: Set<String> dashboard_slug [jvm]val dashboard_slug: String dashboardAnnotationKClass [jvm]val dashboardAnnotationKClass: KClass<out Annotation> deployment [jvm]@Injectlateinit var deployment: Deployment menuCategory [jvm]val menuCategory: String menuLabel [jvm]val menuLabel: (appName: String, deployment: Deployment) -> String menuUrl [jvm]val menuUrl: (appName: String, deployment: Deployment) -> String services [jvm]val services: Set<String> slug [jvm]val slug: String url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DashboardTab"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/-dashboard-tab-provider/","title":"DashboardTabProvider - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/DashboardTabProvider
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/-dashboard-tab-provider/#dashboardtabprovider","title":"DashboardTabProvider","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, menuLabel: (appName: String, deployment: Deployment) -> String, menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, menuCategory: String = \"Admin\", dashboard_slug: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-entries/","title":"accessAnnotationEntries - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/accessAnnotationEntries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-entries/#accessannotationentries","title":"accessAnnotationEntries","text":"[jvm]\\
@Inject
lateinit var accessAnnotationEntries: List<AccessAnnotationEntry>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-k-class/","title":"accessAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/accessAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-k-class/#accessannotationkclass","title":"accessAnnotationKClass","text":"[jvm]\\ val accessAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/app-name/","title":"appName - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/appName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/app-name/#appname","title":"appName","text":"[jvm]\\
@Inject
lateinit var appName: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard-annotation-k-class/","title":"dashboardAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/dashboardAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard-annotation-k-class/#dashboardannotationkclass","title":"dashboardAnnotationKClass","text":"[jvm]\\ val dashboardAnnotationKClass: KClass<out Annotation>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/deployment/","title":"deployment - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/deployment
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/deployment/#deployment","title":"deployment","text":"[jvm]\\
@Inject
lateinit var deployment: Deployment
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/get/","title":"get - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DashboardTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-category/","title":"menuCategory - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/menuCategory
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-category/#menucategory","title":"menuCategory","text":"[jvm]\\ val menuCategory: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-label/","title":"menuLabel - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/menuLabel
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-label/#menulabel","title":"menuLabel","text":"[jvm]\\ val menuLabel: (appName: String, deployment: Deployment) -> String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-url/","title":"menuUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/menuUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-url/#menuurl","title":"menuUrl","text":"[jvm]\\ val menuUrl: (appName: String, deployment: Deployment) -> String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/services/","title":"services - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/services/#services","title":"services","text":"[jvm]\\ val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/slug/#slug","title":"slug","text":"[jvm]\\ val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/","title":"MiskWebColor - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#miskwebcolor","title":"MiskWebColor","text":"[jvm]\\ enum MiskWebColor : Enum<MiskWebColor>
Matches the Misk-Web Color enum in @misk/core/src/utilities/css.ts
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#entries","title":"Entries","text":"RED [jvm]RED ORANGE [jvm]ORANGE YELLOW [jvm]YELLOW LIME [jvm]LIME GREEN [jvm]GREEN TEAL [jvm]TEAL BLUE [jvm]BLUE INDIGO [jvm]INDIGO PURPLE [jvm]PURPLE PLUM [jvm]PLUM ROSE [jvm]ROSE CHARCOAL [jvm]CHARCOAL TEXT [jvm]TEXT GRAY [jvm]GRAY ACCENT [jvm]ACCENT WHITE [jvm]WHITE CADET [jvm]CADET SILVER [jvm]SILVER PLATINUM [jvm]PLATINUM"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<MiskWebColor>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): MiskWebColorReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<MiskWebColor>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/entries/","title":"entries - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/entries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<MiskWebColor>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/hex-color/","title":"hexColor - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/hexColor
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/hex-color/#hexcolor","title":"hexColor","text":"[jvm]\\ val hexColor: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/value-of/","title":"valueOf - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/valueOf
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): MiskWebColor
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/values/","title":"values - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/values
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<MiskWebColor>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-a-c-c-e-n-t/","title":"ACCENT - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/ACCENT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-a-c-c-e-n-t/#accent","title":"ACCENT","text":"[jvm]\\ ACCENT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-a-c-c-e-n-t/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-b-l-u-e/","title":"BLUE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/BLUE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-b-l-u-e/#blue","title":"BLUE","text":"[jvm]\\ BLUE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-b-l-u-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-a-d-e-t/","title":"CADET - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/CADET
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-a-d-e-t/#cadet","title":"CADET","text":"[jvm]\\ CADET
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-a-d-e-t/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-h-a-r-c-o-a-l/","title":"CHARCOAL - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/CHARCOAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-h-a-r-c-o-a-l/#charcoal","title":"CHARCOAL","text":"[jvm]\\ CHARCOAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-h-a-r-c-o-a-l/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-a-y/","title":"GRAY - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/GRAY
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-a-y/#gray","title":"GRAY","text":"[jvm]\\ GRAY
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-a-y/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-e-e-n/","title":"GREEN - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/GREEN
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-e-e-n/#green","title":"GREEN","text":"[jvm]\\ GREEN
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-e-e-n/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-i-n-d-i-g-o/","title":"INDIGO - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/INDIGO
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-i-n-d-i-g-o/#indigo","title":"INDIGO","text":"[jvm]\\ INDIGO
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-i-n-d-i-g-o/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-l-i-m-e/","title":"LIME - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/LIME
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-l-i-m-e/#lime","title":"LIME","text":"[jvm]\\ LIME
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-l-i-m-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-o-r-a-n-g-e/","title":"ORANGE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/ORANGE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-o-r-a-n-g-e/#orange","title":"ORANGE","text":"[jvm]\\ ORANGE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-o-r-a-n-g-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-a-t-i-n-u-m/","title":"PLATINUM - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/PLATINUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-a-t-i-n-u-m/#platinum","title":"PLATINUM","text":"[jvm]\\ PLATINUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-a-t-i-n-u-m/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-u-m/","title":"PLUM - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/PLUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-u-m/#plum","title":"PLUM","text":"[jvm]\\ PLUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-u-m/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-u-r-p-l-e/","title":"PURPLE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/PURPLE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-u-r-p-l-e/#purple","title":"PURPLE","text":"[jvm]\\ PURPLE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-u-r-p-l-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-e-d/","title":"RED - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/RED
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-e-d/#red","title":"RED","text":"[jvm]\\ RED
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-e-d/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-o-s-e/","title":"ROSE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/ROSE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-o-s-e/#rose","title":"ROSE","text":"[jvm]\\ ROSE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-o-s-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-s-i-l-v-e-r/","title":"SILVER - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/SILVER
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-s-i-l-v-e-r/#silver","title":"SILVER","text":"[jvm]\\ SILVER
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-s-i-l-v-e-r/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-a-l/","title":"TEAL - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/TEAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-a-l/#teal","title":"TEAL","text":"[jvm]\\ TEAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-a-l/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-x-t/","title":"TEXT - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/TEXT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-x-t/#text","title":"TEXT","text":"[jvm]\\ TEXT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-x-t/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-w-h-i-t-e/","title":"WHITE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/WHITE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-w-h-i-t-e/#white","title":"WHITE","text":"[jvm]\\ WHITE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-w-h-i-t-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-y-e-l-l-o-w/","title":"YELLOW - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/YELLOW
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-y-e-l-l-o-w/#yellow","title":"YELLOW","text":"[jvm]\\ YELLOW
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-y-e-l-l-o-w/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/","title":"MiskWebTabIndexAction - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#miskwebtabindexaction","title":"MiskWebTabIndexAction","text":"[jvm]\\ @Singleton
class MiskWebTabIndexAction@Injectconstructor(dashboardTabs: List<DashboardTab>) : WebAction
Kotlin backed tab loader, equivalent to /_tab/slug/index.html
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#constructors","title":"Constructors","text":"MiskWebTabIndexAction [jvm]@Injectconstructor(dashboardTabs: List<DashboardTab>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(slug: String?): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-misk-web-tab-index-action/","title":"MiskWebTabIndexAction - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/MiskWebTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-misk-web-tab-index-action/#miskwebtabindexaction","title":"MiskWebTabIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardTabs: List<DashboardTab>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(slug: String?): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/Companion/PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/","title":"WebTab - Misk","text":"//misk-admin/misk.web.dashboard/WebTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#webtab","title":"WebTab","text":"open class WebTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf()) : ValidWebEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#inheritors","title":"Inheritors","text":"DashboardTab"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#constructors","title":"Constructors","text":"WebTab [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf())"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#properties","title":"Properties","text":"Name Summary capabilities [jvm]open val capabilities: Set<String> services [jvm]open val services: Set<String> slug [jvm]open val slug: String url_path_prefix [jvm]open val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/-web-tab/","title":"WebTab - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/WebTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/-web-tab/#webtab","title":"WebTab","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ open val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/services/","title":"services - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/services/#services","title":"services","text":"[jvm]\\ open val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/slug/#slug","title":"slug","text":"[jvm]\\ open val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ open val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/","title":"WebTabResourceModule - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#webtabresourcemodule","title":"WebTabResourceModule","text":"[jvm]\\ class WebTabResourceModule@JvmOverloadsconstructor(isDevelopment: Boolean = false, val slug: String, val web_proxy_url: String? = null, val url_path_prefix: String = \"/_tab/\", val resourcePath: String = \"classpath:/web/_tab/\") : KAbstractModule
Declare how to serve the resources for a WebTab (JS, HTML, CSS\u2026)
In Development environment, requests are proxied through to a local running build server. In all other environments, resource requests are served from the classpath.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#constructors","title":"Constructors","text":"WebTabResourceModule [jvm]constructor(deployment: Deployment, slug: String, web_proxy_url: String, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")@JvmOverloadsconstructor(isDevelopment: Boolean = false, slug: String, web_proxy_url: String? = null, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#properties","title":"Properties","text":"Name Summary resourcePath [jvm]val resourcePath: StringJVM path for non-Development environment static resources (includesclasspath:/ prefix) slug [jvm]val slug: StringA unique slug to identify the tab namespace, it must match the tab\u2019s corresponding DashboardTab multibinding url_path_prefix [jvm]val url_path_prefix: StringURL namespace used to determine where to route requests with that url prefix By Misk-Web convention, the prefix for tabs is /_tab/{slug}/ to prevent namespace collisions with dashboard urls such as /_admin/ or /app/ since path routing is by url prefix. web_proxy_url [jvm]val web_proxy_url: String? = nulla fully qualified url for the development build server (includes http:// prefix)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/-web-tab-resource-module/","title":"WebTabResourceModule - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/WebTabResourceModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/-web-tab-resource-module/#webtabresourcemodule","title":"WebTabResourceModule","text":"[jvm]\\ constructor(deployment: Deployment, slug: String, web_proxy_url: String, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")
@JvmOverloads
constructor(isDevelopment: Boolean = false, slug: String, web_proxy_url: String? = null, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/resource-path/","title":"resourcePath - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/resourcePath
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/resource-path/#resourcepath","title":"resourcePath","text":"[jvm]\\ val resourcePath: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/slug/#slug","title":"slug","text":"[jvm]\\ val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/web_proxy_url/","title":"web_proxy_url - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/web_proxy_url
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/web_proxy_url/#web_proxy_url","title":"web_proxy_url","text":"[jvm]\\ val web_proxy_url: String? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/#types","title":"Types","text":"Name Summary DashboardMetadataAction [jvm]@Singletonclass DashboardMetadataAction@Injectconstructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>) : WebActionServe metadata related to a Misk-Web Dashboard ServiceMetadataAction [jvm]@Singletonclass ServiceMetadataAction@Injectconstructor(optionalBinder: ServiceMetadataAction.OptionalBinder) : WebActionService Metadata used for front end dashboards including App Name and Misk.Deployment name"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/","title":"DashboardMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#dashboardmetadataaction","title":"DashboardMetadataAction","text":"[jvm]\\ @Singleton
class DashboardMetadataAction@Injectconstructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>) : WebAction
Serve metadata related to a Misk-Web Dashboard
Multiple dashboards with Misk-Web tabs can be bound by binding tabs to a different Dashboard Annotation. For example, all tabs used in the Misk Admin Dashboard are bound with the AdminDashboard annotation; tabs used in a service front end app, like Backfila, would be bound with a \"BackfilaApp\" annotation.
Dashboard related metadata is multibound with the slug that corresponds to a Dashboard Annotation. DashboardMetadataAction returns only the metadata for the requested dashboard.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#constructors","title":"Constructors","text":"DashboardMetadataAction [jvm]@Injectconstructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#types","title":"Types","text":"Name Summary DashboardMetadata [jvm]data class DashboardMetadata@JvmOverloadsconstructor(val home_url: String = \"\", val navbar_items: List<String> = listOf(), val navbar_status: String = \"\", val tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), val theme: MiskWebTheme? = null) DashboardTabMetadata [jvm]data class DashboardTabMetadata@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val name: String, val category: String = \"\", val capabilities: Set<String> = setOf(), val services: Set<String> = setOf()) Response [jvm]data class Response@JvmOverloadsconstructor(val dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(dashboard_slug: String): DashboardMetadataAction.Response getDashboardMetadata [jvm]fun getDashboardMetadata(caller: MiskCaller?, dashboardSlug: String): DashboardMetadataAction.DashboardMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata-action/","title":"DashboardMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata-action/#dashboardmetadataaction","title":"DashboardMetadataAction","text":"[jvm]\\
@Inject
constructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(dashboard_slug: String): DashboardMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-dashboard-metadata/","title":"getDashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/getDashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-dashboard-metadata/#getdashboardmetadata","title":"getDashboardMetadata","text":"[jvm]\\ fun getDashboardMetadata(caller: MiskCaller?, dashboardSlug: String): DashboardMetadataAction.DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/","title":"DashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/#dashboardmetadata","title":"DashboardMetadata","text":"[jvm]\\ data class DashboardMetadata@JvmOverloadsconstructor(val home_url: String = \"\", val navbar_items: List<String> = listOf(), val navbar_status: String = \"\", val tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), val theme: MiskWebTheme? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/#constructors","title":"Constructors","text":"DashboardMetadata [jvm]@JvmOverloadsconstructor(home_url: String = \"\", navbar_items: List<String> = listOf(), navbar_status: String = \"\", tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), theme: MiskWebTheme? = null)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/#properties","title":"Properties","text":"Name Summary home_url [jvm]val home_url: String navbar_items [jvm]val navbar_items: List<String> navbar_status [jvm]val navbar_status: String tabs [jvm]val tabs: List<DashboardMetadataAction.DashboardTabMetadata> theme [jvm]val theme: MiskWebTheme? = nullIf null, uses default theme that ships with Misk-Web"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/-dashboard-metadata/","title":"DashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/-dashboard-metadata/#dashboardmetadata","title":"DashboardMetadata","text":"[jvm]\\
@JvmOverloads
constructor(home_url: String = \"\", navbar_items: List<String> = listOf(), navbar_status: String = \"\", tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), theme: MiskWebTheme? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/home_url/","title":"home_url - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/home_url
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/home_url/#home_url","title":"home_url","text":"[jvm]\\ val home_url: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_items/","title":"navbar_items - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/navbar_items
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_items/#navbar_items","title":"navbar_items","text":"[jvm]\\ val navbar_items: List<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_status/","title":"navbar_status - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/navbar_status
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_status/#navbar_status","title":"navbar_status","text":"[jvm]\\ val navbar_status: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/tabs/","title":"tabs - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/tabs
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/tabs/#tabs","title":"tabs","text":"[jvm]\\ val tabs: List<DashboardMetadataAction.DashboardTabMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/theme/","title":"theme - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/theme
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/theme/#theme","title":"theme","text":"[jvm]\\ val theme: MiskWebTheme? = null
If null, uses default theme that ships with Misk-Web
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/","title":"DashboardTabMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#dashboardtabmetadata","title":"DashboardTabMetadata","text":"[jvm]\\ data class DashboardTabMetadata@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val name: String, val category: String = \"\", val capabilities: Set<String> = setOf(), val services: Set<String> = setOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#constructors","title":"Constructors","text":"DashboardTabMetadata [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, dashboard_slug: String, name: String, category: String = \"\", capabilities: Set<String> = setOf(), services: Set<String> = setOf())"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#properties","title":"Properties","text":"Name Summary capabilities [jvm]val capabilities: Set<String> category [jvm]val category: String dashboard_slug [jvm]val dashboard_slug: String name [jvm]val name: String services [jvm]val services: Set<String> slug [jvm]val slug: String url_path_prefix [jvm]val url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-dashboard-tab-metadata/","title":"DashboardTabMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/DashboardTabMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-dashboard-tab-metadata/#dashboardtabmetadata","title":"DashboardTabMetadata","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, dashboard_slug: String, name: String, category: String = \"\", capabilities: Set<String> = setOf(), services: Set<String> = setOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/category/","title":"category - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/category
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/category/#category","title":"category","text":"[jvm]\\ val category: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/services/","title":"services - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/services/#services","title":"services","text":"[jvm]\\ val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/slug/#slug","title":"slug","text":"[jvm]\\ val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/#functions","title":"Functions","text":"Name Summary toMetadata [jvm]fun DashboardTab.toMetadata(): DashboardMetadataAction.DashboardTabMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/to-metadata/","title":"toMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/Companion/toMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/to-metadata/#tometadata","title":"toMetadata","text":"[jvm]\\ fun DashboardTab.toMetadata(): DashboardMetadataAction.DashboardTabMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response@JvmOverloadsconstructor(val dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]@JvmOverloadsconstructor(dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/#properties","title":"Properties","text":"Name Summary dashboardMetadata [jvm]val dashboardMetadata: DashboardMetadataAction.DashboardMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\
@JvmOverloads
constructor(dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/dashboard-metadata/","title":"dashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/Response/dashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/dashboard-metadata/#dashboardmetadata","title":"dashboardMetadata","text":"[jvm]\\ val dashboardMetadata: DashboardMetadataAction.DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/","title":"ServiceMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#servicemetadataaction","title":"ServiceMetadataAction","text":"[jvm]\\ @Singleton
class ServiceMetadataAction@Injectconstructor(optionalBinder: ServiceMetadataAction.OptionalBinder) : WebAction
Service Metadata used for front end dashboards including App Name and Misk.Deployment name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#constructors","title":"Constructors","text":"ServiceMetadataAction [jvm]@Injectconstructor(optionalBinder: ServiceMetadataAction.OptionalBinder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#types","title":"Types","text":"Name Summary OptionalBinder [jvm]@Singletonclass OptionalBinder@Injectconstructor(val appName: String, deployment: Deployment)https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor Response [jvm]data class Response(val serviceMetadata: ServiceMetadataAction.ServiceMetadata) ServiceMetadata [jvm]data class ServiceMetadata(val app_name: String, val environment: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(): ServiceMetadataAction.Response"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata-action/","title":"ServiceMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata-action/#servicemetadataaction","title":"ServiceMetadataAction","text":"[jvm]\\
@Inject
constructor(optionalBinder: ServiceMetadataAction.OptionalBinder)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(): ServiceMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\ @Singleton
class OptionalBinder@Injectconstructor(val appName: String, deployment: Deployment)
https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/#constructors","title":"Constructors","text":"OptionalBinder [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/#properties","title":"Properties","text":"Name Summary appName [jvm]val appName: String serviceMetadata [jvm]@Inject(optional = true)var serviceMetadata: ServiceMetadataAction.ServiceMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder/OptionalBinder
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\
@Inject
constructor(appName: String, deployment: Deployment)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/app-name/","title":"appName - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder/appName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/app-name/#appname","title":"appName","text":"[jvm]\\ val appName: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/service-metadata/","title":"serviceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder/serviceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/service-metadata/#servicemetadata","title":"serviceMetadata","text":"[jvm]\\
@Inject(optional = true)
var serviceMetadata: ServiceMetadataAction.ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val serviceMetadata: ServiceMetadataAction.ServiceMetadata)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(serviceMetadata: ServiceMetadataAction.ServiceMetadata)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/#properties","title":"Properties","text":"Name Summary serviceMetadata [jvm]val serviceMetadata: ServiceMetadataAction.ServiceMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(serviceMetadata: ServiceMetadataAction.ServiceMetadata)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/service-metadata/","title":"serviceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/Response/serviceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/service-metadata/#servicemetadata","title":"serviceMetadata","text":"[jvm]\\ val serviceMetadata: ServiceMetadataAction.ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/","title":"ServiceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/#servicemetadata","title":"ServiceMetadata","text":"[jvm]\\ data class ServiceMetadata(val app_name: String, val environment: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/#constructors","title":"Constructors","text":"ServiceMetadata [jvm]constructor(app_name: String, environment: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/#properties","title":"Properties","text":"Name Summary app_name [jvm]val app_name: String environment [jvm]val environment: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/-service-metadata/","title":"ServiceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata/ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/-service-metadata/#servicemetadata","title":"ServiceMetadata","text":"[jvm]\\ constructor(app_name: String, environment: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/app_name/","title":"app_name - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata/app_name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/app_name/#app_name","title":"app_name","text":"[jvm]\\ val app_name: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/environment/","title":"environment - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata/environment
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/environment/#environment","title":"environment","text":"[jvm]\\ val environment: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.all
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/#types","title":"Types","text":"Name Summary AllMetadataAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AllMetadataAccessBind to set access for the exposed service metadata. AllMetadataAction [jvm]@Singletonclass AllMetadataAction@Injectconstructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>) : WebAction AllMetadataModule [jvm]class AllMetadataModule : KAbstractModuleThis exposes extensive metadata about your Misk application via API and admin dashboard."},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-access/","title":"AllMetadataAccess - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAccess
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-access/#allmetadataaccess","title":"AllMetadataAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class AllMetadataAccess
Bind to set access for the exposed service metadata.
// Give internal scraping services access to all metadata for the service\nmultibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<AllMetadataAccess>(\n services = listOf(\"internal_security_scraper_service\"))\n)\n//misk-admin/misk.web.metadata.all/AllMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#allmetadataaction","title":"AllMetadataAction","text":"[jvm]\\ @Singleton
class AllMetadataAction@Injectconstructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>) : WebAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#constructors","title":"Constructors","text":"AllMetadataAction [jvm]@Injectconstructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Response [jvm]data class Response(val all: Map<String, Metadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]@JvmOverloadsfun getAll(id: String? = null): AllMetadataAction.Response"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-all-metadata-action/","title":"AllMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/AllMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-all-metadata-action/#allmetadataaction","title":"AllMetadataAction","text":"[jvm]\\
@Inject
constructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\
@JvmOverloads
fun getAll(id: String? = null): AllMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Companion/PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val all: Map<String, Metadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(all: Map<String, Metadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/#properties","title":"Properties","text":"Name Summary all [jvm]val all: Map<String, Metadata>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(all: Map<String, Metadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/all/","title":"all - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Response/all
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/all/#all","title":"all","text":"[jvm]\\ val all: Map<String, Metadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-module/","title":"AllMetadataModule - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-module/#allmetadatamodule","title":"AllMetadataModule","text":"[jvm]\\ class AllMetadataModule : KAbstractModule
This exposes extensive metadata about your Misk application via API and admin dashboard.
To install and use, ensure you also add an AccessAnnotationEntry to grant endpoint access.
multibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<AllMetadataAccess>(\n services = listOf(\"security-service\")\n )\n)\n//misk-admin/misk.web.metadata.all/AllMetadataModule/AllMetadataModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-module/-all-metadata-module/#allmetadatamodule","title":"AllMetadataModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.config
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/#types","title":"Types","text":"Name Summary ConfigDashboardTabModule [jvm]class ConfigDashboardTabModule@JvmOverloadsconstructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE) : KAbstractModuleInstalls Config dashboard tab which shows the raw config inputs and the merged runtime config for your Misk service. ConfigMetadataAction [jvm]@Singletonclass ConfigMetadataAction@Injectconstructor : WebAction"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/","title":"ConfigDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/#configdashboardtabmodule","title":"ConfigDashboardTabModule","text":"[jvm]\\ class ConfigDashboardTabModule@JvmOverloadsconstructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE) : KAbstractModule
Installs Config dashboard tab which shows the raw config inputs and the merged runtime config for your Misk service.
mode If you have config parameters that include secrets, you should only install this tab in SAFE mode because the Misk secrets will be visible at runtime in the admin dashboard.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/#constructors","title":"Constructors","text":"ConfigDashboardTabModule [jvm]@JvmOverloadsconstructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/-config-dashboard-tab-module/","title":"ConfigDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigDashboardTabModule/ConfigDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/-config-dashboard-tab-module/#configdashboardtabmodule","title":"ConfigDashboardTabModule","text":"[jvm]\\
@JvmOverloads
constructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/","title":"ConfigMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/#configmetadataaction","title":"ConfigMetadataAction","text":"[jvm]\\ @Singleton
class ConfigMetadataAction@Injectconstructor : WebAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/#constructors","title":"Constructors","text":"ConfigMetadataAction [jvm]@Injectconstructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/#types","title":"Types","text":"Name Summary ConfigTabMode [jvm]enum ConfigTabMode : Enum<ConfigMetadataAction.ConfigTabMode>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-metadata-action/","title":"ConfigMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-metadata-action/#configmetadataaction","title":"ConfigMetadataAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/","title":"ConfigTabMode - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#configtabmode","title":"ConfigTabMode","text":"[jvm]\\ enum ConfigTabMode : Enum<ConfigMetadataAction.ConfigTabMode>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#entries","title":"Entries","text":"SAFE [jvm]SAFEOnly show safe content which will not leak Misk secrets SHOW_REDACTED_EFFECTIVE_CONFIG [jvm]SHOW_REDACTED_EFFECTIVE_CONFIGShow redacted effective config loaded into application, risk of leak if sensitive non-Secret fields don\u2019t have @misk.config.Redact annotation manually added. UNSAFE_LEAK_MISK_SECRETS [jvm]UNSAFE_LEAK_MISK_SECRETSShows all possible resources, YAML files are not redacted"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<ConfigMetadataAction.ConfigTabMode>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): ConfigMetadataAction.ConfigTabModeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<ConfigMetadataAction.ConfigTabMode>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/entries/","title":"entries - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/entries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<ConfigMetadataAction.ConfigTabMode>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/value-of/","title":"valueOf - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/valueOf
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): ConfigMetadataAction.ConfigTabMode
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/values/","title":"values - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/values
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<ConfigMetadataAction.ConfigTabMode>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-a-f-e/","title":"SAFE - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/SAFE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-a-f-e/#safe","title":"SAFE","text":"[jvm]\\ SAFE
Only show safe content which will not leak Misk secrets
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-a-f-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-h-o-w_-r-e-d-a-c-t-e-d_-e-f-f-e-c-t-i-v-e_-c-o-n-f-i-g/","title":"SHOW_REDACTED_EFFECTIVE_CONFIG - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/SHOW_REDACTED_EFFECTIVE_CONFIG
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-h-o-w_-r-e-d-a-c-t-e-d_-e-f-f-e-c-t-i-v-e_-c-o-n-f-i-g/#show_redacted_effective_config","title":"SHOW_REDACTED_EFFECTIVE_CONFIG","text":"[jvm]\\ SHOW_REDACTED_EFFECTIVE_CONFIG
Show redacted effective config loaded into application, risk of leak if sensitive non-Secret fields don\u2019t have @misk.config.Redact annotation manually added.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-h-o-w_-r-e-d-a-c-t-e-d_-e-f-f-e-c-t-i-v-e_-c-o-n-f-i-g/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-u-n-s-a-f-e_-l-e-a-k_-m-i-s-k_-s-e-c-r-e-t-s/","title":"UNSAFE_LEAK_MISK_SECRETS - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/UNSAFE_LEAK_MISK_SECRETS
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-u-n-s-a-f-e_-l-e-a-k_-m-i-s-k_-s-e-c-r-e-t-s/#unsafe_leak_misk_secrets","title":"UNSAFE_LEAK_MISK_SECRETS","text":"[jvm]\\ UNSAFE_LEAK_MISK_SECRETS
Shows all possible resources, YAML files are not redacted
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-u-n-s-a-f-e_-l-e-a-k_-m-i-s-k_-s-e-c-r-e-t-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.database
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/#types","title":"Types","text":"Name Summary DatabaseDashboardTabModule [jvm]class DatabaseDashboardTabModule(isDevelopment: Boolean) : KAbstractModuleInstalls Database dashboard tab which allows querying the database from a UI form. DatabaseQueryFunctionMetadata [jvm]interface DatabaseQueryFunctionMetadata DatabaseQueryMetadata [jvm]data class DatabaseQueryMetadata@JvmOverloadsconstructor(val queryWebActionPath: String, val allowedCapabilities: Set<String> = setOf(), val allowedServices: Set<String> = setOf(), val accessAnnotation: String?, val table: String, val entityClass: String, val entitySchema: Map<String, String>, val queryClass: String, val constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, val orders: List<DatabaseQueryMetadata.OrderMetadata>, val selects: List<DatabaseQueryMetadata.SelectMetadata>, val types: Map<String, MiskWebFormBuilder.Type>)Metadata front end model for Database Query Misk-Web Tab DatabaseQueryMetadataAction [jvm]@Singletonclass DatabaseQueryMetadataAction@Injectconstructor(val metadata: List<DatabaseQueryMetadata>) : WebActionDisplay available queries and their types NoAdminDashboardDatabaseAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class NoAdminDashboardDatabaseAccess"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/","title":"DatabaseDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/#databasedashboardtabmodule","title":"DatabaseDashboardTabModule","text":"[jvm]\\ class DatabaseDashboardTabModule(isDevelopment: Boolean) : KAbstractModule
Installs Database dashboard tab which allows querying the database from a UI form.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/#constructors","title":"Constructors","text":"DatabaseDashboardTabModule [jvm]constructor(isDevelopment: Boolean)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/-database-dashboard-tab-module/","title":"DatabaseDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseDashboardTabModule/DatabaseDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/-database-dashboard-tab-module/#databasedashboardtabmodule","title":"DatabaseDashboardTabModule","text":"[jvm]\\ constructor(isDevelopment: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/","title":"DatabaseQueryFunctionMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/#databasequeryfunctionmetadata","title":"DatabaseQueryFunctionMetadata","text":"interface DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/#inheritors","title":"Inheritors","text":"ConstraintMetadata OrderMetadata SelectMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/#properties","title":"Properties","text":"Name Summary name [jvm]abstract val name: StringFunction simple name parametersTypeName [jvm]abstract val parametersTypeName: StringString Type that identifies the parameters signature for the function"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryFunctionMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/name/#name","title":"name","text":"[jvm]\\ abstract val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryFunctionMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ abstract val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/","title":"DatabaseQueryMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#databasequerymetadata","title":"DatabaseQueryMetadata","text":"[jvm]\\ data class DatabaseQueryMetadata@JvmOverloadsconstructor(val queryWebActionPath: String, val allowedCapabilities: Set<String> = setOf(), val allowedServices: Set<String> = setOf(), val accessAnnotation: String?, val table: String, val entityClass: String, val entitySchema: Map<String, String>, val queryClass: String, val constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, val orders: List<DatabaseQueryMetadata.OrderMetadata>, val selects: List<DatabaseQueryMetadata.SelectMetadata>, val types: Map<String, MiskWebFormBuilder.Type>)
Metadata front end model for Database Query Misk-Web Tab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#constructors","title":"Constructors","text":"DatabaseQueryMetadata [jvm]constructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: KClass<out Annotation>? = null, table: String, entityClass: KClass<>, entitySchema: Map<String, KType>, queryClass: KClass<>?, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)@JvmOverloadsconstructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: String?, table: String, entityClass: String, entitySchema: Map<String, String>, queryClass: String, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ConstraintMetadata [jvm]data class ConstraintMetadata(val name: String, val parametersTypeName: String, val path: String, val operator: String) : DatabaseQueryFunctionMetadata OrderMetadata [jvm]data class OrderMetadata(val name: String, val parametersTypeName: String, val path: String, val ascending: Boolean) : DatabaseQueryFunctionMetadata SelectMetadata [jvm]data class SelectMetadata(val name: String, val parametersTypeName: String, val paths: List<String>) : DatabaseQueryFunctionMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#properties","title":"Properties","text":"Name Summary accessAnnotation [jvm]val accessAnnotation: String? allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String> constraints [jvm]val constraints: List<DatabaseQueryMetadata.ConstraintMetadata> entityClass [jvm]val entityClass: StringDbTable entity class entitySchema [jvm]val entitySchema: Map<String, String>Describe the DbEntity with types orders [jvm]val orders: List<DatabaseQueryMetadata.OrderMetadata> queryClass [jvm]val queryClass: StringQuery class queryWebActionPath [jvm]val queryWebActionPath: String selects [jvm]val selects: List<DatabaseQueryMetadata.SelectMetadata> table [jvm]val table: StringSQL table name types [jvm]val types: Map<String, MiskWebFormBuilder.Type>Contains all Types across all queries"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-database-query-metadata/","title":"DatabaseQueryMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/DatabaseQueryMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-database-query-metadata/#databasequerymetadata","title":"DatabaseQueryMetadata","text":"[jvm]\\ constructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: KClass<out Annotation>? = null, table: String, entityClass: KClass<>, entitySchema: Map<String, KType>, queryClass: KClass<>?, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)
@JvmOverloads
constructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: String?, table: String, entityClass: String, entitySchema: Map<String, String>, queryClass: String, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/access-annotation/","title":"accessAnnotation - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/accessAnnotation
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/access-annotation/#accessannotation","title":"accessAnnotation","text":"[jvm]\\ val accessAnnotation: String?
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/allowedCapabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"[jvm]\\ val allowedCapabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-services/","title":"allowedServices - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/allowedServices
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-services/#allowedservices","title":"allowedServices","text":"[jvm]\\ val allowedServices: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/constraints/","title":"constraints - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/constraints
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/constraints/#constraints","title":"constraints","text":"[jvm]\\ val constraints: List<DatabaseQueryMetadata.ConstraintMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-class/","title":"entityClass - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/entityClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-class/#entityclass","title":"entityClass","text":"[jvm]\\ val entityClass: String
DbTable entity class
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-schema/","title":"entitySchema - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/entitySchema
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-schema/#entityschema","title":"entitySchema","text":"[jvm]\\ val entitySchema: Map<String, String>
Describe the DbEntity with types
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/orders/","title":"orders - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/orders
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/orders/#orders","title":"orders","text":"[jvm]\\ val orders: List<DatabaseQueryMetadata.OrderMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-class/","title":"queryClass - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/queryClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-class/#queryclass","title":"queryClass","text":"[jvm]\\ val queryClass: String
Query class
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-web-action-path/","title":"queryWebActionPath - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/queryWebActionPath
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-web-action-path/#querywebactionpath","title":"queryWebActionPath","text":"[jvm]\\ val queryWebActionPath: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/selects/","title":"selects - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/selects
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/selects/#selects","title":"selects","text":"[jvm]\\ val selects: List<DatabaseQueryMetadata.SelectMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/table/","title":"table - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/table
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/table/#table","title":"table","text":"[jvm]\\ val table: String
SQL table name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/types/","title":"types - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/types
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/types/#types","title":"types","text":"[jvm]\\ val types: Map<String, MiskWebFormBuilder.Type>
Contains all Types across all queries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/#properties","title":"Properties","text":"Name Summary DYNAMIC_QUERY_KCLASS_SUFFIX [jvm]const val DYNAMIC_QUERY_KCLASS_SUFFIX: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/-d-y-n-a-m-i-c_-q-u-e-r-y_-k-c-l-a-s-s_-s-u-f-f-i-x/","title":"DYNAMIC_QUERY_KCLASS_SUFFIX - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/Companion/DYNAMIC_QUERY_KCLASS_SUFFIX
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/-d-y-n-a-m-i-c_-q-u-e-r-y_-k-c-l-a-s-s_-s-u-f-f-i-x/#dynamic_query_kclass_suffix","title":"DYNAMIC_QUERY_KCLASS_SUFFIX","text":"[jvm]\\ const val DYNAMIC_QUERY_KCLASS_SUFFIX: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/","title":"ConstraintMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/#constraintmetadata","title":"ConstraintMetadata","text":"[jvm]\\ data class ConstraintMetadata(val name: String, val parametersTypeName: String, val path: String, val operator: String) : DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/#constructors","title":"Constructors","text":"ConstraintMetadata [jvm]constructor(name: String, parametersTypeName: String, path: String, operator: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: StringFunction simple name operator [jvm]val operator: String parametersTypeName [jvm]open override val parametersTypeName: StringString Type that identifies the parameters signature for the function path [jvm]val path: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/-constraint-metadata/","title":"ConstraintMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/ConstraintMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/-constraint-metadata/#constraintmetadata","title":"ConstraintMetadata","text":"[jvm]\\ constructor(name: String, parametersTypeName: String, path: String, operator: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/name/#name","title":"name","text":"[jvm]\\ open override val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/operator/","title":"operator - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/operator
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/operator/#operator","title":"operator","text":"[jvm]\\ val operator: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ open override val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/path/","title":"path - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/path
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/","title":"OrderMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/#ordermetadata","title":"OrderMetadata","text":"[jvm]\\ data class OrderMetadata(val name: String, val parametersTypeName: String, val path: String, val ascending: Boolean) : DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/#constructors","title":"Constructors","text":"OrderMetadata [jvm]constructor(name: String, parametersTypeName: String, path: String, ascending: Boolean)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/#properties","title":"Properties","text":"Name Summary ascending [jvm]val ascending: Boolean name [jvm]open override val name: StringFunction simple name parametersTypeName [jvm]open override val parametersTypeName: StringString Type that identifies the parameters signature for the function path [jvm]val path: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/-order-metadata/","title":"OrderMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/OrderMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/-order-metadata/#ordermetadata","title":"OrderMetadata","text":"[jvm]\\ constructor(name: String, parametersTypeName: String, path: String, ascending: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/ascending/","title":"ascending - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/ascending
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/ascending/#ascending","title":"ascending","text":"[jvm]\\ val ascending: Boolean
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/name/#name","title":"name","text":"[jvm]\\ open override val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ open override val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/path/","title":"path - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/path
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/","title":"SelectMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/#selectmetadata","title":"SelectMetadata","text":"[jvm]\\ data class SelectMetadata(val name: String, val parametersTypeName: String, val paths: List<String>) : DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/#constructors","title":"Constructors","text":"SelectMetadata [jvm]constructor(name: String, parametersTypeName: String, paths: List<String>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: StringFunction simple name parametersTypeName [jvm]open override val parametersTypeName: StringString Type that identifies the parameters signature for the function paths [jvm]val paths: List<String>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/-select-metadata/","title":"SelectMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/SelectMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/-select-metadata/#selectmetadata","title":"SelectMetadata","text":"[jvm]\\ constructor(name: String, parametersTypeName: String, paths: List<String>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/name/#name","title":"name","text":"[jvm]\\ open override val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ open override val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/paths/","title":"paths - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/paths
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/paths/#paths","title":"paths","text":"[jvm]\\ val paths: List<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/","title":"DatabaseQueryMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#databasequerymetadataaction","title":"DatabaseQueryMetadataAction","text":"[jvm]\\ @Singleton
class DatabaseQueryMetadataAction@Injectconstructor(val metadata: List<DatabaseQueryMetadata>) : WebAction
Display available queries and their types
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#constructors","title":"Constructors","text":"DatabaseQueryMetadataAction [jvm]@Injectconstructor(metadata: List<DatabaseQueryMetadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#types","title":"Types","text":"Name Summary Response [jvm]data class Response(val databaseQueryMetadata: List<DatabaseQueryMetadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#properties","title":"Properties","text":"Name Summary metadata [jvm]val metadata: List<DatabaseQueryMetadata>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(): DatabaseQueryMetadataAction.Response"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-database-query-metadata-action/","title":"DatabaseQueryMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/DatabaseQueryMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-database-query-metadata-action/#databasequerymetadataaction","title":"DatabaseQueryMetadataAction","text":"[jvm]\\
@Inject
constructor(metadata: List<DatabaseQueryMetadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(): DatabaseQueryMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/metadata/","title":"metadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/metadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/metadata/#metadata","title":"metadata","text":"[jvm]\\ val metadata: List<DatabaseQueryMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val databaseQueryMetadata: List<DatabaseQueryMetadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(databaseQueryMetadata: List<DatabaseQueryMetadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/#properties","title":"Properties","text":"Name Summary databaseQueryMetadata [jvm]val databaseQueryMetadata: List<DatabaseQueryMetadata>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(databaseQueryMetadata: List<DatabaseQueryMetadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/database-query-metadata/","title":"databaseQueryMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/Response/databaseQueryMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/database-query-metadata/#databasequerymetadata","title":"databaseQueryMetadata","text":"[jvm]\\ val databaseQueryMetadata: List<DatabaseQueryMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-no-admin-dashboard-database-access/","title":"NoAdminDashboardDatabaseAccess - Misk","text":"//misk-admin/misk.web.metadata.database/NoAdminDashboardDatabaseAccess
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-no-admin-dashboard-database-access/#noadmindashboarddatabaseaccess","title":"NoAdminDashboardDatabaseAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class NoAdminDashboardDatabaseAccess
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.guice
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/#types","title":"Types","text":"Name Summary GuiceDashboardTabModule [jvm]class GuiceDashboardTabModule : KAbstractModule GuiceTabIndexAction [jvm]@Singletonclass GuiceTabIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider) : WebAction"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/","title":"GuiceDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/#guicedashboardtabmodule","title":"GuiceDashboardTabModule","text":"[jvm]\\ class GuiceDashboardTabModule : KAbstractModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/#constructors","title":"Constructors","text":"GuiceDashboardTabModule [jvm]constructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/-guice-dashboard-tab-module/","title":"GuiceDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceDashboardTabModule/GuiceDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/-guice-dashboard-tab-module/#guicedashboardtabmodule","title":"GuiceDashboardTabModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/","title":"GuiceTabIndexAction - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#guicetabindexaction","title":"GuiceTabIndexAction","text":"[jvm]\\ @Singleton
class GuiceTabIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider) : WebAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#constructors","title":"Constructors","text":"GuiceTabIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-guice-tab-index-action/","title":"GuiceTabIndexAction - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/GuiceTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-guice-tab-index-action/#guicetabindexaction","title":"GuiceTabIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/Companion/PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.webaction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/#types","title":"Types","text":"Name Summary WebActionsDashboardTabModule [jvm]class WebActionsDashboardTabModule(isDevelopment: Boolean) : KAbstractModuleInstalls WebActions dashboard tab which allows introspection and exercising actions from a UI form."},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/","title":"WebActionsDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.webaction/WebActionsDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/#webactionsdashboardtabmodule","title":"WebActionsDashboardTabModule","text":"[jvm]\\ class WebActionsDashboardTabModule(isDevelopment: Boolean) : KAbstractModule
Installs WebActions dashboard tab which allows introspection and exercising actions from a UI form.
This installs both versions of the WebActions tab, v1 and v2.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/#constructors","title":"Constructors","text":"WebActionsDashboardTabModule [jvm]constructor(isDevelopment: Boolean)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/-web-actions-dashboard-tab-module/","title":"WebActionsDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.webaction/WebActionsDashboardTabModule/WebActionsDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/-web-actions-dashboard-tab-module/#webactionsdashboardtabmodule","title":"WebActionsDashboardTabModule","text":"[jvm]\\ constructor(isDevelopment: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/","title":"Index","text":"//misk-admin/misk.web.v2
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/#types","title":"Types","text":"Name Summary DashboardHotwireTabAction [jvm]@Singletonclass DashboardHotwireTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebActionBuilds dashboard UI and loads Hotwire tab. DashboardIFrameTabAction [jvm]@Singletonclass DashboardIFrameTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebActionBuilds dashboard UI and loads IFrame tab. DashboardIndexAccessBlock [jvm]data class DashboardIndexAccessBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit)Bind to set custom access notice for the dashboard home page. DashboardIndexAction [jvm]@Singletonclass DashboardIndexAction@Injectconstructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment) : WebActionBuilds dashboard UI for index homepage. DashboardIndexBlock [jvm]data class DashboardIndexBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.() -> Unit)Bind to set custom content for the dashboard home page. DashboardPageLayout [jvm]class DashboardPageLayout@Injectconstructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)Builds dashboard UI for index homepage. NavbarModule [jvm]class NavbarModule : KAbstractModule"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/#functions","title":"Functions","text":"Name Summary DashboardIndexAccessBlock [jvm]inline fun <T : Annotation> DashboardIndexAccessBlock(noinline block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit): DashboardIndexAccessBlock DashboardIndexBlock [jvm]inline fun <T : Annotation> DashboardIndexBlock(noinline block: TagConsumer<*>.() -> Unit): DashboardIndexBlock HtmlLayout [jvm]fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)Default setup of HTML for a page including head and install of CSS/JS dependencies."},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/","title":"DashboardIndexAccessBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/#dashboardindexaccessblock","title":"DashboardIndexAccessBlock","text":"[jvm]\\ inline fun <T : Annotation> DashboardIndexAccessBlock(noinline block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit): DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/","title":"DashboardIndexBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/#dashboardindexblock","title":"DashboardIndexBlock","text":"[jvm]\\ inline fun <T : Annotation> DashboardIndexBlock(noinline block: TagConsumer<*>.() -> Unit): DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-html-layout/","title":"html layout","text":"//misk-admin/misk.web.v2/HtmlLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-html-layout/#htmllayout","title":"HtmlLayout","text":"[jvm]\\ fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)
Default setup of HTML for a page including head and install of CSS/JS dependencies.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/","title":"DashboardHotwireTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardHotwireTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/#dashboardhotwiretabaction","title":"DashboardHotwireTabAction","text":"[jvm]\\ @Singleton
class DashboardHotwireTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebAction
Builds dashboard UI and loads Hotwire tab.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/#constructors","title":"Constructors","text":"DashboardHotwireTabAction [jvm]@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(suffix: String?): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/-dashboard-hotwire-tab-action/","title":"DashboardHotwireTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardHotwireTabAction/DashboardHotwireTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/-dashboard-hotwire-tab-action/#dashboardhotwiretabaction","title":"DashboardHotwireTabAction","text":"[jvm]\\
@Inject
constructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.v2/DashboardHotwireTabAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/get/#get","title":"get","text":"[jvm]\\ fun get(suffix: String?): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/","title":"DashboardIFrameTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIFrameTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/#dashboardiframetabaction","title":"DashboardIFrameTabAction","text":"[jvm]\\ @Singleton
class DashboardIFrameTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebAction
Builds dashboard UI and loads IFrame tab.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/#constructors","title":"Constructors","text":"DashboardIFrameTabAction [jvm]@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(suffix: String?): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/-dashboard-i-frame-tab-action/","title":"DashboardIFrameTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIFrameTabAction/DashboardIFrameTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/-dashboard-i-frame-tab-action/#dashboardiframetabaction","title":"DashboardIFrameTabAction","text":"[jvm]\\
@Inject
constructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.v2/DashboardIFrameTabAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/get/#get","title":"get","text":"[jvm]\\ fun get(suffix: String?): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/","title":"DashboardIndexAccessBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/#dashboardindexaccessblock","title":"DashboardIndexAccessBlock","text":"[jvm]\\ data class DashboardIndexAccessBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit)
Bind to set custom access notice for the dashboard home page.
multibind<DashboardIndexAccessBlock>().toInstance(\n DashboardIndexAccessBlock<AdminDashboard>() {\n p { +\"\"\"You have access to ${authenticatedTabs.size} / ${dashboardTabs.size} tabs.\"\"\" }\n p { +\"\"\"Add the necessary permissions to your user in the company registry.\"\"\" }\n }\n)\n//misk-admin/misk.web.v2/DashboardIndexAccessBlock/DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/-dashboard-index-access-block/#dashboardindexaccessblock","title":"DashboardIndexAccessBlock","text":"[jvm]\\
@JvmOverloads
constructor(annotation: KClass<out Annotation>, block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/annotation/","title":"annotation - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock/annotation
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: KClass<out Annotation>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/block/","title":"block - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock/block
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/block/#block","title":"block","text":"[jvm]\\ val block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/","title":"DashboardIndexAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#dashboardindexaction","title":"DashboardIndexAction","text":"[jvm]\\ @Singleton
class DashboardIndexAction@Injectconstructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment) : WebAction
Builds dashboard UI for index homepage.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#constructors","title":"Constructors","text":"DashboardIndexAction [jvm]@Injectconstructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-dashboard-index-action/","title":"DashboardIndexAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/DashboardIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-dashboard-index-action/#dashboardindexaction","title":"DashboardIndexAction","text":"[jvm]\\
@Inject
constructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/#functions","title":"Functions","text":"Name Summary titlecase [jvm]fun KClass<out Annotation>.titlecase(): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/titlecase/","title":"titlecase - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/Companion/titlecase
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/titlecase/#titlecase","title":"titlecase","text":"[jvm]\\ fun KClass<out Annotation>.titlecase(): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/","title":"DashboardIndexBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/#dashboardindexblock","title":"DashboardIndexBlock","text":"[jvm]\\ data class DashboardIndexBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.() -> Unit)
Bind to set custom content for the dashboard home page.
multibind<DashboardIndexBlock>().toInstance(\n DashboardIndexBlock(\n p { +\"\"\"This content will show up on the dashboard homepage.\"\"\" }\n )\n)\n//misk-admin/misk.web.v2/DashboardIndexBlock/DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/-dashboard-index-block/#dashboardindexblock","title":"DashboardIndexBlock","text":"[jvm]\\
@JvmOverloads
constructor(annotation: KClass<out Annotation>, block: TagConsumer<*>.() -> Unit)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/annotation/","title":"annotation - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock/annotation
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: KClass<out Annotation>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/block/","title":"block - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock/block
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/block/#block","title":"block","text":"[jvm]\\ val block: TagConsumer<*>.() -> Unit
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/","title":"Index","text":"//misk-admin/misk.web.v2/DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#dashboardpagelayout","title":"DashboardPageLayout","text":"[jvm]\\ class DashboardPageLayout@Injectconstructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)
Builds dashboard UI for index homepage.
Must be called within a Web Action.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#constructors","title":"Constructors","text":"DashboardPageLayout [jvm]@Injectconstructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#functions","title":"Functions","text":"Name Summary build [jvm]@JvmOverloadsfun build(tabBlock: TagConsumer<*>.(appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> Unit = { _, _, _ -> Unit }): String headBlock [jvm]fun headBlock(block: TagConsumer<*>.() -> Unit): DashboardPageLayout newBuilder [jvm]fun newBuilder(): DashboardPageLayout title [jvm]fun title(title: (appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> String): DashboardPageLayout"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-dashboard-page-layout/","title":"DashboardPageLayout - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-dashboard-page-layout/#dashboardpagelayout","title":"DashboardPageLayout","text":"[jvm]\\
@Inject
constructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/build/","title":"build - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/build
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/build/#build","title":"build","text":"[jvm]\\
@JvmOverloads
fun build(tabBlock: TagConsumer<*>.(appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> Unit = { _, _, _ -> Unit }): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/head-block/","title":"headBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/headBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/head-block/#headblock","title":"headBlock","text":"[jvm]\\ fun headBlock(block: TagConsumer<*>.() -> Unit): DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/new-builder/","title":"newBuilder - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/newBuilder
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ fun newBuilder(): DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/title/","title":"Title","text":"//misk-admin/misk.web.v2/DashboardPageLayout/title
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/title/#title","title":"title","text":"[jvm]\\ fun title(title: (appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> String): DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/#properties","title":"Properties","text":"Name Summary ADMIN_DASHBOARD_PATH [jvm]const val ADMIN_DASHBOARD_PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/-a-d-m-i-n_-d-a-s-h-b-o-a-r-d_-p-a-t-h/","title":"ADMIN_DASHBOARD_PATH - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/Companion/ADMIN_DASHBOARD_PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/-a-d-m-i-n_-d-a-s-h-b-o-a-r-d_-p-a-t-h/#admin_dashboard_path","title":"ADMIN_DASHBOARD_PATH","text":"[jvm]\\ const val ADMIN_DASHBOARD_PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/","title":"NavbarModule - Misk","text":"//misk-admin/misk.web.v2/NavbarModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/#navbarmodule","title":"NavbarModule","text":"[jvm]\\ class NavbarModule : KAbstractModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/#constructors","title":"Constructors","text":"NavbarModule [jvm]constructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/-navbar-module/","title":"NavbarModule - Misk","text":"//misk-admin/misk.web.v2/NavbarModule/NavbarModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/-navbar-module/#navbarmodule","title":"NavbarModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-api/","title":"misk-api - Misk","text":"//misk-api
"},{"location":"0.x/misk-api/#misk-api","title":"misk-api","text":""},{"location":"0.x/misk-api/#packages","title":"Packages","text":"Name misk.annotation misk.api misk.client misk.logging misk.scope misk.web misk.web.dashboard"},{"location":"0.x/misk-api/misk-api/misk.annotation/","title":"Package-level declarations - Misk","text":"//misk-api/misk.annotation
"},{"location":"0.x/misk-api/misk-api/misk.annotation/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.annotation/#types","title":"Types","text":"Name Summary ExperimentalMiskApi [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])annotation class ExperimentalMiskApiMarks declarations that are experimental and subject to change without following SemVer conventions. Both binary and source-incompatible changes are possible, including complete removal of the experimental API."},{"location":"0.x/misk-api/misk-api/misk.annotation/-experimental-misk-api/","title":"ExperimentalMiskApi - Misk","text":"//misk-api/misk.annotation/ExperimentalMiskApi
"},{"location":"0.x/misk-api/misk-api/misk.annotation/-experimental-misk-api/#experimentalmiskapi","title":"ExperimentalMiskApi","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalMiskApi
Marks declarations that are experimental and subject to change without following SemVer conventions. Both binary and source-incompatible changes are possible, including complete removal of the experimental API.
Do not use these APIs in modules that may be executed using a version of Misk different from the version the module was compiled with.
Do not use these APIs in published libraries.
Do not use these APIs if you aren\u2019t willing to track changes to them.
"},{"location":"0.x/misk-api/misk-api/misk.api/","title":"Package-level declarations - Misk","text":"//misk-api/misk.api
"},{"location":"0.x/misk-api/misk-api/misk.api/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.api/#types","title":"Types","text":"Name Summary HttpRequest [jvm]interface HttpRequestRepresents the current incoming request. Misk makes an instance of this interface available in the action scope with theHttpRequest key, for use in interceptors, other action scope providers, etc.."},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/","title":"HttpRequest - Misk","text":"//misk-api/misk.api/HttpRequest
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/#httprequest","title":"HttpRequest","text":"[jvm]\\ interface HttpRequest
Represents the current incoming request. Misk makes an instance of this interface available in the action scope with the HttpRequest key, for use in interceptors, other action scope providers, etc..
//misk-api/misk.api/HttpRequest/dispatchMechanism
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"[jvm]\\ abstract val dispatchMechanism: DispatchMechanism
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/request-headers/","title":"requestHeaders - Misk","text":"//misk-api/misk.api/HttpRequest/requestHeaders
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/request-headers/#requestheaders","title":"requestHeaders","text":"[jvm]\\ abstract var requestHeaders: Headers
HTTP request headers that may be modified via interception.
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/url/","title":"url - Misk","text":"//misk-api/misk.api/HttpRequest/url
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/url/#url","title":"url","text":"[jvm]\\ abstract val url: HttpUrl
"},{"location":"0.x/misk-api/misk-api/misk.client/","title":"Package-level declarations - Misk","text":"//misk-api/misk.client
"},{"location":"0.x/misk-api/misk-api/misk.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.client/#types","title":"Types","text":"Name Summary ClientAction [jvm]data class ClientAction(val name: String, val function: KFunction<*>, val parameterTypes: List<KType>, val returnType: KType)Metadata about a client action ClientNetworkChain [jvm]interface ClientNetworkChain ClientNetworkInterceptor [jvm]interface ClientNetworkInterceptorIntercepts client side calls at the application level, able to view and modify the outgoing HTTP request and observe the returned HTTP response NetworkInterceptorWrapper [jvm]class NetworkInterceptorWrapper(val action: ClientAction, val interceptor: ClientNetworkInterceptor) : Interceptor"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/","title":"ClientAction - Misk","text":"//misk-api/misk.client/ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/#clientaction","title":"ClientAction","text":"[jvm]\\ data class ClientAction(val name: String, val function: KFunction<*>, val parameterTypes: List<KType>, val returnType: KType)
Metadata about a client action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/#constructors","title":"Constructors","text":"ClientAction [jvm]constructor(clientName: String, method: KFunction<>)constructor(name: String, function: KFunction<>, parameterTypes: List<KType>, returnType: KType)"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/#properties","title":"Properties","text":"Name Summary function [jvm]val function: KFunction<*>The function that was used to invoke the action name [jvm]val name: StringThe name of the action, composed of the name of the client + the name of the method parameterTypes [jvm]val parameterTypes: List<KType>The parameter types to the action returnType [jvm]val returnType: KTypeThe return type fo the action"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/-client-action/","title":"ClientAction - Misk","text":"//misk-api/misk.client/ClientAction/ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/-client-action/#clientaction","title":"ClientAction","text":"[jvm]\\ constructor(clientName: String, method: KFunction<*>)
constructor(name: String, function: KFunction<*>, parameterTypes: List<KType>, returnType: KType)
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/function/","title":"function - Misk","text":"//misk-api/misk.client/ClientAction/function
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/function/#function","title":"function","text":"[jvm]\\ val function: KFunction<*>
The function that was used to invoke the action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/name/","title":"name - Misk","text":"//misk-api/misk.client/ClientAction/name
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/name/#name","title":"name","text":"[jvm]\\ val name: String
The name of the action, composed of the name of the client + the name of the method
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/parameter-types/","title":"parameterTypes - Misk","text":"//misk-api/misk.client/ClientAction/parameterTypes
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/parameter-types/#parametertypes","title":"parameterTypes","text":"[jvm]\\ val parameterTypes: List<KType>
The parameter types to the action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/return-type/","title":"returnType - Misk","text":"//misk-api/misk.client/ClientAction/returnType
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/return-type/#returntype","title":"returnType","text":"[jvm]\\ val returnType: KType
The return type fo the action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/","title":"ClientNetworkChain - Misk","text":"//misk-api/misk.client/ClientNetworkChain
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/#clientnetworkchain","title":"ClientNetworkChain","text":"[jvm]\\ interface ClientNetworkChain
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction request [jvm]abstract val request: Request"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(request: Request): Response"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/action/","title":"action - Misk","text":"//misk-api/misk.client/ClientNetworkChain/action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/proceed/","title":"proceed - Misk","text":"//misk-api/misk.client/ClientNetworkChain/proceed
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(request: Request): Response
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/request/","title":"request - Misk","text":"//misk-api/misk.client/ClientNetworkChain/request
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/request/#request","title":"request","text":"[jvm]\\ abstract val request: Request
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/","title":"ClientNetworkInterceptor - Misk","text":"//misk-api/misk.client/ClientNetworkInterceptor
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/#clientnetworkinterceptor","title":"ClientNetworkInterceptor","text":"[jvm]\\ interface ClientNetworkInterceptor
Intercepts client side calls at the application level, able to view and modify the outgoing HTTP request and observe the returned HTTP response
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: ClientNetworkChain): Response"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/intercept/","title":"intercept - Misk","text":"//misk-api/misk.client/ClientNetworkInterceptor/intercept
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ abstract fun intercept(chain: ClientNetworkChain): Response
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/-factory/","title":"Factory - Misk","text":"//misk-api/misk.client/ClientNetworkInterceptor/Factory
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ interface Factory
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<ClientNetworkInterceptor.Factory>().to<MyFactory>()\n//misk-api/misk.client/ClientNetworkInterceptor/Factory/create
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: ClientAction): ClientNetworkInterceptor?
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/","title":"NetworkInterceptorWrapper - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#networkinterceptorwrapper","title":"NetworkInterceptorWrapper","text":"[jvm]\\ class NetworkInterceptorWrapper(val action: ClientAction, val interceptor: ClientNetworkInterceptor) : Interceptor
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#constructors","title":"Constructors","text":"NetworkInterceptorWrapper [jvm]constructor(action: ClientAction, interceptor: ClientNetworkInterceptor)"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#properties","title":"Properties","text":"Name Summary action [jvm]val action: ClientAction interceptor [jvm]val interceptor: ClientNetworkInterceptor"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): Response"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/-network-interceptor-wrapper/","title":"NetworkInterceptorWrapper - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/NetworkInterceptorWrapper
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/-network-interceptor-wrapper/#networkinterceptorwrapper","title":"NetworkInterceptorWrapper","text":"[jvm]\\ constructor(action: ClientAction, interceptor: ClientNetworkInterceptor)
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/action/","title":"action - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/action
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/action/#action","title":"action","text":"[jvm]\\ val action: ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/intercept/","title":"intercept - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/intercept
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/interceptor/","title":"interceptor - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/interceptor
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/interceptor/#interceptor","title":"interceptor","text":"[jvm]\\ val interceptor: ClientNetworkInterceptor
"},{"location":"0.x/misk-api/misk-api/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-api/misk.logging
"},{"location":"0.x/misk-api/misk-api/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.logging/#types","title":"Types","text":"Name Summary Mdc [jvm]interface Mdc"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/","title":"Mdc - Misk","text":"//misk-api/misk.logging/Mdc
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/#mdc","title":"Mdc","text":"[jvm]\\ interface Mdc
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/#functions","title":"Functions","text":"Name Summary clear [jvm]abstract fun clear() get [jvm]abstract fun get(key: String): String? put [jvm]abstract fun put(key: String, value: String?)"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/clear/","title":"clear - Misk","text":"//misk-api/misk.logging/Mdc/clear
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/clear/#clear","title":"clear","text":"[jvm]\\ abstract fun clear()
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/get/","title":"get - Misk","text":"//misk-api/misk.logging/Mdc/get
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/get/#get","title":"get","text":"[jvm]\\ abstract fun get(key: String): String?
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/put/","title":"put - Misk","text":"//misk-api/misk.logging/Mdc/put
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/put/#put","title":"put","text":"[jvm]\\ abstract fun put(key: String, value: String?)
"},{"location":"0.x/misk-api/misk-api/misk.scope/","title":"Package-level declarations - Misk","text":"//misk-api/misk.scope
"},{"location":"0.x/misk-api/misk-api/misk.scope/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.scope/#types","title":"Types","text":"Name Summary ActionScoped [jvm]interface ActionScoped<out T>Provides access to a context object specific to the current action ActionScopedProvider [jvm]interface ActionScopedProvider<out T>An ActionScopedProvider is implemented by components and application code that wants provide contextual information based on an incoming request, job data, etc."},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/","title":"ActionScoped - Misk","text":"//misk-api/misk.scope/ActionScoped
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/#actionscoped","title":"ActionScoped","text":"[jvm]\\ interface ActionScoped<out T>
Provides access to a context object specific to the current action
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(): T getIfInScope [jvm]open fun getIfInScope(): T?"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get-if-in-scope/","title":"getIfInScope - Misk","text":"//misk-api/misk.scope/ActionScoped/getIfInScope
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get-if-in-scope/#getifinscope","title":"getIfInScope","text":"[jvm]\\ open fun getIfInScope(): T?
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get/","title":"get - Misk","text":"//misk-api/misk.scope/ActionScoped/get
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get/#get","title":"get","text":"[jvm]\\ abstract fun get(): T
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/","title":"Companion - Misk","text":"//misk-api/misk.scope/ActionScoped/Companion
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/#functions","title":"Functions","text":"Name Summary of [jvm]fun <T> of(value: T): ActionScoped<T>"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/of/","title":"of - Misk","text":"//misk-api/misk.scope/ActionScoped/Companion/of
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/of/#of","title":"of","text":"[jvm]\\ fun <T> of(value: T): ActionScoped<T>
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/of/#return","title":"Return","text":"an ActionScoped hard-coded to a specific value, useful for tests
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/","title":"ActionScopedProvider - Misk","text":"//misk-api/misk.scope/ActionScopedProvider
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/#actionscopedprovider","title":"ActionScopedProvider","text":"[jvm]\\ interface ActionScopedProvider<out T>
An ActionScopedProvider is implemented by components and application code that wants provide contextual information based on an incoming request, job data, etc.
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(): T"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/get/","title":"get - Misk","text":"//misk-api/misk.scope/ActionScopedProvider/get
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/get/#get","title":"get","text":"[jvm]\\ abstract fun get(): T
"},{"location":"0.x/misk-api/misk-api/misk.web/","title":"Package-level declarations - Misk","text":"//misk-api/misk.web
"},{"location":"0.x/misk-api/misk-api/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.web/#types","title":"Types","text":"Name Summary DispatchMechanism [jvm]enum DispatchMechanism : Enum<DispatchMechanism> Describes how an action is processed. This is like the HTTP method but has special cases for web sockets and gRPC. These protocols layer on top of HTTP methods and have different semantics."},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/","title":"DispatchMechanism - Misk","text":"//misk-api/misk.web/DispatchMechanism
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#dispatchmechanism","title":"DispatchMechanism","text":"[jvm]\\ enum DispatchMechanism : Enum<DispatchMechanism>
Describes how an action is processed. This is like the HTTP method but has special cases for web sockets and gRPC. These protocols layer on top of HTTP methods and have different semantics.
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#entries","title":"Entries","text":"GET [jvm]GET POST [jvm]POST PATCH [jvm]PATCH PUT [jvm]PUT DELETE [jvm]DELETE GRPC [jvm]GRPC WEBSOCKET [jvm]WEBSOCKET"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<DispatchMechanism>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): DispatchMechanismReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<DispatchMechanism>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/entries/","title":"entries - Misk","text":"//misk-api/misk.web/DispatchMechanism/entries
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<DispatchMechanism>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/method/","title":"method - Misk","text":"//misk-api/misk.web/DispatchMechanism/method
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/method/#method","title":"method","text":"[jvm]\\ val method: String
Returns the method used when a call entered the service.
This can be misleading: web sockets don\u2019t behave like normal GETs (they are upgraded), and GRPC calls don\u2019t behave like normal POSTS (they are duplex).
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/value-of/","title":"valueOf - Misk","text":"//misk-api/misk.web/DispatchMechanism/valueOf
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): DispatchMechanism
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/values/","title":"values - Misk","text":"//misk-api/misk.web/DispatchMechanism/values
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<DispatchMechanism>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-d-e-l-e-t-e/","title":"DELETE - Misk","text":"//misk-api/misk.web/DispatchMechanism/DELETE
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-d-e-l-e-t-e/#delete","title":"DELETE","text":"[jvm]\\ DELETE
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-d-e-l-e-t-e/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-e-t/","title":"GET - Misk","text":"//misk-api/misk.web/DispatchMechanism/GET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-e-t/#get","title":"GET","text":"[jvm]\\ GET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-e-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-r-p-c/","title":"GRPC - Misk","text":"//misk-api/misk.web/DispatchMechanism/GRPC
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-r-p-c/#grpc","title":"GRPC","text":"[jvm]\\ GRPC
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-r-p-c/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-a-t-c-h/","title":"PATCH - Misk","text":"//misk-api/misk.web/DispatchMechanism/PATCH
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-a-t-c-h/#patch","title":"PATCH","text":"[jvm]\\ PATCH
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-a-t-c-h/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-o-s-t/","title":"POST - Misk","text":"//misk-api/misk.web/DispatchMechanism/POST
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-o-s-t/#post","title":"POST","text":"[jvm]\\ POST
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-o-s-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-u-t/","title":"PUT - Misk","text":"//misk-api/misk.web/DispatchMechanism/PUT
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-u-t/#put","title":"PUT","text":"[jvm]\\ PUT
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-u-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-w-e-b-s-o-c-k-e-t/","title":"WEBSOCKET - Misk","text":"//misk-api/misk.web/DispatchMechanism/WEBSOCKET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-w-e-b-s-o-c-k-e-t/#websocket","title":"WEBSOCKET","text":"[jvm]\\ WEBSOCKET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-w-e-b-s-o-c-k-e-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/","title":"Package-level declarations - Misk","text":"//misk-api/misk.web.dashboard
"},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/#types","title":"Types","text":"Name Summary AdminDashboardAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AdminDashboardAccessBind to set access for the Misk Admin Dashboard."},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/-admin-dashboard-access/","title":"AdminDashboardAccess - Misk","text":"//misk-api/misk.web.dashboard/AdminDashboardAccess
"},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/-admin-dashboard-access/#admindashboardaccess","title":"AdminDashboardAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class AdminDashboardAccess
Bind to set access for the Misk Admin Dashboard.
// Give engineers access to the admin dashboard for Exemplar service\nmultibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<AdminDashboardAccess>(\n capabilities = listOf(\"admin_console\"))\n)\n//misk-aws
"},{"location":"0.x/misk-aws/#misk-aws","title":"misk-aws","text":""},{"location":"0.x/misk-aws/#packages","title":"Packages","text":"Name misk.cloud.aws misk.jobqueue.sqs misk.s3"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/","title":"Package-level declarations - Misk","text":"//misk-aws/misk.cloud.aws
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/#types","title":"Types","text":"Name Summary AwsAccountId [jvm]data class AwsAccountId(val value: String)AwsAccountId is the id of the account in which the service is running AwsEnvironmentModule [jvm]class AwsEnvironmentModule : KAbstractModuleAwsEnvironmentModule pulls region and account information from installed env vars AwsRegion [jvm]data class AwsRegion(val name: String)AwsRegion is the region in which the service is running FakeAwsEnvironmentModule [jvm]class FakeAwsEnvironmentModule : KAbstractModuleFakeAwsEnvironmentModule pulls region and account information from an in memory map."},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/#functions","title":"Functions","text":"Name Summary toMiskAwsAccountId [jvm]fun AwsAccountId.toMiskAwsAccountId(): AwsAccountId toMiskAwsRegion [jvm]fun AwsRegion.toMiskAwsRegion(): AwsRegion"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-account-id/","title":"toMiskAwsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/toMiskAwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-account-id/#tomiskawsaccountid","title":"toMiskAwsAccountId","text":"[jvm]\\ fun AwsAccountId.toMiskAwsAccountId(): AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-region/","title":"toMiskAwsRegion - Misk","text":"//misk-aws/misk.cloud.aws/toMiskAwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-region/#tomiskawsregion","title":"toMiskAwsRegion","text":"[jvm]\\ fun AwsRegion.toMiskAwsRegion(): AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/","title":"AwsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ data class AwsAccountId(val value: String)
AwsAccountId is the id of the account in which the service is running
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/#constructors","title":"Constructors","text":"AwsAccountId [jvm]constructor(value: String)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/-aws-account-id/","title":"AwsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/AwsAccountId/AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ constructor(value: String)
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/value/","title":"value - Misk","text":"//misk-aws/misk.cloud.aws/AwsAccountId/value
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/","title":"AwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/#awsenvironmentmodule","title":"AwsEnvironmentModule","text":"[jvm]\\ class AwsEnvironmentModule : KAbstractModule
AwsEnvironmentModule pulls region and account information from installed env vars
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/#constructors","title":"Constructors","text":"AwsEnvironmentModule [jvm]constructor()"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/#functions","title":"Functions","text":"Name Summary awsAccountId [jvm]@Providesfun awsAccountId(envVarLoader: EnvVarLoader): AwsAccountId awsRegion [jvm]@Providesfun awsRegion(envVarLoader: EnvVarLoader): AwsRegion configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/-aws-environment-module/","title":"AwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule/AwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/-aws-environment-module/#awsenvironmentmodule","title":"AwsEnvironmentModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-account-id/","title":"awsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule/awsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-account-id/#awsaccountid","title":"awsAccountId","text":"[jvm]\\
@Provides
fun awsAccountId(envVarLoader: EnvVarLoader): AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-region/","title":"awsRegion - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule/awsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-region/#awsregion","title":"awsRegion","text":"[jvm]\\
@Provides
fun awsRegion(envVarLoader: EnvVarLoader): AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/","title":"AwsRegion - Misk","text":"//misk-aws/misk.cloud.aws/AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ data class AwsRegion(val name: String)
AwsRegion is the region in which the service is running
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/#constructors","title":"Constructors","text":"AwsRegion [jvm]constructor(name: String)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/-aws-region/","title":"AwsRegion - Misk","text":"//misk-aws/misk.cloud.aws/AwsRegion/AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/name/","title":"name - Misk","text":"//misk-aws/misk.cloud.aws/AwsRegion/name
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/","title":"FakeAwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/FakeAwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/#fakeawsenvironmentmodule","title":"FakeAwsEnvironmentModule","text":"[jvm]\\ class FakeAwsEnvironmentModule : KAbstractModule
FakeAwsEnvironmentModule pulls region and account information from an in memory map.
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/#constructors","title":"Constructors","text":"FakeAwsEnvironmentModule [jvm]constructor()"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/-fake-aws-environment-module/","title":"FakeAwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/FakeAwsEnvironmentModule/FakeAwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/-fake-aws-environment-module/#fakeawsenvironmentmodule","title":"FakeAwsEnvironmentModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/","title":"Package-level declarations - Misk","text":"//misk-aws/misk.jobqueue.sqs
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#types","title":"Types","text":"Name Summary AwsSqsJobHandlerModule [jvm]class AwsSqsJobHandlerModule<T : JobHandler> : KAbstractModuleInstall this module to register a handler for an SQS queue, and if specified, registers its corresponding retry queue. AwsSqsJobQueueConfig [jvm]class AwsSqsJobQueueConfig@JvmOverloadsconstructor(val external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, val task_queue: RepeatedTaskQueueConfig? = null, val queue_attribute_importer_frequency_ms: Long = 1000, val sqs_sending_socket_timeout_ms: Int = 5000, val sqs_sending_connect_timeout_ms: Int = 1000, val sqs_sending_request_timeout_ms: Int = 5000, val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, val safe_shutdown: Boolean = true) : ConfigAwsSqsJobQueueConfig is the configuration for job queueing backed by Amazon\u2019s Simple Queuing Service AwsSqsJobQueueModule [jvm]open class AwsSqsJobQueueModule(config: AwsSqsJobQueueConfig) : KAbstractModuleAwsSqsJobQueueModule installs job queue support provided by SQS. AwsSqsJobReceiverPolicy [jvm]enum AwsSqsJobReceiverPolicy : Enum<AwsSqsJobReceiverPolicy> AWS SQS consumers are spun by each of a service\u2019s pods. Each pod is responsible for running some number on consumers and making sure they are within the parameters of the feature-flags used. AwsSqsQueueConfig [jvm]data class AwsSqsQueueConfig@JvmOverloadsconstructor(val region: String? = null, val account_id: String? = null, val sqs_queue_name: String? = null)An AwsSqsQueueConfig tells misk about a queue, potentially in another region and/or another account. If the queue is in another account, it will require an IAM policy enabling cross account access DeadLetterQueueProvider [jvm]interface DeadLetterQueueProviderInterface for a provider of dead-letter queue names. DefaultDeadLetterQueueProvider [jvm]@Singletonclass DefaultDeadLetterQueueProvider@Injectconstructor : DeadLetterQueueProviderDefault provider of dead-letter QueueName. Returns the name of the main queue suffixed with \"_dlq\". FlaggedBufferedSqsClient [jvm]class FlaggedBufferedSqsClient(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags) : AmazonSQSTemporary shim for buffered and unbuffered AmazonSQS implementations, for feature-flagged rollout of buffered SQS operations across cash cloud apps. SqsConsumerAllocator [jvm]@Singletonclass SqsConsumerAllocator@Injectconstructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)Uses a LeaseManager and FeatureFlags to calculate the number of sqs consumers a pods should have. This computation is based off of the AwsSqsJobReceiverPolicy specification. StaticDeadLetterQueueProvider [jvm]class StaticDeadLetterQueueProvider(queue: String) : DeadLetterQueueProviderProvider of dead-letter QueueName that always returns the same value, no matter the supplied queue."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#properties","title":"Properties","text":"Name Summary isRetryQueue [jvm]val QueueName.isRetryQueue: Boolean parentQueue [jvm]val QueueName.parentQueue: QueueName retryQueue [jvm]val QueueName.retryQueue: QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#functions","title":"Functions","text":"Name Summary withNoPrefetching [jvm]fun QueueBufferConfig.withNoPrefetching(): QueueBufferConfigModify a QueueBufferConfig to disable all receive pre-fetching settings."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/is-retry-queue/","title":"isRetryQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/isRetryQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/is-retry-queue/#isretryqueue","title":"isRetryQueue","text":"[jvm]\\ val QueueName.isRetryQueue: Boolean
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/parent-queue/","title":"parentQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/parentQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/parent-queue/#parentqueue","title":"parentQueue","text":"[jvm]\\ val QueueName.parentQueue: QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/retry-queue/","title":"retryQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/retryQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/retry-queue/#retryqueue","title":"retryQueue","text":"[jvm]\\ val QueueName.retryQueue: QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/with-no-prefetching/","title":"withNoPrefetching - Misk","text":"//misk-aws/misk.jobqueue.sqs/withNoPrefetching
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/with-no-prefetching/#withnoprefetching","title":"withNoPrefetching","text":"[jvm]\\ fun QueueBufferConfig.withNoPrefetching(): QueueBufferConfig
Modify a QueueBufferConfig to disable all receive pre-fetching settings.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/","title":"AwsSqsJobHandlerModule - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobHandlerModule
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/#awssqsjobhandlermodule","title":"AwsSqsJobHandlerModule","text":"[jvm]\\ class AwsSqsJobHandlerModule<T : JobHandler> : KAbstractModule
Install this module to register a handler for an SQS queue, and if specified, registers its corresponding retry queue.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobHandlerModule/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsinline fun <T : JobHandler> create(queueName: QueueName, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>@JvmStatic@JvmOverloadsfun <T : JobHandler> create(queueName: QueueName, handlerClass: Class<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>[jvm]@JvmOverloadsfun <T : JobHandler> create(queueName: QueueName, handlerClass: KClass<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>Returns a module that registers a handler for an SQS queue."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/create/","title":"create - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobHandlerModule/Companion/create
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/create/#create","title":"create","text":"[jvm]\\
@JvmOverloads
inline fun <T : JobHandler> create(queueName: QueueName, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>
@JvmStatic
@JvmOverloads
fun <T : JobHandler> create(queueName: QueueName, handlerClass: Class<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>
[jvm]\\
@JvmOverloads
fun <T : JobHandler> create(queueName: QueueName, handlerClass: KClass<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>
Returns a module that registers a handler for an SQS queue.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/","title":"AwsSqsJobQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/#awssqsjobqueueconfig","title":"AwsSqsJobQueueConfig","text":"[jvm]\\ class AwsSqsJobQueueConfig@JvmOverloadsconstructor(val external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, val task_queue: RepeatedTaskQueueConfig? = null, val queue_attribute_importer_frequency_ms: Long = 1000, val sqs_sending_socket_timeout_ms: Int = 5000, val sqs_sending_connect_timeout_ms: Int = 1000, val sqs_sending_request_timeout_ms: Int = 5000, val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, val safe_shutdown: Boolean = true) : Config
AwsSqsJobQueueConfig is the configuration for job queueing backed by Amazon\u2019s Simple Queuing Service
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/#constructors","title":"Constructors","text":"AwsSqsJobQueueConfig [jvm]@JvmOverloadsconstructor(external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, task_queue: RepeatedTaskQueueConfig? = null, queue_attribute_importer_frequency_ms: Long = 1000, sqs_sending_socket_timeout_ms: Int = 5000, sqs_sending_connect_timeout_ms: Int = 1000, sqs_sending_request_timeout_ms: Int = 5000, aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, safe_shutdown: Boolean = true)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/#properties","title":"Properties","text":"Name Summary aws_sqs_job_receiver_policy [jvm]val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy external_queues [jvm]val external_queues: Map<String, AwsSqsQueueConfig>External queues is a set of externally owned SQS queues accessed by this service, mapping an internal queue name to the (account ID, region, name) of the queue in the external account queue_attribute_importer_frequency_ms [jvm]val queue_attribute_importer_frequency_ms: Long = 1000Frequency used to import Queue Attributes in milliseconds. safe_shutdown [jvm]val safe_shutdown: Boolean = trueTemporary flag to test new shutdown behavior. This flag will eventually be removed and incorporated as the default behavior of the library. sqs_sending_connect_timeout_ms [jvm]val sqs_sending_connect_timeout_ms: Int = 1000Connect timeout to reach SQS with for sending. sqs_sending_request_timeout_ms [jvm]val sqs_sending_request_timeout_ms: Int = 5000Request timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS. sqs_sending_socket_timeout_ms [jvm]val sqs_sending_socket_timeout_ms: Int = 5000Socket timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS. task_queue [jvm]val task_queue: RepeatedTaskQueueConfig? = nullTask queue configuration, which should have anum_parallel_tasks equal or greater than the number of consumed queues. If undefined, an unbounded number of parallel tasks will be used."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/-aws-sqs-job-queue-config/","title":"AwsSqsJobQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/AwsSqsJobQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/-aws-sqs-job-queue-config/#awssqsjobqueueconfig","title":"AwsSqsJobQueueConfig","text":"[jvm]\\
@JvmOverloads
constructor(external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, task_queue: RepeatedTaskQueueConfig? = null, queue_attribute_importer_frequency_ms: Long = 1000, sqs_sending_socket_timeout_ms: Int = 5000, sqs_sending_connect_timeout_ms: Int = 1000, sqs_sending_request_timeout_ms: Int = 5000, aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, safe_shutdown: Boolean = true)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/aws_sqs_job_receiver_policy/","title":"aws_sqs_job_receiver_policy - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/aws_sqs_job_receiver_policy
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/aws_sqs_job_receiver_policy/#aws_sqs_job_receiver_policy","title":"aws_sqs_job_receiver_policy","text":"[jvm]\\ val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/external_queues/","title":"external_queues - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/external_queues
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/external_queues/#external_queues","title":"external_queues","text":"[jvm]\\ val external_queues: Map<String, AwsSqsQueueConfig>
External queues is a set of externally owned SQS queues accessed by this service, mapping an internal queue name to the (account ID, region, name) of the queue in the external account
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/queue_attribute_importer_frequency_ms/","title":"queue_attribute_importer_frequency_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/queue_attribute_importer_frequency_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/queue_attribute_importer_frequency_ms/#queue_attribute_importer_frequency_ms","title":"queue_attribute_importer_frequency_ms","text":"[jvm]\\ val queue_attribute_importer_frequency_ms: Long = 1000
Frequency used to import Queue Attributes in milliseconds.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/safe_shutdown/","title":"safe_shutdown - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/safe_shutdown
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/safe_shutdown/#safe_shutdown","title":"safe_shutdown","text":"[jvm]\\ val safe_shutdown: Boolean = true
Temporary flag to test new shutdown behavior. This flag will eventually be removed and incorporated as the default behavior of the library.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_connect_timeout_ms/","title":"sqs_sending_connect_timeout_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/sqs_sending_connect_timeout_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_connect_timeout_ms/#sqs_sending_connect_timeout_ms","title":"sqs_sending_connect_timeout_ms","text":"[jvm]\\ val sqs_sending_connect_timeout_ms: Int = 1000
Connect timeout to reach SQS with for sending.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_request_timeout_ms/","title":"sqs_sending_request_timeout_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/sqs_sending_request_timeout_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_request_timeout_ms/#sqs_sending_request_timeout_ms","title":"sqs_sending_request_timeout_ms","text":"[jvm]\\ val sqs_sending_request_timeout_ms: Int = 5000
Request timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_socket_timeout_ms/","title":"sqs_sending_socket_timeout_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/sqs_sending_socket_timeout_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_socket_timeout_ms/#sqs_sending_socket_timeout_ms","title":"sqs_sending_socket_timeout_ms","text":"[jvm]\\ val sqs_sending_socket_timeout_ms: Int = 5000
Socket timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/task_queue/","title":"task_queue - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/task_queue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/task_queue/#task_queue","title":"task_queue","text":"[jvm]\\ val task_queue: RepeatedTaskQueueConfig? = null
Task queue configuration, which should have a num_parallel_tasks equal or greater than the number of consumed queues. If undefined, an unbounded number of parallel tasks will be used.
//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#awssqsjobqueuemodule","title":"AwsSqsJobQueueModule","text":"[jvm]\\ open class AwsSqsJobQueueModule(config: AwsSqsJobQueueConfig) : KAbstractModule
AwsSqsJobQueueModule installs job queue support provided by SQS.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#constructors","title":"Constructors","text":"AwsSqsJobQueueModule [jvm]constructor(config: AwsSqsJobQueueConfig)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun <BuilderT : AwsClientBuilder<BuilderT, ClientT>, ClientT> configureClient(builder: BuilderT) consumerRepeatedTaskQueue [jvm]@Provides@Singletonfun consumerRepeatedTaskQueue(queueFactory: RepeatedTaskQueueFactory, config: AwsSqsJobQueueConfig): RepeatedTaskQueue provideSQSClient [jvm]@Provides@Singletonfun provideSQSClient(appName: String, region: AwsRegion, credentials: AWSCredentialsProvider, features: FeatureFlags): AmazonSQS provideSQSClientForReceiving [jvm]@Provides@Singletonfun provideSQSClientForReceiving(region: AwsRegion, credentials: AWSCredentialsProvider): AmazonSQS"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-aws-sqs-job-queue-module/","title":"AwsSqsJobQueueModule - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/AwsSqsJobQueueModule
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-aws-sqs-job-queue-module/#awssqsjobqueuemodule","title":"AwsSqsJobQueueModule","text":"[jvm]\\ constructor(config: AwsSqsJobQueueConfig)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/configureClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun <BuilderT : AwsClientBuilder<BuilderT, ClientT>, ClientT> configureClient(builder: BuilderT)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/consumer-repeated-task-queue/","title":"consumerRepeatedTaskQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/consumerRepeatedTaskQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/consumer-repeated-task-queue/#consumerrepeatedtaskqueue","title":"consumerRepeatedTaskQueue","text":"[jvm]\\
@Provides
@Singleton
fun consumerRepeatedTaskQueue(queueFactory: RepeatedTaskQueueFactory, config: AwsSqsJobQueueConfig): RepeatedTaskQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client-for-receiving/","title":"provideSQSClientForReceiving - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/provideSQSClientForReceiving
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client-for-receiving/#providesqsclientforreceiving","title":"provideSQSClientForReceiving","text":"[jvm]\\
@Provides
@Singleton
fun provideSQSClientForReceiving(region: AwsRegion, credentials: AWSCredentialsProvider): AmazonSQS
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client/","title":"provideSQSClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/provideSQSClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client/#providesqsclient","title":"provideSQSClient","text":"[jvm]\\
@Provides
@Singleton
fun provideSQSClient(appName: String, region: AwsRegion, credentials: AWSCredentialsProvider, features: FeatureFlags): AmazonSQS
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/","title":"AwsSqsJobReceiverPolicy - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#awssqsjobreceiverpolicy","title":"AwsSqsJobReceiverPolicy","text":"[jvm]\\ enum AwsSqsJobReceiverPolicy : Enum<AwsSqsJobReceiverPolicy>
AWS SQS consumers are spun by each of a service\u2019s pods. Each pod is responsible for running some number on consumers and making sure they are within the parameters of the feature-flags used.
Which flags?
The AwsSqsJobReceiverPolicy gives two options for how consumers are created based on the flags.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#entries","title":"Entries","text":"ONE_FLAG_ONLY [jvm]ONE_FLAG_ONLYThis is the original policy. Naming is hard, but this policy will compute receivers as follows. First we choose one flag. If there is a configuration in POD_CONSUMERS_PER_QUEUE, choose that flag; otherwise choose the CONSUMERS_PER_QUEUE flag. BALANCED_MAX [jvm]BALANCED_MAXThis policy uses a combination of these two flags to avoid the worst of both as used in ONE_FLAG_ONLY above."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AwsSqsJobReceiverPolicy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AwsSqsJobReceiverPolicyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AwsSqsJobReceiverPolicy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/entries/","title":"entries - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/entries
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AwsSqsJobReceiverPolicy>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/value-of/","title":"valueOf - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/valueOf
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AwsSqsJobReceiverPolicy
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/values/","title":"values - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/values
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AwsSqsJobReceiverPolicy>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-b-a-l-a-n-c-e-d_-m-a-x/","title":"BALANCED_MAX - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/BALANCED_MAX
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-b-a-l-a-n-c-e-d_-m-a-x/#balanced_max","title":"BALANCED_MAX","text":"[jvm]\\ BALANCED_MAX
This policy uses a combination of these two flags to avoid the worst of both as used in ONE_FLAG_ONLY above.
The POD_CONSUMERS_PER_QUEUE is subject to DOS a service when it scales up. This is especially problematic with auto scaling.
The CONSUMERS_PER_QUEUE leads to really unbalanced nodes. Throughput suffers and it is really difficult to process high backlogs of messages since usually very few nodes have enough consumers.
With this policy, as pods come online they take as many leases as are available OR until they hit the max configured per pod limit. In the interest of not overloading the flag names this max per pod is configured with POD_MAX_JOBQUEUE_CONSUMERS
This means that the SQS consumers can scale up as the services scales up, but will hit a ceiling specified by the CONSUMERS_PER_QUEUE flag. It also means that no pod takes on all the work of processing the SQS jobs.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-b-a-l-a-n-c-e-d_-m-a-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-o-n-e_-f-l-a-g_-o-n-l-y/","title":"ONE_FLAG_ONLY - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/ONE_FLAG_ONLY
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-o-n-e_-f-l-a-g_-o-n-l-y/#one_flag_only","title":"ONE_FLAG_ONLY","text":"[jvm]\\ ONE_FLAG_ONLY
This is the original policy. Naming is hard, but this policy will compute receivers as follows. First we choose one flag. If there is a configuration in POD_CONSUMERS_PER_QUEUE, choose that flag; otherwise choose the CONSUMERS_PER_QUEUE flag.
If the POD_CONSUMERS_PER_QUEUE is chosen, ALL pods will spin up the configured number of consumers. Imagine the flag is configured for 5 consumers, then 5 pods => 25 sqs consumers 10 pods => 50 sqs consumers 100 pods => 500 sqs consumers
If the CONSUMERS_PER_QUEUE is chosen then we use leases. Consider that the flag is configured with m consumers (globally) so that m leases are available. As the pods come online, they will eagerly spin up consumers until leases run out\u2026 they race! Once m leases are handed out any pods that didn\u2019t spin up a receiver will not participate in SQS consumption and those that won the race might have up to m receivers.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-o-n-e_-f-l-a-g_-o-n-l-y/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/","title":"AwsSqsQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/#awssqsqueueconfig","title":"AwsSqsQueueConfig","text":"[jvm]\\ data class AwsSqsQueueConfig@JvmOverloadsconstructor(val region: String? = null, val account_id: String? = null, val sqs_queue_name: String? = null)
An AwsSqsQueueConfig tells misk about a queue, potentially in another region and/or another account. If the queue is in another account, it will require an IAM policy enabling cross account access
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/#constructors","title":"Constructors","text":"AwsSqsQueueConfig [jvm]@JvmOverloadsconstructor(region: String? = null, account_id: String? = null, sqs_queue_name: String? = null)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/#properties","title":"Properties","text":"Name Summary account_id [jvm]val account_id: String? = null region [jvm]val region: String? = null sqs_queue_name [jvm]val sqs_queue_name: String? = null"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/-aws-sqs-queue-config/","title":"AwsSqsQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/AwsSqsQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/-aws-sqs-queue-config/#awssqsqueueconfig","title":"AwsSqsQueueConfig","text":"[jvm]\\
@JvmOverloads
constructor(region: String? = null, account_id: String? = null, sqs_queue_name: String? = null)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/account_id/","title":"account_id - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/account_id
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/account_id/#account_id","title":"account_id","text":"[jvm]\\ val account_id: String? = null
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/region/","title":"region - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/region
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/region/#region","title":"region","text":"[jvm]\\ val region: String? = null
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/sqs_queue_name/","title":"sqs_queue_name - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/sqs_queue_name
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/sqs_queue_name/#sqs_queue_name","title":"sqs_queue_name","text":"[jvm]\\ val sqs_queue_name: String? = null
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/","title":"DeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/DeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/#deadletterqueueprovider","title":"DeadLetterQueueProvider","text":"interface DeadLetterQueueProvider
Interface for a provider of dead-letter queue names.
Returns the name of the appropriate dead-letter QueueName for a given QueueName.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/#inheritors","title":"Inheritors","text":"DefaultDeadLetterQueueProvider StaticDeadLetterQueueProvider"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/#functions","title":"Functions","text":"Name Summary deadLetterQueueFor [jvm]abstract fun deadLetterQueueFor(queue: QueueName): QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/dead-letter-queue-for/","title":"deadLetterQueueFor - Misk","text":"//misk-aws/misk.jobqueue.sqs/DeadLetterQueueProvider/deadLetterQueueFor
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/dead-letter-queue-for/#deadletterqueuefor","title":"deadLetterQueueFor","text":"[jvm]\\ abstract fun deadLetterQueueFor(queue: QueueName): QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/","title":"DefaultDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/DefaultDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/#defaultdeadletterqueueprovider","title":"DefaultDeadLetterQueueProvider","text":"[jvm]\\ @Singleton
class DefaultDeadLetterQueueProvider@Injectconstructor : DeadLetterQueueProvider
Default provider of dead-letter QueueName. Returns the name of the main queue suffixed with \"_dlq\".
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/#constructors","title":"Constructors","text":"DefaultDeadLetterQueueProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/#functions","title":"Functions","text":"Name Summary deadLetterQueueFor [jvm]open override fun deadLetterQueueFor(queue: QueueName): QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/-default-dead-letter-queue-provider/","title":"DefaultDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/DefaultDeadLetterQueueProvider/DefaultDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/-default-dead-letter-queue-provider/#defaultdeadletterqueueprovider","title":"DefaultDeadLetterQueueProvider","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/dead-letter-queue-for/","title":"deadLetterQueueFor - Misk","text":"//misk-aws/misk.jobqueue.sqs/DefaultDeadLetterQueueProvider/deadLetterQueueFor
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/dead-letter-queue-for/#deadletterqueuefor","title":"deadLetterQueueFor","text":"[jvm]\\ open override fun deadLetterQueueFor(queue: QueueName): QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/","title":"FlaggedBufferedSqsClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#flaggedbufferedsqsclient","title":"FlaggedBufferedSqsClient","text":"[jvm]\\ class FlaggedBufferedSqsClient(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags) : AmazonSQS
Temporary shim for buffered and unbuffered AmazonSQS implementations, for feature-flagged rollout of buffered SQS operations across cash cloud apps.
Flag allows gates functionality on a per-service basis.
Calls to sendMessage and deleteMessage will be routed to either buffered or unbuffered clients depending on the state of the feature flag for this service. All other operations are delegated to the unbufferd implementation.
Once usage of the buffered client is proven safe, this shim should be deleted and substituted with AmazonSQSBufferedAsyncClient.
Flag: https://app.launchdarkly.com/cash/production/features/jobqueue-buffered-sqs-client/targeting
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#constructors","title":"Constructors","text":"FlaggedBufferedSqsClient [jvm]constructor(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#functions","title":"Functions","text":"Name Summary addPermission [jvm]open override fun addPermission(p0: AddPermissionRequest): AddPermissionResultopen override fun addPermission(p0: String, p1: String, p2: MutableList<String>, p3: MutableList<String>): AddPermissionResult cancelMessageMoveTask [jvm]open override fun cancelMessageMoveTask(p0: CancelMessageMoveTaskRequest): CancelMessageMoveTaskResult changeMessageVisibility [jvm]open override fun changeMessageVisibility(p0: ChangeMessageVisibilityRequest): ChangeMessageVisibilityResultopen override fun changeMessageVisibility(p0: String, p1: String, p2: Int): ChangeMessageVisibilityResult changeMessageVisibilityBatch [jvm]open override fun changeMessageVisibilityBatch(p0: ChangeMessageVisibilityBatchRequest): ChangeMessageVisibilityBatchResultopen override fun changeMessageVisibilityBatch(p0: String, p1: MutableList<ChangeMessageVisibilityBatchRequestEntry>): ChangeMessageVisibilityBatchResult createQueue [jvm]open override fun createQueue(p0: CreateQueueRequest): CreateQueueResultopen override fun createQueue(p0: String): CreateQueueResult deleteMessage [jvm]open override fun deleteMessage(deleteMessageRequest: DeleteMessageRequest): DeleteMessageResultopen override fun deleteMessage(queueUrl: String, receiptHandle: String): DeleteMessageResult deleteMessageBatch [jvm]open override fun deleteMessageBatch(p0: DeleteMessageBatchRequest): DeleteMessageBatchResultopen override fun deleteMessageBatch(p0: String, p1: MutableList<DeleteMessageBatchRequestEntry>): DeleteMessageBatchResult deleteQueue [jvm]open override fun deleteQueue(p0: DeleteQueueRequest): DeleteQueueResultopen override fun deleteQueue(p0: String): DeleteQueueResult getCachedResponseMetadata [jvm]open override fun getCachedResponseMetadata(p0: AmazonWebServiceRequest): ResponseMetadata getQueueAttributes [jvm]open override fun getQueueAttributes(p0: GetQueueAttributesRequest): GetQueueAttributesResultopen override fun getQueueAttributes(p0: String, p1: MutableList<String>): GetQueueAttributesResult getQueueUrl [jvm]open override fun getQueueUrl(p0: GetQueueUrlRequest): GetQueueUrlResultopen override fun getQueueUrl(p0: String): GetQueueUrlResult listDeadLetterSourceQueues [jvm]open override fun listDeadLetterSourceQueues(p0: ListDeadLetterSourceQueuesRequest): ListDeadLetterSourceQueuesResult listMessageMoveTasks [jvm]open override fun listMessageMoveTasks(p0: ListMessageMoveTasksRequest): ListMessageMoveTasksResult listQueues [jvm]open override fun listQueues(): ListQueuesResultopen override fun listQueues(p0: ListQueuesRequest): ListQueuesResultopen override fun listQueues(p0: String): ListQueuesResult listQueueTags [jvm]open override fun listQueueTags(p0: ListQueueTagsRequest): ListQueueTagsResultopen override fun listQueueTags(p0: String): ListQueueTagsResult purgeQueue [jvm]open override fun purgeQueue(p0: PurgeQueueRequest): PurgeQueueResult receiveMessage [jvm]open override fun receiveMessage(p0: ReceiveMessageRequest): ReceiveMessageResultopen override fun receiveMessage(p0: String): ReceiveMessageResult removePermission [jvm]open override fun removePermission(p0: RemovePermissionRequest): RemovePermissionResultopen override fun removePermission(p0: String, p1: String): RemovePermissionResult sendMessage [jvm]open override fun sendMessage(sendMessageRequest: SendMessageRequest): SendMessageResultopen override fun sendMessage(queueUrl: String, messageBody: String): SendMessageResult sendMessageBatch [jvm]open override fun sendMessageBatch(p0: SendMessageBatchRequest): SendMessageBatchResultopen override fun sendMessageBatch(p0: String, p1: MutableList<SendMessageBatchRequestEntry>): SendMessageBatchResult setQueueAttributes [jvm]open override fun setQueueAttributes(p0: SetQueueAttributesRequest): SetQueueAttributesResultopen override fun setQueueAttributes(p0: String, p1: MutableMap<String, String>): SetQueueAttributesResult shutdown [jvm]open override fun shutdown() startMessageMoveTask [jvm]open override fun startMessageMoveTask(p0: StartMessageMoveTaskRequest): StartMessageMoveTaskResult tagQueue [jvm]open override fun tagQueue(p0: TagQueueRequest): TagQueueResultopen override fun tagQueue(p0: String, p1: MutableMap<String, String>): TagQueueResult untagQueue [jvm]open override fun untagQueue(p0: UntagQueueRequest): UntagQueueResultopen override fun untagQueue(p0: String, p1: MutableList<String>): UntagQueueResult"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-flagged-buffered-sqs-client/","title":"FlaggedBufferedSqsClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/FlaggedBufferedSqsClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-flagged-buffered-sqs-client/#flaggedbufferedsqsclient","title":"FlaggedBufferedSqsClient","text":"[jvm]\\ constructor(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/delete-message/","title":"deleteMessage - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/deleteMessage
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/delete-message/#deletemessage","title":"deleteMessage","text":"[jvm]\\ open override fun deleteMessage(deleteMessageRequest: DeleteMessageRequest): DeleteMessageResult
open override fun deleteMessage(queueUrl: String, receiptHandle: String): DeleteMessageResult
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/send-message/","title":"sendMessage - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/sendMessage
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/send-message/#sendmessage","title":"sendMessage","text":"[jvm]\\ open override fun sendMessage(sendMessageRequest: SendMessageRequest): SendMessageResult
open override fun sendMessage(queueUrl: String, messageBody: String): SendMessageResult
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/shutdown/","title":"shutdown - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/shutdown
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/shutdown/#shutdown","title":"shutdown","text":"[jvm]\\ open override fun shutdown()
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/#properties","title":"Properties","text":"Name Summary FEATURE [jvm]val FEATURE: Feature"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/-f-e-a-t-u-r-e/","title":"FEATURE - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/Companion/FEATURE
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/-f-e-a-t-u-r-e/#feature","title":"FEATURE","text":"[jvm]\\ val FEATURE: Feature
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/","title":"SqsConsumerAllocator - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#sqsconsumerallocator","title":"SqsConsumerAllocator","text":"[jvm]\\ @Singleton
class SqsConsumerAllocator@Injectconstructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)
Uses a LeaseManager and FeatureFlags to calculate the number of sqs consumers a pods should have. This computation is based off of the AwsSqsJobReceiverPolicy specification.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#constructors","title":"Constructors","text":"SqsConsumerAllocator [jvm]@Injectconstructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#functions","title":"Functions","text":"Name Summary computeSqsConsumersForPod [jvm]fun computeSqsConsumersForPod(queueName: QueueName, receiverPolicy: AwsSqsJobReceiverPolicy): Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-sqs-consumer-allocator/","title":"SqsConsumerAllocator - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/SqsConsumerAllocator
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-sqs-consumer-allocator/#sqsconsumerallocator","title":"SqsConsumerAllocator","text":"[jvm]\\
@Inject
constructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/compute-sqs-consumers-for-pod/","title":"computeSqsConsumersForPod - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/computeSqsConsumersForPod
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/compute-sqs-consumers-for-pod/#computesqsconsumersforpod","title":"computeSqsConsumersForPod","text":"[jvm]\\ fun computeSqsConsumersForPod(queueName: QueueName, receiverPolicy: AwsSqsJobReceiverPolicy): Int
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/#functions","title":"Functions","text":"Name Summary leaseName [jvm]fun leaseName(queueName: QueueName, candidate: Int): String"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/lease-name/","title":"leaseName - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/Companion/leaseName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/lease-name/#leasename","title":"leaseName","text":"[jvm]\\ fun leaseName(queueName: QueueName, candidate: Int): String
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/","title":"StaticDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/StaticDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/#staticdeadletterqueueprovider","title":"StaticDeadLetterQueueProvider","text":"[jvm]\\ class StaticDeadLetterQueueProvider(queue: String) : DeadLetterQueueProvider
Provider of dead-letter QueueName that always returns the same value, no matter the supplied queue.
For apps with queues that share a single dead-letter queue.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/#constructors","title":"Constructors","text":"StaticDeadLetterQueueProvider [jvm]constructor(queue: String)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/#functions","title":"Functions","text":"Name Summary deadLetterQueueFor [jvm]open override fun deadLetterQueueFor(queue: QueueName): QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/-static-dead-letter-queue-provider/","title":"StaticDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/StaticDeadLetterQueueProvider/StaticDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/-static-dead-letter-queue-provider/#staticdeadletterqueueprovider","title":"StaticDeadLetterQueueProvider","text":"[jvm]\\ constructor(queue: String)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/dead-letter-queue-for/","title":"deadLetterQueueFor - Misk","text":"//misk-aws/misk.jobqueue.sqs/StaticDeadLetterQueueProvider/deadLetterQueueFor
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/dead-letter-queue-for/#deadletterqueuefor","title":"deadLetterQueueFor","text":"[jvm]\\ open override fun deadLetterQueueFor(queue: QueueName): QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/","title":"Package-level declarations - Misk","text":"//misk-aws/misk.s3
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws/misk-aws/misk.s3/#types","title":"Types","text":"Name Summary RealS3Module [jvm]open class RealS3Module : KAbstractModule"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/","title":"RealS3Module - Misk","text":"//misk-aws/misk.s3/RealS3Module
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/#reals3module","title":"RealS3Module","text":"[jvm]\\ open class RealS3Module : KAbstractModule
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/#constructors","title":"Constructors","text":"RealS3Module [jvm]constructor()"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun configureClient(builder: AmazonS3ClientBuilder) provideS3 [jvm]@Provides@Singletonfun provideS3(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonS3"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/-real-s3-module/","title":"RealS3Module - Misk","text":"//misk-aws/misk.s3/RealS3Module/RealS3Module
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/-real-s3-module/#reals3module","title":"RealS3Module","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws/misk.s3/RealS3Module/configureClient
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun configureClient(builder: AmazonS3ClientBuilder)
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/provide-s3/","title":"provideS3 - Misk","text":"//misk-aws/misk.s3/RealS3Module/provideS3
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/provide-s3/#provides3","title":"provideS3","text":"[jvm]\\
@Provides
@Singleton
fun provideS3(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonS3
"},{"location":"0.x/misk-aws-dynamodb/","title":"misk-aws-dynamodb - Misk","text":"//misk-aws-dynamodb
"},{"location":"0.x/misk-aws-dynamodb/#misk-aws-dynamodb","title":"misk-aws-dynamodb","text":""},{"location":"0.x/misk-aws-dynamodb/#packages","title":"Packages","text":"Name misk.dynamodb"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/","title":"Package-level declarations - Misk","text":"//misk-aws-dynamodb/misk.dynamodb
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/#types","title":"Types","text":"Name Summary DynamoDbService [jvm]interface DynamoDbService : ServiceService that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb. DyTimestampedEntity [jvm]interface DyTimestampedEntityInterface for a timestamped entity. DyVersionedEntity [jvm]interface DyVersionedEntityThis version field is used for optimistic locking. RealDynamoDbModule [jvm]open class RealDynamoDbModule@JvmOverloadsconstructor(clientConfig: ClientConfiguration = ClientConfiguration(), requiredTableTypes: KClass<*>) : KAbstractModuleInstall this module to have access to an AmazonDynamoDB client. This can be used to create a DynamoDbMapper for querying of a DynamoDb table. RealDynamoDbService [jvm]@Singletonclass RealDynamoDbService@Injectconstructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService RequiredDynamoDbTable [jvm]data class RequiredDynamoDbTable(val name: String)A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/","title":"DyTimestampedEntity - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyTimestampedEntity
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/#dytimestampedentity","title":"DyTimestampedEntity","text":"[jvm]\\ interface DyTimestampedEntity
Interface for a timestamped entity.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/#properties","title":"Properties","text":"Name Summary created_at [jvm]abstract var created_at: DateUse the below annotations on the implementations. This will automatically set field to be when the entity is created. This will save the Date as a Long (epoch milliseconds). updated_at [jvm]abstract var updated_at: DateUse the below annotations on the implementations. This will automatically set field every time entity is saved. This will save the Date as a Long (epoch milliseconds)."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/created_at/","title":"created_at - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyTimestampedEntity/created_at
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/created_at/#created_at","title":"created_at","text":"[jvm]\\ abstract var created_at: Date
Use the below annotations on the implementations. This will automatically set field to be when the entity is created. This will save the Date as a Long (epoch milliseconds).
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/updated_at/","title":"updated_at - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyTimestampedEntity/updated_at
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/updated_at/#updated_at","title":"updated_at","text":"[jvm]\\ abstract var updated_at: Date
Use the below annotations on the implementations. This will automatically set field every time entity is saved. This will save the Date as a Long (epoch milliseconds).
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/","title":"DyVersionedEntity - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyVersionedEntity
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/#dyversionedentity","title":"DyVersionedEntity","text":"[jvm]\\ interface DyVersionedEntity
This version field is used for optimistic locking.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/#properties","title":"Properties","text":"Name Summary version [jvm]abstract var version: LongThis version field can be used to do optimistic locking on updates. Note that the DynamoDbMapper will need to be in save mode DynamoDBMapperConfig.SaveBehavior.CLOBBER"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/version/","title":"version - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyVersionedEntity/version
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/version/#version","title":"version","text":"[jvm]\\ abstract var version: Long
This version field can be used to do optimistic locking on updates. Note that the DynamoDbMapper will need to be in save mode DynamoDBMapperConfig.SaveBehavior.CLOBBER
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/","title":"DynamoDbService - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/#dynamodbservice","title":"DynamoDbService","text":"interface DynamoDbService : Service
Service that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/#inheritors","title":"Inheritors","text":"RealDynamoDbService"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"open class RealDynamoDbModule@JvmOverloadsconstructor(clientConfig: ClientConfiguration = ClientConfiguration(), requiredTableTypes: KClass<*>) : KAbstractModule
Install this module to have access to an AmazonDynamoDB client. This can be used to create a DynamoDbMapper for querying of a DynamoDb table.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#parameters","title":"Parameters","text":"jvm
requiredTableTypes a list of mapper classes annotated DynamoDBTable."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#constructors","title":"Constructors","text":"RealDynamoDbModule [jvm]@JvmOverloadsconstructor(clientConfig: ClientConfiguration = ClientConfiguration(), vararg requiredTableTypes: KClass<*>)"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun configureClient(builder: AmazonDynamoDBClientBuilder) configureStreamsClient [jvm]open fun configureStreamsClient(builder: AmazonDynamoDBStreamsClientBuilder) provideRequiredTables [jvm]@Provides@Singletonfun provideRequiredTables(): List<RequiredDynamoDbTable> providesAmazonDynamoDB [jvm]@Provides@Singletonfun providesAmazonDynamoDB(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDB providesAmazonDynamoDBStreams [jvm]@Provides@Singletonfun providesAmazonDynamoDBStreams(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDBStreams"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/RealDynamoDbModule
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"[jvm]\\
@JvmOverloads
constructor(clientConfig: ClientConfiguration = ClientConfiguration(), vararg requiredTableTypes: KClass<*>)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/#parameters","title":"Parameters","text":"jvm
requiredTableTypes a list of mapper classes annotated DynamoDBTable."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/configureClient
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun configureClient(builder: AmazonDynamoDBClientBuilder)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-streams-client/","title":"configureStreamsClient - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/configureStreamsClient
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-streams-client/#configurestreamsclient","title":"configureStreamsClient","text":"[jvm]\\ open fun configureStreamsClient(builder: AmazonDynamoDBStreamsClientBuilder)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provide-required-tables/","title":"provideRequiredTables - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/provideRequiredTables
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provide-required-tables/#providerequiredtables","title":"provideRequiredTables","text":"[jvm]\\
@Provides
@Singleton
fun provideRequiredTables(): List<RequiredDynamoDbTable>
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b-streams/","title":"providesAmazonDynamoDBStreams - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/providesAmazonDynamoDBStreams
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b-streams/#providesamazondynamodbstreams","title":"providesAmazonDynamoDBStreams","text":"[jvm]\\
@Provides
@Singleton
fun providesAmazonDynamoDBStreams(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDBStreams
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b/","title":"providesAmazonDynamoDB - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/providesAmazonDynamoDB
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b/#providesamazondynamodb","title":"providesAmazonDynamoDB","text":"[jvm]\\
@Provides
@Singleton
fun providesAmazonDynamoDB(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDB
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\ @Singleton
class RealDynamoDbService@Injectconstructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/#constructors","title":"Constructors","text":"RealDynamoDbService [jvm]@Injectconstructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>)"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbService/RealDynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\
@Inject
constructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ data class RequiredDynamoDbTable(val name: String)
A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up.
The table name is sometimes prefixed with the service name, like \"urlshortener.urls\".
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/#constructors","title":"Constructors","text":"RequiredDynamoDbTable [jvm]constructor(name: String)"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RequiredDynamoDbTable/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/name/","title":"name - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RequiredDynamoDbTable/name
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-aws2-dynamodb/","title":"misk-aws2-dynamodb - Misk","text":"//misk-aws2-dynamodb
"},{"location":"0.x/misk-aws2-dynamodb/#misk-aws2-dynamodb","title":"misk-aws2-dynamodb","text":""},{"location":"0.x/misk-aws2-dynamodb/#packages","title":"Packages","text":"Name misk.aws2.dynamodb"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/","title":"Package-level declarations - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/#types","title":"Types","text":"Name Summary DynamoDbService [jvm]interface DynamoDbService : ServiceService that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb. RealDynamoDbModule [jvm]open class RealDynamoDbModule@JvmOverloadsconstructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null) : KAbstractModuleInstall this module to have access to a DynamoDbClient. RealDynamoDbService [jvm]@Singletonclass RealDynamoDbService@Injectconstructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService RequiredDynamoDbTable [jvm]data class RequiredDynamoDbTable(val name: String)A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up."},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/","title":"DynamoDbService - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/DynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/#dynamodbservice","title":"DynamoDbService","text":"interface DynamoDbService : Service
Service that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb.
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/#inheritors","title":"Inheritors","text":"RealDynamoDbService"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"[jvm]\\ open class RealDynamoDbModule@JvmOverloadsconstructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null) : KAbstractModule
Install this module to have access to a DynamoDbClient.
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/#constructors","title":"Constructors","text":"RealDynamoDbModule [jvm]@JvmOverloadsconstructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null)"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun configureClient(builder: DynamoDbClientBuilder)open fun configureClient(builder: DynamoDbStreamsClientBuilder) provideRequiredTables [jvm]@Provides@Singletonfun provideRequiredTables(): List<RequiredDynamoDbTable> providesDynamoDbClient [jvm]@Provides@Singletonfun providesDynamoDbClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbClient providesDynamoDbStreamsClient [jvm]@Provides@Singletonfun providesDynamoDbStreamsClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbStreamsClient"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/RealDynamoDbModule
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"[jvm]\\
@JvmOverloads
constructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/configureClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun configureClient(builder: DynamoDbClientBuilder)
open fun configureClient(builder: DynamoDbStreamsClientBuilder)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provide-required-tables/","title":"provideRequiredTables - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/provideRequiredTables
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provide-required-tables/#providerequiredtables","title":"provideRequiredTables","text":"[jvm]\\
@Provides
@Singleton
fun provideRequiredTables(): List<RequiredDynamoDbTable>
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-client/","title":"providesDynamoDbClient - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/providesDynamoDbClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-client/#providesdynamodbclient","title":"providesDynamoDbClient","text":"[jvm]\\
@Provides
@Singleton
fun providesDynamoDbClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-streams-client/","title":"providesDynamoDbStreamsClient - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/providesDynamoDbStreamsClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-streams-client/#providesdynamodbstreamsclient","title":"providesDynamoDbStreamsClient","text":"[jvm]\\
@Provides
@Singleton
fun providesDynamoDbStreamsClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbStreamsClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\ @Singleton
class RealDynamoDbService@Injectconstructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/#constructors","title":"Constructors","text":"RealDynamoDbService [jvm]@Injectconstructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>)"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbService/RealDynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\
@Inject
constructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ data class RequiredDynamoDbTable(val name: String)
A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up.
The table name is sometimes prefixed with the service name, like \"urlshortener.urls\".
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/#constructors","title":"Constructors","text":"RequiredDynamoDbTable [jvm]constructor(name: String)"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RequiredDynamoDbTable/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/name/","title":"name - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RequiredDynamoDbTable/name
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-clustering/","title":"misk-clustering - Misk","text":"//misk-clustering
"},{"location":"0.x/misk-clustering/#misk-clustering","title":"misk-clustering","text":""},{"location":"0.x/misk-clustering/#packages","title":"Packages","text":"Name misk.clustering misk.clustering.fake misk.clustering.fake.lease misk.clustering.kubernetes misk.clustering.lease misk.clustering.weights"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/#types","title":"Types","text":"Name Summary Cluster [jvm]interface ClusterA Cluster provides access to cluster membership for a service, allowing instances of a service to monitor the state of its peers ClusterHashRing [jvm]class ClusterHashRing@JvmOverloadsconstructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16) : ClusterResourceMapperA ClusterHashRing maps resources to cluster members based on a consistent hash ClusterResourceMapper [jvm]interface ClusterResourceMapperA ClusterResourceMapper maps string based resource IDs onto members of a cluster for the purposes of resource ownership. The default ClusterResourceMapper is a ClusterHashRing which performs a consistent hash across the cluster member, but Clusters can supply their own mappings if there is a mechanism specific to that cluster (or to supply a fake) ClusterService [jvm]interface ClusterService : ServiceMarker interface for the service that produces a Cluster. ClusterWatch [jvm]typealias ClusterWatch = (Cluster.Changes) -> UnitA ClusterWatch is a callback function triggered when cluster membership changes DefaultCluster [jvm]@Singletonclass DefaultCluster@JvmOverloadsconstructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) }) : AbstractExecutionThreadService, Cluster, ClusterServiceA DefaultCluster is the default implementation of the Cluster, which relies on an outside source such as a cluster watcher to inform it as members become ready or not ready. The DefaultCluster handles computing the actual cluster changes, and managing application watches that need to be triggered as the cluster changes. NoMembersAvailableException [jvm]class NoMembersAvailableException(val resourceId: String) : ExceptionThrown if the cluster does not have any members available."},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/","title":"Cluster - Misk","text":"//misk-clustering/misk.clustering/Cluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#cluster","title":"Cluster","text":"interface Cluster
A Cluster provides access to cluster membership for a service, allowing instances of a service to monitor the state of its peers
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#inheritors","title":"Inheritors","text":"DefaultCluster FakeCluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#types","title":"Types","text":"Name Summary Changes [jvm]data class Changes@JvmOverloadsconstructor(val snapshot: Cluster.Snapshot, val added: Set<Cluster.Member> = setOf(), val removed: Set<Cluster.Member> = setOf()) Member [jvm]data class Member(val name: String, val ipAddress: String) Snapshot [jvm]data class Snapshot@JvmOverloadsconstructor(val self: Cluster.Member, val readyMembers: Set<Cluster.Member>, val selfReady: Boolean = readyMembers.any { it.name == self.name }, val resourceMapper: ClusterResourceMapper)Snapshot is a consistent moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#properties","title":"Properties","text":"Name Summary snapshot [jvm]abstract val snapshot: Cluster.SnapshotThe current moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#functions","title":"Functions","text":"Name Summary newResourceMapper [jvm]open fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper watch [jvm]abstract fun watch(watch: ClusterWatch)Registers interest in cluster changes"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/new-resource-mapper/","title":"newResourceMapper - Misk","text":"//misk-clustering/misk.clustering/Cluster/newResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/new-resource-mapper/#newresourcemapper","title":"newResourceMapper","text":"[jvm]\\ open fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/new-resource-mapper/#return","title":"Return","text":"A new ClusterResourceMapper for the given set of ready members
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/snapshot/","title":"snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\ abstract val snapshot: Cluster.Snapshot
The current moment-in-time view of the cluster state
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/watch/","title":"watch - Misk","text":"//misk-clustering/misk.clustering/Cluster/watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/watch/#watch","title":"watch","text":"[jvm]\\ abstract fun watch(watch: ClusterWatch)
Registers interest in cluster changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/","title":"Changes - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/#changes","title":"Changes","text":"[jvm]\\ data class Changes@JvmOverloadsconstructor(val snapshot: Cluster.Snapshot, val added: Set<Cluster.Member> = setOf(), val removed: Set<Cluster.Member> = setOf())
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/#constructors","title":"Constructors","text":"Changes [jvm]@JvmOverloadsconstructor(snapshot: Cluster.Snapshot, added: Set<Cluster.Member> = setOf(), removed: Set<Cluster.Member> = setOf())"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/#properties","title":"Properties","text":"Name Summary added [jvm]val added: Set<Cluster.Member> hasDiffs [jvm]val hasDiffs: Boolean removed [jvm]val removed: Set<Cluster.Member> snapshot [jvm]val snapshot: Cluster.Snapshot"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/-changes/","title":"Changes - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/Changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/-changes/#changes","title":"Changes","text":"[jvm]\\
@JvmOverloads
constructor(snapshot: Cluster.Snapshot, added: Set<Cluster.Member> = setOf(), removed: Set<Cluster.Member> = setOf())
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/added/","title":"added - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/added
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/added/#added","title":"added","text":"[jvm]\\ val added: Set<Cluster.Member>
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/has-diffs/","title":"hasDiffs - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/hasDiffs
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/has-diffs/#hasdiffs","title":"hasDiffs","text":"[jvm]\\ val hasDiffs: Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/removed/","title":"removed - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/removed
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/removed/#removed","title":"removed","text":"[jvm]\\ val removed: Set<Cluster.Member>
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/snapshot/","title":"snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\ val snapshot: Cluster.Snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/","title":"Member - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/#member","title":"Member","text":"[jvm]\\ data class Member(val name: String, val ipAddress: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/#constructors","title":"Constructors","text":"Member [jvm]constructor(name: String, ipAddress: String)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/#properties","title":"Properties","text":"Name Summary ipAddress [jvm]val ipAddress: String name [jvm]val name: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/-member/","title":"Member - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member/Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/-member/#member","title":"Member","text":"[jvm]\\ constructor(name: String, ipAddress: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/ip-address/","title":"ipAddress - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member/ipAddress
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/ip-address/#ipaddress","title":"ipAddress","text":"[jvm]\\ val ipAddress: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/name/","title":"name - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member/name
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/","title":"Snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\ data class Snapshot@JvmOverloadsconstructor(val self: Cluster.Member, val readyMembers: Set<Cluster.Member>, val selfReady: Boolean = readyMembers.any { it.name == self.name }, val resourceMapper: ClusterResourceMapper)
Snapshot is a consistent moment-in-time view of the cluster state
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/#constructors","title":"Constructors","text":"Snapshot [jvm]@JvmOverloadsconstructor(self: Cluster.Member, readyMembers: Set<Cluster.Member>, selfReady: Boolean = readyMembers.any { it.name == self.name }, resourceMapper: ClusterResourceMapper)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/#properties","title":"Properties","text":"Name Summary readyMembers [jvm]val readyMembers: Set<Cluster.Member>All of the members of the cluster that are up and reporting as ready to handle traffic readyPeers [jvm]val readyPeers: Set<Cluster.Member>The of the ready peers; basically all of the ready cluster members except sel resourceMapper [jvm]val resourceMapper: ClusterResourceMapperA ClusterResourceMapper built from the ready members of this cluster self [jvm]val self: Cluster.MemberThe member representing this instance of the service selfReady [jvm]val selfReady: Booleantrue if the current service instance is ready as perceived by the cluster manager"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/-snapshot/","title":"Snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/Snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\
@JvmOverloads
constructor(self: Cluster.Member, readyMembers: Set<Cluster.Member>, selfReady: Boolean = readyMembers.any { it.name == self.name }, resourceMapper: ClusterResourceMapper)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-members/","title":"readyMembers - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/readyMembers
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-members/#readymembers","title":"readyMembers","text":"[jvm]\\ val readyMembers: Set<Cluster.Member>
All of the members of the cluster that are up and reporting as ready to handle traffic
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-peers/","title":"readyPeers - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/readyPeers
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-peers/#readypeers","title":"readyPeers","text":"[jvm]\\ val readyPeers: Set<Cluster.Member>
The of the ready peers; basically all of the ready cluster members except sel
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/resource-mapper/","title":"resourceMapper - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/resourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/resource-mapper/#resourcemapper","title":"resourceMapper","text":"[jvm]\\ val resourceMapper: ClusterResourceMapper
A ClusterResourceMapper built from the ready members of this cluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self-ready/","title":"selfReady - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/selfReady
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self-ready/#selfready","title":"selfReady","text":"[jvm]\\ val selfReady: Boolean
true if the current service instance is ready as perceived by the cluster manager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self/","title":"self - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/self
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self/#self","title":"self","text":"[jvm]\\ val self: Cluster.Member
The member representing this instance of the service
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/","title":"ClusterHashRing - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/#clusterhashring","title":"ClusterHashRing","text":"[jvm]\\ class ClusterHashRing@JvmOverloadsconstructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16) : ClusterResourceMapper
A ClusterHashRing maps resources to cluster members based on a consistent hash
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/#constructors","title":"Constructors","text":"ClusterHashRing [jvm]@JvmOverloadsconstructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/#functions","title":"Functions","text":"Name Summary equals [jvm]open operator override fun equals(other: Any?): Boolean get [jvm]open operator override fun get(resourceId: String): Cluster.Member hashCode [jvm]open override fun hashCode(): Int"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/-cluster-hash-ring/","title":"ClusterHashRing - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/ClusterHashRing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/-cluster-hash-ring/#clusterhashring","title":"ClusterHashRing","text":"[jvm]\\
@JvmOverloads
constructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/equals/","title":"equals - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/equals
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(resourceId: String): Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/get/#return","title":"Return","text":"The Cluster.Member that should own the given resource id
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/hash-code/","title":"hashCode - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/hashCode
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/","title":"ClusterResourceMapper - Misk","text":"//misk-clustering/misk.clustering/ClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/#clusterresourcemapper","title":"ClusterResourceMapper","text":"interface ClusterResourceMapper
A ClusterResourceMapper maps string based resource IDs onto members of a cluster for the purposes of resource ownership. The default ClusterResourceMapper is a ClusterHashRing which performs a consistent hash across the cluster member, but Clusters can supply their own mappings if there is a mechanism specific to that cluster (or to supply a fake)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/#inheritors","title":"Inheritors","text":"ClusterHashRing ExplicitClusterResourceMapper"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/#functions","title":"Functions","text":"Name Summary get [jvm]abstract operator fun get(resourceId: String): Cluster.Member"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering/ClusterResourceMapper/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/#get","title":"get","text":"[jvm]\\ abstract operator fun get(resourceId: String): Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/#return","title":"Return","text":"The Cluster.Member that should own the given resource id
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/#throws","title":"Throws","text":"NoMembersAvailableException if there are no members in the cluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/","title":"ClusterService - Misk","text":"//misk-clustering/misk.clustering/ClusterService
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/#clusterservice","title":"ClusterService","text":"interface ClusterService : Service
Marker interface for the service that produces a Cluster.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/#inheritors","title":"Inheritors","text":"DefaultCluster FakeCluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-watch/","title":"ClusterWatch - Misk","text":"//misk-clustering/misk.clustering/ClusterWatch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-watch/#clusterwatch","title":"ClusterWatch","text":"[jvm]\\ typealias ClusterWatch = (Cluster.Changes) -> Unit
A ClusterWatch is a callback function triggered when cluster membership changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/","title":"DefaultCluster - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#defaultcluster","title":"DefaultCluster","text":"[jvm]\\ @Singleton
class DefaultCluster@JvmOverloadsconstructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) }) : AbstractExecutionThreadService, Cluster, ClusterService
A DefaultCluster is the default implementation of the Cluster, which relies on an outside source such as a cluster watcher to inform it as members become ready or not ready. The DefaultCluster handles computing the actual cluster changes, and managing application watches that need to be triggered as the cluster changes.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#constructors","title":"Constructors","text":"DefaultCluster [jvm]@JvmOverloadsconstructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) })"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#properties","title":"Properties","text":"Name Summary snapshot [jvm]open override val snapshot: Cluster.SnapshotThe current moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) clusterChanged [jvm]@JvmOverloadsfun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf())Triggers a change to the cluster in response members becoming ready or not ready failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean newResourceMapper [jvm]open override fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service syncPoint [jvm]fun syncPoint(callback: () -> Unit)Triggers a callback once all of the actions on the queue have been processed. Useful for writing deterministic tests toString [jvm]open override fun toString(): String watch [jvm]open override fun watch(watch: ClusterWatch)Adds a new cluster watch"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-default-cluster/","title":"DefaultCluster - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/DefaultCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-default-cluster/#defaultcluster","title":"DefaultCluster","text":"[jvm]\\
@JvmOverloads
constructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) })
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/cluster-changed/","title":"clusterChanged - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/clusterChanged
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/cluster-changed/#clusterchanged","title":"clusterChanged","text":"[jvm]\\
@JvmOverloads
fun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf())
Triggers a change to the cluster in response members becoming ready or not ready
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/new-resource-mapper/","title":"newResourceMapper - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/newResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/new-resource-mapper/#newresourcemapper","title":"newResourceMapper","text":"[jvm]\\ open override fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/new-resource-mapper/#return","title":"Return","text":"A new ClusterResourceMapper for the given set of ready members
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/snapshot/","title":"snapshot - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\ open override val snapshot: Cluster.Snapshot
The current moment-in-time view of the cluster state
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/sync-point/","title":"syncPoint - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/syncPoint
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/sync-point/#syncpoint","title":"syncPoint","text":"[jvm]\\ fun syncPoint(callback: () -> Unit)
Triggers a callback once all of the actions on the queue have been processed. Useful for writing deterministic tests
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/watch/","title":"watch - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(watch: ClusterWatch)
Adds a new cluster watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/","title":"Companion - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/log/","title":"log - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/Companion/log
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/","title":"NoMembersAvailableException - Misk","text":"//misk-clustering/misk.clustering/NoMembersAvailableException
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#nomembersavailableexception","title":"NoMembersAvailableException","text":"[jvm]\\ class NoMembersAvailableException(val resourceId: String) : Exception
Thrown if the cluster does not have any members available.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#constructors","title":"Constructors","text":"NoMembersAvailableException [jvm]constructor(resourceId: String)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String? resourceId [jvm]val resourceId: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/-no-members-available-exception/","title":"NoMembersAvailableException - Misk","text":"//misk-clustering/misk.clustering/NoMembersAvailableException/NoMembersAvailableException
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/-no-members-available-exception/#nomembersavailableexception","title":"NoMembersAvailableException","text":"[jvm]\\ constructor(resourceId: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/resource-id/","title":"resourceId - Misk","text":"//misk-clustering/misk.clustering/NoMembersAvailableException/resourceId
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/resource-id/#resourceid","title":"resourceId","text":"[jvm]\\ val resourceId: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.fake
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/#types","title":"Types","text":"Name Summary ExplicitClusterResourceMapper [jvm]class ExplicitClusterResourceMapper : ClusterResourceMapperAn ExplicitClusterResourceMapper is a ClusterResourceMapper where the mapping is explicit managed. FakeCluster [jvm]@Singletonclass FakeCluster : ClusterService, ClusterA FakeCluster is a Cluster that is a fake. It delegates entirely to DefaultCluster, but allows us to keep DefaultCluster internal and make it clear that FakeCluster is only intended to be used for fakes. FakeClusterModule [jvm]class FakeClusterModule : KAbstractModuleFakeClusterModule installs fake implementations of the clustering primitives for use in tests"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/","title":"ExplicitClusterResourceMapper - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/#explicitclusterresourcemapper","title":"ExplicitClusterResourceMapper","text":"[jvm]\\ class ExplicitClusterResourceMapper : ClusterResourceMapper
An ExplicitClusterResourceMapper is a ClusterResourceMapper where the mapping is explicit managed.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/#constructors","title":"Constructors","text":"ExplicitClusterResourceMapper [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/#functions","title":"Functions","text":"Name Summary addMapping [jvm]fun addMapping(resourceId: String, member: Cluster.Member) clearDefaultMapping [jvm]fun clearDefaultMapping() get [jvm]open operator override fun get(resourceId: String): Cluster.Member removeMapping [jvm]fun removeMapping(resourceId: String) setDefaultMapping [jvm]fun setDefaultMapping(member: Cluster.Member)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/-explicit-cluster-resource-mapper/","title":"ExplicitClusterResourceMapper - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/ExplicitClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/-explicit-cluster-resource-mapper/#explicitclusterresourcemapper","title":"ExplicitClusterResourceMapper","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/add-mapping/","title":"addMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/addMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/add-mapping/#addmapping","title":"addMapping","text":"[jvm]\\ fun addMapping(resourceId: String, member: Cluster.Member)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/clear-default-mapping/","title":"clearDefaultMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/clearDefaultMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/clear-default-mapping/#cleardefaultmapping","title":"clearDefaultMapping","text":"[jvm]\\ fun clearDefaultMapping()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(resourceId: String): Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/#return","title":"Return","text":"The Cluster.Member that should own the given resource id
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/#throws","title":"Throws","text":"NoMembersAvailableException if there are no members in the cluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/remove-mapping/","title":"removeMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/removeMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/remove-mapping/#removemapping","title":"removeMapping","text":"[jvm]\\ fun removeMapping(resourceId: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/set-default-mapping/","title":"setDefaultMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/setDefaultMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/set-default-mapping/#setdefaultmapping","title":"setDefaultMapping","text":"[jvm]\\ fun setDefaultMapping(member: Cluster.Member)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/","title":"FakeCluster - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#fakecluster","title":"FakeCluster","text":"[jvm]\\ @Singleton
class FakeCluster : ClusterService, Cluster
A FakeCluster is a Cluster that is a fake. It delegates entirely to DefaultCluster, but allows us to keep DefaultCluster internal and make it clear that FakeCluster is only intended to be used for fakes.
NB(mmihic): I\u2019d prefer for this to be in the misk-testing module, but it can\u2019t since it relies on DefaultCluster and we want to leave DefaultCluster internal
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#constructors","title":"Constructors","text":"FakeCluster [jvm]constructor(resourceMapper: ExplicitClusterResourceMapper)@Injectconstructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#properties","title":"Properties","text":"Name Summary resourceMapper [jvm]val resourceMapper: ExplicitClusterResourceMapper snapshot [jvm]open override val snapshot: Cluster.SnapshotThe current moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#functions","title":"Functions","text":"Name Summary addListener [jvm]open override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]open override fun awaitRunning()open fun awaitRunning(timeout: Duration)open override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]open override fun awaitTerminated()open fun awaitTerminated(timeout: Duration)open override fun awaitTerminated(timeout: Long, unit: TimeUnit) clusterChanged [jvm]@JvmOverloadsfun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf()) failureCause [jvm]open override fun failureCause(): Throwable isRunning [jvm]open override fun isRunning(): Boolean newResourceMapper [jvm]open override fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper startAsync [jvm]@CanIgnoreReturnValueopen override fun startAsync(): Service state [jvm]open override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueopen override fun stopAsync(): Service watch [jvm]open override fun watch(watch: ClusterWatch)Registers interest in cluster changes"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-fake-cluster/","title":"FakeCluster - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/FakeCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-fake-cluster/#fakecluster","title":"FakeCluster","text":"[jvm]\\ constructor(resourceMapper: ExplicitClusterResourceMapper)
@Inject
constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/cluster-changed/","title":"clusterChanged - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/clusterChanged
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/cluster-changed/#clusterchanged","title":"clusterChanged","text":"[jvm]\\
@JvmOverloads
fun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf())
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/resource-mapper/","title":"resourceMapper - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/resourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/resource-mapper/#resourcemapper","title":"resourceMapper","text":"[jvm]\\ val resourceMapper: ExplicitClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/watch/","title":"watch - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(watch: ClusterWatch)
Registers interest in cluster changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/","title":"Companion - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/#properties","title":"Properties","text":"Name Summary self [jvm]@JvmStaticval self: Cluster.Member SELF_IP [jvm]const val SELF_IP: String SELF_NAME [jvm]const val SELF_NAME: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-i-p/","title":"SELF_IP - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion/SELF_IP
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-i-p/#self_ip","title":"SELF_IP","text":"[jvm]\\ const val SELF_IP: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-n-a-m-e/","title":"SELF_NAME - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion/SELF_NAME
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-n-a-m-e/#self_name","title":"SELF_NAME","text":"[jvm]\\ const val SELF_NAME: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/self/","title":"self - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion/self
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/self/#self","title":"self","text":"[jvm]\\
@JvmStatic
val self: Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/","title":"FakeClusterModule - Misk","text":"//misk-clustering/misk.clustering.fake/FakeClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/#fakeclustermodule","title":"FakeClusterModule","text":"[jvm]\\ class FakeClusterModule : KAbstractModule
FakeClusterModule installs fake implementations of the clustering primitives for use in tests
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/#constructors","title":"Constructors","text":"FakeClusterModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/-fake-cluster-module/","title":"FakeClusterModule - Misk","text":"//misk-clustering/misk.clustering.fake/FakeClusterModule/FakeClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/-fake-cluster-module/#fakeclustermodule","title":"FakeClusterModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.fake.lease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/#types","title":"Types","text":"Name Summary FakeLeaseManager [jvm]@Singletonclass FakeLeaseManager@Injectconstructor : FakeLeaseManagerA FakeLeaseManager provides explicit control over leases for the purposes of testing. By default a lease is considered held, but it can be explicitly marked as not held if desired FakeLeaseModule [jvm]class FakeLeaseModule : KAbstractModuleFakeLeaseModule installs support for leasing using fakes"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseManager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\ @Singleton
class FakeLeaseManager@Injectconstructor : FakeLeaseManager
A FakeLeaseManager provides explicit control over leases for the purposes of testing. By default a lease is considered held, but it can be explicitly marked as not held if desired
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/#constructors","title":"Constructors","text":"FakeLeaseManager [jvm]@Injectconstructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/#functions","title":"Functions","text":"Name Summary isLeaseHeld [jvm]fun isLeaseHeld(name: String): Boolean markLeaseHeld [jvm]fun markLeaseHeld(name: String) markLeaseHeldElsewhere [jvm]fun markLeaseHeldElsewhere(name: String) releaseAll [jvm]open override fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): Lease"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseManager/FakeLeaseManager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/","title":"FakeLeaseModule - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/#fakeleasemodule","title":"FakeLeaseModule","text":"[jvm]\\ class FakeLeaseModule : KAbstractModule
FakeLeaseModule installs support for leasing using fakes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/#constructors","title":"Constructors","text":"FakeLeaseModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/-fake-lease-module/","title":"FakeLeaseModule - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseModule/FakeLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/-fake-lease-module/#fakeleasemodule","title":"FakeLeaseModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.kubernetes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/#types","title":"Types","text":"Name Summary KubernetesClusterModule [jvm]class KubernetesClusterModule(config: KubernetesConfig) : KAbstractModuleKubernetesClusterModule installs cluster support based on Kubernetes KubernetesConfig [jvm]data class KubernetesConfig@JvmOverloadsconstructor(val my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", val my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", val my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", val clustering_pod_label_selector: String? = null, val kubernetes_watch_read_timeout: Long = 60, val kubernetes_read_timeout: Long = 15, val kubernetes_connect_timeout: Long = 5) : Config"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/","title":"KubernetesClusterModule - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/#kubernetesclustermodule","title":"KubernetesClusterModule","text":"[jvm]\\ class KubernetesClusterModule(config: KubernetesConfig) : KAbstractModule
KubernetesClusterModule installs cluster support based on Kubernetes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/#constructors","title":"Constructors","text":"KubernetesClusterModule [jvm]constructor(config: KubernetesConfig)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/-kubernetes-cluster-module/","title":"KubernetesClusterModule - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesClusterModule/KubernetesClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/-kubernetes-cluster-module/#kubernetesclustermodule","title":"KubernetesClusterModule","text":"[jvm]\\ constructor(config: KubernetesConfig)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/","title":"KubernetesConfig - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/#kubernetesconfig","title":"KubernetesConfig","text":"[jvm]\\ data class KubernetesConfig@JvmOverloadsconstructor(val my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", val my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", val my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", val clustering_pod_label_selector: String? = null, val kubernetes_watch_read_timeout: Long = 60, val kubernetes_read_timeout: Long = 15, val kubernetes_connect_timeout: Long = 5) : Config
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/#constructors","title":"Constructors","text":"KubernetesConfig [jvm]@JvmOverloadsconstructor(my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", clustering_pod_label_selector: String? = null, kubernetes_watch_read_timeout: Long = 60, kubernetes_read_timeout: Long = 15, kubernetes_connect_timeout: Long = 5)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/#properties","title":"Properties","text":"Name Summary clustering_pod_label_selector [jvm]val clustering_pod_label_selector: String? = nullOptional Kubernetes label selector to filter which pods in the namespace are considered to be in the same cluster. If omitted, all healthy pods in the namespace are included in the cluster. Ex: \"app = helloserver\". kubernetes_connect_timeout [jvm]val kubernetes_connect_timeout: Long = 5 kubernetes_read_timeout [jvm]val kubernetes_read_timeout: Long = 15 kubernetes_watch_read_timeout [jvm]val kubernetes_watch_read_timeout: Long = 60 my_pod_ip [jvm]val my_pod_ip: String my_pod_name [jvm]val my_pod_name: String my_pod_namespace [jvm]val my_pod_namespace: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/-kubernetes-config/","title":"KubernetesConfig - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/KubernetesConfig
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/-kubernetes-config/#kubernetesconfig","title":"KubernetesConfig","text":"[jvm]\\
@JvmOverloads
constructor(my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", clustering_pod_label_selector: String? = null, kubernetes_watch_read_timeout: Long = 60, kubernetes_read_timeout: Long = 15, kubernetes_connect_timeout: Long = 5)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/clustering_pod_label_selector/","title":"clustering_pod_label_selector - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/clustering_pod_label_selector
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/clustering_pod_label_selector/#clustering_pod_label_selector","title":"clustering_pod_label_selector","text":"[jvm]\\ val clustering_pod_label_selector: String? = null
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_connect_timeout/","title":"kubernetes_connect_timeout - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/kubernetes_connect_timeout
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_connect_timeout/#kubernetes_connect_timeout","title":"kubernetes_connect_timeout","text":"[jvm]\\ val kubernetes_connect_timeout: Long = 5
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_read_timeout/","title":"kubernetes_read_timeout - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/kubernetes_read_timeout
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_read_timeout/#kubernetes_read_timeout","title":"kubernetes_read_timeout","text":"[jvm]\\ val kubernetes_read_timeout: Long = 15
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_watch_read_timeout/","title":"kubernetes_watch_read_timeout - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/kubernetes_watch_read_timeout
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_watch_read_timeout/#kubernetes_watch_read_timeout","title":"kubernetes_watch_read_timeout","text":"[jvm]\\ val kubernetes_watch_read_timeout: Long = 60
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_ip/","title":"my_pod_ip - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/my_pod_ip
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_ip/#my_pod_ip","title":"my_pod_ip","text":"[jvm]\\ val my_pod_ip: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_name/","title":"my_pod_name - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/my_pod_name
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_name/#my_pod_name","title":"my_pod_name","text":"[jvm]\\ val my_pod_name: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_namespace/","title":"my_pod_namespace - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/my_pod_namespace
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_namespace/#my_pod_namespace","title":"my_pod_namespace","text":"[jvm]\\ val my_pod_namespace: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.lease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/#types","title":"Types","text":"Name Summary ClusterAwareLease [jvm]class ClusterAwareLease(val name: String, clusterWeightProvider: ClusterWeightProvider) : LeaseProvides functions to acquire and check if a lease is held. Returns true for acquire() and checkHeld() if the app is running in the active region. ClusterAwareLeaseManager [jvm]class ClusterAwareLeaseManager : LeaseManagerReturns a Lease that always returns true for acquire() and checkHeld() if the app is running in the active region. ClusterAwareLeaseModule [jvm]class ClusterAwareLeaseModule : KAbstractModuleConfigures a LeaseManager that has leases that always return true for acquire() and checkHeld() if the app is running in the active region."},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/","title":"ClusterAwareLease - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#clusterawarelease","title":"ClusterAwareLease","text":"[jvm]\\ class ClusterAwareLease(val name: String, clusterWeightProvider: ClusterWeightProvider) : Lease
Provides functions to acquire and check if a lease is held. Returns true for acquire() and checkHeld() if the app is running in the active region.
This lease serves as a no-op lease, suitable for situations where lease injection is necessary but not functionally important, such as in Misk SQS.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#constructors","title":"Constructors","text":"ClusterAwareLease [jvm]constructor(name: String, clusterWeightProvider: ClusterWeightProvider)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): Boolean addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener) checkHeld [jvm]open override fun checkHeld(): Boolean release [jvm]open override fun release(): Boolean"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/-cluster-aware-lease/","title":"ClusterAwareLease - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/ClusterAwareLease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/-cluster-aware-lease/#clusterawarelease","title":"ClusterAwareLease","text":"[jvm]\\ constructor(name: String, clusterWeightProvider: ClusterWeightProvider)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/acquire/","title":"acquire - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/acquire
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/add-listener/","title":"addListener - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/addListener
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/add-listener/#addlistener","title":"addListener","text":"[jvm]\\ open override fun addListener(listener: Lease.StateChangeListener)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/check-held/","title":"checkHeld - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/checkHeld
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ open override fun checkHeld(): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/name/","title":"name - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/name
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/name/#name","title":"name","text":"[jvm]\\ open override val name: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/release/","title":"release - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/release
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/release/#release","title":"release","text":"[jvm]\\ open override fun release(): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/","title":"ClusterAwareLeaseManager - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseManager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/#clusterawareleasemanager","title":"ClusterAwareLeaseManager","text":"[jvm]\\ class ClusterAwareLeaseManager : LeaseManager
Returns a Lease that always returns true for acquire() and checkHeld() if the app is running in the active region.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/#functions","title":"Functions","text":"Name Summary releaseAll [jvm]open fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): Lease"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/request-lease/","title":"requestLease - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseManager/requestLease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ open override fun requestLease(name: String): Lease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/","title":"ClusterAwareLeaseModule - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/#clusterawareleasemodule","title":"ClusterAwareLeaseModule","text":"[jvm]\\ class ClusterAwareLeaseModule : KAbstractModule
Configures a LeaseManager that has leases that always return true for acquire() and checkHeld() if the app is running in the active region.
This can be used to ignore the lease injection required for Misk SQS Jobs.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/#constructors","title":"Constructors","text":"ClusterAwareLeaseModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/-cluster-aware-lease-module/","title":"ClusterAwareLeaseModule - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseModule/ClusterAwareLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/-cluster-aware-lease-module/#clusterawareleasemodule","title":"ClusterAwareLeaseModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.weights
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/#types","title":"Types","text":"Name Summary ActiveClusterWeight [jvm]class ActiveClusterWeight : ClusterWeightProviderA static ClusterWeightProvider that always returns 100 ActiveClusterWeightModule [jvm]class ActiveClusterWeightModule : KAbstractModuleProvides an ActiveClusterWeight ClusterWeightProvider [jvm]interface ClusterWeightProviderProvides the current weight assigned to the cluster. ClusterWeightService [jvm]interface ClusterWeightService : ServiceA marker interface for the Service that produces the ClusterWeightProvider. FakeClusterWeight [jvm]class FakeClusterWeight : ClusterWeightProviderA ClusterWeightProvider for testing FakeClusterWeightModule [jvm]class FakeClusterWeightModule : KAbstractModuleProvides a FakeClusterWeight for testing"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/","title":"ActiveClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/#activeclusterweight","title":"ActiveClusterWeight","text":"[jvm]\\ class ActiveClusterWeight : ClusterWeightProvider
A static ClusterWeightProvider that always returns 100
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/#constructors","title":"Constructors","text":"ActiveClusterWeight [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Int"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/-active-cluster-weight/","title":"ActiveClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeight/ActiveClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/-active-cluster-weight/#activeclusterweight","title":"ActiveClusterWeight","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeight/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/","title":"ActiveClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/#activeclusterweightmodule","title":"ActiveClusterWeightModule","text":"[jvm]\\ class ActiveClusterWeightModule : KAbstractModule
Provides an ActiveClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/#constructors","title":"Constructors","text":"ActiveClusterWeightModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/-active-cluster-weight-module/","title":"ActiveClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeightModule/ActiveClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/-active-cluster-weight-module/#activeclusterweightmodule","title":"ActiveClusterWeightModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/","title":"ClusterWeightProvider - Misk","text":"//misk-clustering/misk.clustering.weights/ClusterWeightProvider
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/#clusterweightprovider","title":"ClusterWeightProvider","text":"interface ClusterWeightProvider
Provides the current weight assigned to the cluster.
A weight value is between 0 and 100 to indicate how much traffic a cluster should handle. Typically an active-passive setup has 1 active cluster with 100 and 1 passive cluster with 0.
If your application does not require dynamic cluster weights, you can install the ActiveClusterWeightModule
If your application does require dynamic cluster weights, you need must provide your own impl and ClusterWeightService for others to depend on.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/#inheritors","title":"Inheritors","text":"ActiveClusterWeight FakeClusterWeight"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(): Int"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.weights/ClusterWeightProvider/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/get/#get","title":"get","text":"[jvm]\\ abstract fun get(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-service/","title":"ClusterWeightService - Misk","text":"//misk-clustering/misk.clustering.weights/ClusterWeightService
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-service/#clusterweightservice","title":"ClusterWeightService","text":"[jvm]\\ interface ClusterWeightService : Service
A marker interface for the Service that produces the ClusterWeightProvider.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/","title":"FakeClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/#fakeclusterweight","title":"FakeClusterWeight","text":"[jvm]\\ class FakeClusterWeight : ClusterWeightProvider
A ClusterWeightProvider for testing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/#constructors","title":"Constructors","text":"FakeClusterWeight [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Int setClusterWeight [jvm]fun setClusterWeight(weight: Int)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/-fake-cluster-weight/","title":"FakeClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight/FakeClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/-fake-cluster-weight/#fakeclusterweight","title":"FakeClusterWeight","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/set-cluster-weight/","title":"setClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight/setClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/set-cluster-weight/#setclusterweight","title":"setClusterWeight","text":"[jvm]\\ fun setClusterWeight(weight: Int)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/","title":"FakeClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/#fakeclusterweightmodule","title":"FakeClusterWeightModule","text":"[jvm]\\ class FakeClusterWeightModule : KAbstractModule
Provides a FakeClusterWeight for testing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/#constructors","title":"Constructors","text":"FakeClusterWeightModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/-fake-cluster-weight-module/","title":"FakeClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeightModule/FakeClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/-fake-cluster-weight-module/#fakeclusterweightmodule","title":"FakeClusterWeightModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering-dynamodb/","title":"misk-clustering-dynamodb - Misk","text":"//misk-clustering-dynamodb
"},{"location":"0.x/misk-clustering-dynamodb/#misk-clustering-dynamodb","title":"misk-clustering-dynamodb","text":""},{"location":"0.x/misk-clustering-dynamodb/#packages","title":"Packages","text":"Name misk.clustering.dynamo"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/","title":"Package-level declarations - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/#types","title":"Types","text":"Name Summary DynamoClusterConfig [jvm]data class DynamoClusterConfig@JvmOverloadsconstructor(val appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", var table_name: String = \".misk-cluster-members\", val update_frequency_seconds: Long = 30, val stale_threshold_seconds: Long = 60) : Config DynamoClusterModule [jvm]class DynamoClusterModule@JvmOverloadsconstructor(config: DynamoClusterConfig = DynamoClusterConfig()) : KAbstractModule"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/","title":"DynamoClusterConfig - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/#dynamoclusterconfig","title":"DynamoClusterConfig","text":"[jvm]\\ data class DynamoClusterConfig@JvmOverloadsconstructor(val appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", var table_name: String = \".misk-cluster-members\", val update_frequency_seconds: Long = 30, val stale_threshold_seconds: Long = 60) : Config
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/#constructors","title":"Constructors","text":"DynamoClusterConfig [jvm]@JvmOverloadsconstructor(appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", table_name: String = \".misk-cluster-members\", update_frequency_seconds: Long = 30, stale_threshold_seconds: Long = 60)"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/#properties","title":"Properties","text":"Name Summary appName [jvm]val appName: String stale_threshold_seconds [jvm]val stale_threshold_seconds: Long = 60 table_name [jvm]var table_name: String update_frequency_seconds [jvm]val update_frequency_seconds: Long = 30"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/-dynamo-cluster-config/","title":"DynamoClusterConfig - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/DynamoClusterConfig
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/-dynamo-cluster-config/#dynamoclusterconfig","title":"DynamoClusterConfig","text":"[jvm]\\
@JvmOverloads
constructor(appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", table_name: String = \".misk-cluster-members\", update_frequency_seconds: Long = 30, stale_threshold_seconds: Long = 60)
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/app-name/","title":"appName - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/appName
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/app-name/#appname","title":"appName","text":"[jvm]\\ val appName: String
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/stale_threshold_seconds/","title":"stale_threshold_seconds - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/stale_threshold_seconds
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/stale_threshold_seconds/#stale_threshold_seconds","title":"stale_threshold_seconds","text":"[jvm]\\ val stale_threshold_seconds: Long = 60
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/table_name/","title":"table_name - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/table_name
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/table_name/#table_name","title":"table_name","text":"[jvm]\\ var table_name: String
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/update_frequency_seconds/","title":"update_frequency_seconds - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/update_frequency_seconds
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/update_frequency_seconds/#update_frequency_seconds","title":"update_frequency_seconds","text":"[jvm]\\ val update_frequency_seconds: Long = 30
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/","title":"DynamoClusterModule - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterModule
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/#dynamoclustermodule","title":"DynamoClusterModule","text":"[jvm]\\ class DynamoClusterModule@JvmOverloadsconstructor(config: DynamoClusterConfig = DynamoClusterConfig()) : KAbstractModule
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/#constructors","title":"Constructors","text":"DynamoClusterModule [jvm]@JvmOverloadsconstructor(config: DynamoClusterConfig = DynamoClusterConfig())"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/-dynamo-cluster-module/","title":"DynamoClusterModule - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterModule/DynamoClusterModule
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/-dynamo-cluster-module/#dynamoclustermodule","title":"DynamoClusterModule","text":"[jvm]\\
@JvmOverloads
constructor(config: DynamoClusterConfig = DynamoClusterConfig())
"},{"location":"0.x/misk-config/","title":"misk-config - Misk","text":"//misk-config
"},{"location":"0.x/misk-config/#misk-config","title":"misk-config","text":""},{"location":"0.x/misk-config/#packages","title":"Packages","text":"Name misk.config misk.resources misk.web.metadata"},{"location":"0.x/misk-config/misk-config/misk.config/","title":"Package-level declarations - Misk","text":"//misk-config/misk.config
"},{"location":"0.x/misk-config/misk-config/misk.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-config/misk-config/misk.config/#types","title":"Types","text":"Name Summary AppName [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])annotation class AppName AppNameModule [jvm]class AppNameModule(appName: String) : KAbstractModuleBinds a @AppName String to the provided application name ConfigModule [jvm]class ConfigModule<T : Config>(configClass: Class<T>, appName: String, config: T) : KAbstractModule MiskConfig [jvm]object MiskConfig Redact [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])annotation class RedactField or class will be redacted in dashboard output. Secret [jvm]interface Secret<T>Type for any secrets that need to be loaded as reference in their config file. Secret addresses should use format specified in misk.resources.ResourceLoader."},{"location":"0.x/misk-config/misk-config/misk.config/-app-name/","title":"AppName - Misk","text":"//misk-config/misk.config/AppName
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name/#appname","title":"AppName","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])
annotation class AppName
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/","title":"AppNameModule - Misk","text":"//misk-config/misk.config/AppNameModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/#appnamemodule","title":"AppNameModule","text":"[jvm]\\ class AppNameModule(appName: String) : KAbstractModule
Binds a @AppName String to the provided application name
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/#constructors","title":"Constructors","text":"AppNameModule [jvm]constructor(appName: String)"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/-app-name-module/","title":"AppNameModule - Misk","text":"//misk-config/misk.config/AppNameModule/AppNameModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/-app-name-module/#appnamemodule","title":"AppNameModule","text":"[jvm]\\ constructor(appName: String)
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/","title":"ConfigModule - Misk","text":"//misk-config/misk.config/ConfigModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#configmodule","title":"ConfigModule","text":"[jvm]\\ class ConfigModule<T : Config>(configClass: Class<T>, appName: String, config: T) : KAbstractModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#constructors","title":"Constructors","text":"ConfigModule [jvm]constructor(configClass: Class<T>, appName: String, config: T)"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-config-module/","title":"ConfigModule - Misk","text":"//misk-config/misk.config/ConfigModule/ConfigModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-config-module/#configmodule","title":"ConfigModule","text":"[jvm]\\ constructor(configClass: Class<T>, appName: String, config: T)
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/","title":"Companion - Misk","text":"//misk-config/misk.config/ConfigModule/Companion
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Config> create(appName: String, config: T): ConfigModule<T>"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/create/","title":"create - Misk","text":"//misk-config/misk.config/ConfigModule/Companion/create
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Config> create(appName: String, config: T): ConfigModule<T>
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/","title":"MiskConfig - Misk","text":"//misk-config/misk.config/MiskConfig
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/#miskconfig","title":"MiskConfig","text":"[jvm]\\ object MiskConfig
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/#types","title":"Types","text":"Name Summary RealSecret [jvm]class RealSecret<T>@JvmOverloadsconstructor(val value: T, reference: String = \"\") : Secret<T> RedactSecretJacksonModule [jvm]class RedactSecretJacksonModule : SimpleModule SecretJacksonModule [jvm]class SecretJacksonModule(val resourceLoader: ResourceLoader, val mapper: ObjectMapper) : SimpleModule"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/#functions","title":"Functions","text":"Name Summary filesInDir [jvm]@JvmStaticfun filesInDir(dir: String, filter: FilenameFilter = FilenameFilter { _, filename -> filename.endsWith(\".yaml\") }): List<File> load [jvm]@JvmStaticinline fun <T : Config> load(appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticfun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticinline fun <T : Config> load(appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticfun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticfun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM, failOnUnknownProperties: Boolean): T loadConfigYamlMap [jvm]fun loadConfigYamlMap(appName: String, deployment: Deployment, overrideResources: List<String>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): Map<String, String?>Returns a map whose keys are the names of the source Yaml files to load, and whose values are the contents of those files. If a file is absent the map\u2019s value will be null. toRedactedYaml [jvm]fun <T : Config> toRedactedYaml(config: T, resourceLoader: ResourceLoader): String"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/files-in-dir/","title":"filesInDir - Misk","text":"//misk-config/misk.config/MiskConfig/filesInDir
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/files-in-dir/#filesindir","title":"filesInDir","text":"[jvm]\\
@JvmStatic
fun filesInDir(dir: String, filter: FilenameFilter = FilenameFilter { _, filename -> filename.endsWith(\".yaml\") }): List<File>
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load-config-yaml-map/","title":"loadConfigYamlMap - Misk","text":"//misk-config/misk.config/MiskConfig/loadConfigYamlMap
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load-config-yaml-map/#loadconfigyamlmap","title":"loadConfigYamlMap","text":"[jvm]\\ fun loadConfigYamlMap(appName: String, deployment: Deployment, overrideResources: List<String>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): Map<String, String?>
Returns a map whose keys are the names of the source Yaml files to load, and whose values are the contents of those files. If a file is absent the map\u2019s value will be null.
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load/","title":"load - Misk","text":"//misk-config/misk.config/MiskConfig/load
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load/#load","title":"load","text":"[jvm]\\
@JvmStatic
inline fun <T : Config> load(appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
inline fun <T : Config> load(appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
fun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
fun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
fun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM, failOnUnknownProperties: Boolean): T
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/to-redacted-yaml/","title":"toRedactedYaml - Misk","text":"//misk-config/misk.config/MiskConfig/toRedactedYaml
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/to-redacted-yaml/#toredactedyaml","title":"toRedactedYaml","text":"[jvm]\\ fun <T : Config> toRedactedYaml(config: T, resourceLoader: ResourceLoader): String
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/","title":"RealSecret - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#realsecret","title":"RealSecret","text":"[jvm]\\ class RealSecret<T>@JvmOverloadsconstructor(val value: T, reference: String = \"\") : Secret<T>
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#constructors","title":"Constructors","text":"RealSecret [jvm]@JvmOverloadsconstructor(value: T, reference: String = \"\")"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#properties","title":"Properties","text":"Name Summary value [jvm]open override val value: T"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/-real-secret/","title":"RealSecret - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret/RealSecret
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/-real-secret/#realsecret","title":"RealSecret","text":"[jvm]\\
@JvmOverloads
constructor(value: T, reference: String = \"\")
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/to-string/","title":"toString - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret/toString
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/value/","title":"value - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret/value
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/value/#value","title":"value","text":"[jvm]\\ open override val value: T
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/","title":"RedactSecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/RedactSecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/#redactsecretjacksonmodule","title":"RedactSecretJacksonModule","text":"[jvm]\\ class RedactSecretJacksonModule : SimpleModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/#constructors","title":"Constructors","text":"RedactSecretJacksonModule [jvm]constructor()"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/#functions","title":"Functions","text":"Name Summary addAbstractTypeMapping [jvm]open fun <T : Any> addAbstractTypeMapping(p0: Class<T>, p1: Class<out T>): SimpleModule addDeserializer [jvm]open fun <T : Any> addDeserializer(p0: Class<T>, p1: JsonDeserializer<out T>): SimpleModule addKeyDeserializer [jvm]open fun addKeyDeserializer(p0: Class<*>, p1: KeyDeserializer): SimpleModule addKeySerializer [jvm]open fun <T : Any> addKeySerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addSerializer [jvm]open fun addSerializer(p0: JsonSerializer<*>): SimpleModuleopen fun <T : Any> addSerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addValueInstantiator [jvm]open fun addValueInstantiator(p0: Class<*>, p1: ValueInstantiator): SimpleModule getDependencies [jvm]open fun getDependencies(): MutableIterable<Module> getModuleName [jvm]open override fun getModuleName(): String getTypeId [jvm]open override fun getTypeId(): Any registerSubtypes [jvm]open fun registerSubtypes(vararg p0: NamedType): SimpleModuleopen fun registerSubtypes(vararg p0: Class<>): SimpleModuleopen fun registerSubtypes(p0: MutableCollection<Class<>>): SimpleModule setAbstractTypes [jvm]open fun setAbstractTypes(p0: SimpleAbstractTypeResolver) setDeserializerModifier [jvm]open fun setDeserializerModifier(p0: BeanDeserializerModifier): SimpleModule setDeserializers [jvm]open fun setDeserializers(p0: SimpleDeserializers) setKeyDeserializers [jvm]open fun setKeyDeserializers(p0: SimpleKeyDeserializers) setKeySerializers [jvm]open fun setKeySerializers(p0: SimpleSerializers) setMixInAnnotation [jvm]open fun setMixInAnnotation(p0: Class<>, p1: Class<>): SimpleModule setSerializerModifier [jvm]open fun setSerializerModifier(p0: BeanSerializerModifier): SimpleModule setSerializers [jvm]open fun setSerializers(p0: SimpleSerializers) setupModule [jvm]open override fun setupModule(context: Module.SetupContext?) setValueInstantiators [jvm]open fun setValueInstantiators(p0: SimpleValueInstantiators) version [jvm]open override fun version(): Version"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/-redact-secret-jackson-module/","title":"RedactSecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/RedactSecretJacksonModule/RedactSecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/-redact-secret-jackson-module/#redactsecretjacksonmodule","title":"RedactSecretJacksonModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/setup-module/","title":"setupModule - Misk","text":"//misk-config/misk.config/MiskConfig/RedactSecretJacksonModule/setupModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/setup-module/#setupmodule","title":"setupModule","text":"[jvm]\\ open override fun setupModule(context: Module.SetupContext?)
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/","title":"SecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#secretjacksonmodule","title":"SecretJacksonModule","text":"[jvm]\\ class SecretJacksonModule(val resourceLoader: ResourceLoader, val mapper: ObjectMapper) : SimpleModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#constructors","title":"Constructors","text":"SecretJacksonModule [jvm]constructor(resourceLoader: ResourceLoader, mapper: ObjectMapper)"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#properties","title":"Properties","text":"Name Summary mapper [jvm]val mapper: ObjectMapper resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#functions","title":"Functions","text":"Name Summary addAbstractTypeMapping [jvm]open fun <T : Any> addAbstractTypeMapping(p0: Class<T>, p1: Class<out T>): SimpleModule addDeserializer [jvm]open fun <T : Any> addDeserializer(p0: Class<T>, p1: JsonDeserializer<out T>): SimpleModule addKeyDeserializer [jvm]open fun addKeyDeserializer(p0: Class<*>, p1: KeyDeserializer): SimpleModule addKeySerializer [jvm]open fun <T : Any> addKeySerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addSerializer [jvm]open fun addSerializer(p0: JsonSerializer<*>): SimpleModuleopen fun <T : Any> addSerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addValueInstantiator [jvm]open fun addValueInstantiator(p0: Class<*>, p1: ValueInstantiator): SimpleModule getDependencies [jvm]open fun getDependencies(): MutableIterable<Module> getModuleName [jvm]open override fun getModuleName(): String getTypeId [jvm]open override fun getTypeId(): Any registerSubtypes [jvm]open fun registerSubtypes(vararg p0: NamedType): SimpleModuleopen fun registerSubtypes(vararg p0: Class<>): SimpleModuleopen fun registerSubtypes(p0: MutableCollection<Class<>>): SimpleModule setAbstractTypes [jvm]open fun setAbstractTypes(p0: SimpleAbstractTypeResolver) setDeserializerModifier [jvm]open fun setDeserializerModifier(p0: BeanDeserializerModifier): SimpleModule setDeserializers [jvm]open fun setDeserializers(p0: SimpleDeserializers) setKeyDeserializers [jvm]open fun setKeyDeserializers(p0: SimpleKeyDeserializers) setKeySerializers [jvm]open fun setKeySerializers(p0: SimpleSerializers) setMixInAnnotation [jvm]open fun setMixInAnnotation(p0: Class<>, p1: Class<>): SimpleModule setSerializerModifier [jvm]open fun setSerializerModifier(p0: BeanSerializerModifier): SimpleModule setSerializers [jvm]open fun setSerializers(p0: SimpleSerializers) setupModule [jvm]open override fun setupModule(context: Module.SetupContext?) setValueInstantiators [jvm]open fun setValueInstantiators(p0: SimpleValueInstantiators) version [jvm]open override fun version(): Version"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/-secret-jackson-module/","title":"SecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/SecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/-secret-jackson-module/#secretjacksonmodule","title":"SecretJacksonModule","text":"[jvm]\\ constructor(resourceLoader: ResourceLoader, mapper: ObjectMapper)
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/mapper/","title":"mapper - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/mapper
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/mapper/#mapper","title":"mapper","text":"[jvm]\\ val mapper: ObjectMapper
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/resource-loader/","title":"resourceLoader - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/resourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/setup-module/","title":"setupModule - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/setupModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/setup-module/#setupmodule","title":"setupModule","text":"[jvm]\\ open override fun setupModule(context: Module.SetupContext?)
"},{"location":"0.x/misk-config/misk-config/misk.config/-redact/","title":"Redact - Misk","text":"//misk-config/misk.config/Redact
"},{"location":"0.x/misk-config/misk-config/misk.config/-redact/#redact","title":"Redact","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])
annotation class Redact
Field or class will be redacted in dashboard output.
import misk.config.Redact\n\ndata class MyServiceConfig(\n val customConfig: CustomConfig,\n val secretConfig: SecretConfig\n)\n\ndata class CustomConfig(\n @Redact\n val secretSubconfig: Subconfig\n)\n\n@Redact\ndata class SecretConfig(\n val key: String\n)\n//misk-config/misk.config/Secret
"},{"location":"0.x/misk-config/misk-config/misk.config/-secret/#secret","title":"Secret","text":"interface Secret<T>
Type for any secrets that need to be loaded as reference in their config file. Secret addresses should use format specified in misk.resources.ResourceLoader.
Usage example:
data class SuperSecretConfig(\n val string_value: String,\n val secret_information: Secret<SecretInformationConfig>,\n) : Config\nWith
data class SecretInformationConfig(\n val answer_to_universe: String,\n val limit: Int\n) : Config\nWe would have the SuperSecretConfig yaml be:
string_value: \"this is not a secret\"\nsecret_information: \"classpath:/misk/resources/secret_information_values.yaml\"\nAnd the secret_information stored as:
answer_to_universe: 42\nlimit: 5\nLastly, this secret information would be accessed using:
superSecretConfig.secret_information.value.answer_to_universe\n//misk-config/misk.config/Secret/value
"},{"location":"0.x/misk-config/misk-config/misk.config/-secret/value/#value","title":"value","text":"[jvm]\\ abstract val value: T
"},{"location":"0.x/misk-config/misk-config/misk.resources/","title":"Package-level declarations - Misk","text":"//misk-config/misk.resources
"},{"location":"0.x/misk-config/misk-config/misk.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-config/misk-config/misk.resources/#types","title":"Types","text":"Name Summary FakeFilesModule [jvm]class FakeFilesModule(fakeFiles: Map<String, String>) : KAbstractModuleAdds the provided fake files to the map used by FilesystemLoaderBackend. ForFakeFiles [jvm]@Qualifierannotation class ForFakeFiles ResourceLoader [jvm]@Singletonclass ResourceLoader@Injectconstructor(backends: Map<String, ResourceLoader.Backend>)ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source. ResourceLoaderModule [jvm]class ResourceLoaderModule : KAbstractModule TestingResourceLoaderModule [jvm]class TestingResourceLoaderModule : KAbstractModuleCan be used instead of ResourceLoaderModule in tests to load filesystem: resources using FakeFilesystemLoaderBackend"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/","title":"FakeFilesModule - Misk","text":"//misk-config/misk.resources/FakeFilesModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/#fakefilesmodule","title":"FakeFilesModule","text":"[jvm]\\ class FakeFilesModule(fakeFiles: Map<String, String>) : KAbstractModule
Adds the provided fake files to the map used by FilesystemLoaderBackend.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/#constructors","title":"Constructors","text":"FakeFilesModule [jvm]constructor(fakeFiles: Map<String, String>)"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/-fake-files-module/","title":"FakeFilesModule - Misk","text":"//misk-config/misk.resources/FakeFilesModule/FakeFilesModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/-fake-files-module/#fakefilesmodule","title":"FakeFilesModule","text":"[jvm]\\ constructor(fakeFiles: Map<String, String>)
"},{"location":"0.x/misk-config/misk-config/misk.resources/-for-fake-files/","title":"ForFakeFiles - Misk","text":"//misk-config/misk.resources/ForFakeFiles
"},{"location":"0.x/misk-config/misk-config/misk.resources/-for-fake-files/#forfakefiles","title":"ForFakeFiles","text":"[jvm]\\ @Qualifier
annotation class ForFakeFiles
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/","title":"ResourceLoader - Misk","text":"//misk-config/misk.resources/ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\ @Singleton
class ResourceLoader@Injectconstructor(backends: Map<String, ResourceLoader.Backend>)
ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source.
Resource addresses have a scheme name, a colon, and an absolute filesystem-like path: classpath:/migrations/v1.sql. Schemes identify backends classpath: or memory:. Paths start with a slash and have any number of segments.
Classpath resources use the scheme classpath:. The backend reads data from the src/main/resources of the project\u2019s modules and the contents of all library .jar files. Classpath resources are read-only.
Filesystem resources use the scheme filesystem:. The backend reads data from the host machine\u2019s local filesystem. It is read-only and does not support list.
Memory resources use the scheme memory:. The backend starts empty and is populated by calls to put.
Other backends are permitted. They should be registered with a MapBinder with the backend scheme like classpath: as the key.
address exists. list [jvm]fun list(address: String): List<String>Returns the full path of the resources that are immediate children of address. open [jvm]fun open(address: String): BufferedSource?Return a buffered source for address, or null if no such resource exists. put [jvm]fun put(address: String, utf8: String)Writes a resource as UTF-8. Throws if the backend is readonly.[jvm]fun put(address: String, data: ByteString)Writes a resource. Throws if the backend is readonly. requireUtf8 [jvm]fun requireUtf8(address: String): StringLike utf8, but throws IllegalStateException if the resource is missing. utf8 [jvm]fun utf8(address: String): String?Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently. walk [jvm]fun walk(address: String): List<String>"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-resource-loader/","title":"ResourceLoader - Misk","text":"//misk-config/misk.resources/ResourceLoader/ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\
@Inject
constructor(backends: Map<String, ResourceLoader.Backend>)
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/copy-to/","title":"copyTo - Misk","text":"//misk-config/misk.resources/ResourceLoader/copyTo
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/copy-to/#copyto","title":"copyTo","text":"[jvm]\\ fun copyTo(root: String, dir: Path)
Copies all resources with root as a prefix to the directory dir.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/delegate/","title":"delegate - Misk","text":"//misk-config/misk.resources/ResourceLoader/delegate
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/exists/","title":"exists - Misk","text":"//misk-config/misk.resources/ResourceLoader/exists
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/exists/#exists","title":"exists","text":"[jvm]\\ fun exists(address: String): Boolean
Returns true if a resource at address exists.
//misk-config/misk.resources/ResourceLoader/list
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/list/#list","title":"list","text":"[jvm]\\ fun list(address: String): List<String>
Returns the full path of the resources that are immediate children of address.
//misk-config/misk.resources/ResourceLoader/open
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/open/#open","title":"open","text":"[jvm]\\ fun open(address: String): BufferedSource?
Return a buffered source for address, or null if no such resource exists.
//misk-config/misk.resources/ResourceLoader/put
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/put/#put","title":"put","text":"[jvm]\\ fun put(address: String, utf8: String)
Writes a resource as UTF-8. Throws if the backend is readonly.
[jvm]\\ fun put(address: String, data: ByteString)
Writes a resource. Throws if the backend is readonly.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/require-utf8/","title":"requireUtf8 - Misk","text":"//misk-config/misk.resources/ResourceLoader/requireUtf8
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/require-utf8/#requireutf8","title":"requireUtf8","text":"[jvm]\\ fun requireUtf8(address: String): String
Like utf8, but throws IllegalStateException if the resource is missing.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/utf8/","title":"utf8 - Misk","text":"//misk-config/misk.resources/ResourceLoader/utf8
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/utf8/#utf8","title":"utf8","text":"[jvm]\\ fun utf8(address: String): String?
Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently.
//misk-config/misk.resources/ResourceLoader/walk
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/walk/#walk","title":"walk","text":"[jvm]\\ fun walk(address: String): List<String>
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/","title":"Companion - Misk","text":"//misk-config/misk.resources/ResourceLoader/Companion
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/#properties","title":"Properties","text":"Name Summary SYSTEM [jvm]val SYSTEM: ResourceLoader"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/-s-y-s-t-e-m/","title":"SYSTEM - Misk","text":"//misk-config/misk.resources/ResourceLoader/Companion/SYSTEM
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/-s-y-s-t-e-m/#system","title":"SYSTEM","text":"[jvm]\\ val SYSTEM: ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/","title":"ResourceLoaderModule - Misk","text":"//misk-config/misk.resources/ResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/#resourceloadermodule","title":"ResourceLoaderModule","text":"[jvm]\\ class ResourceLoaderModule : KAbstractModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/#constructors","title":"Constructors","text":"ResourceLoaderModule [jvm]constructor()"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/-resource-loader-module/","title":"ResourceLoaderModule - Misk","text":"//misk-config/misk.resources/ResourceLoaderModule/ResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/-resource-loader-module/#resourceloadermodule","title":"ResourceLoaderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/","title":"TestingResourceLoaderModule - Misk","text":"//misk-config/misk.resources/TestingResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/#testingresourceloadermodule","title":"TestingResourceLoaderModule","text":"[jvm]\\ class TestingResourceLoaderModule : KAbstractModule
Can be used instead of ResourceLoaderModule in tests to load filesystem: resources using FakeFilesystemLoaderBackend
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/#constructors","title":"Constructors","text":"TestingResourceLoaderModule [jvm]constructor()"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/-testing-resource-loader-module/","title":"TestingResourceLoaderModule - Misk","text":"//misk-config/misk.resources/TestingResourceLoaderModule/TestingResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/-testing-resource-loader-module/#testingresourceloadermodule","title":"TestingResourceLoaderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/","title":"Package-level declarations - Misk","text":"//misk-config/misk.web.metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-config/misk-config/misk.web.metadata/#types","title":"Types","text":"Name Summary Metadata [jvm]open class Metadata@JvmOverloadsconstructor(val metadata: Any, val prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), val descriptionString: String = \"\") MetadataModule [jvm]class MetadataModule<T : Metadata>(provider: MetadataProvider<T>) : KAbstractModuleInstalls a new Metadata type with associated provider to expose in AllMetadataAction. MetadataProvider [jvm]interface MetadataProvider<T : Metadata> : Provider<T>"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/#functions","title":"Functions","text":"Name Summary toFormattedJson [jvm]fun <T> JsonAdapter<T>.toFormattedJson(value: T): String"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/to-formatted-json/","title":"toFormattedJson - Misk","text":"//misk-config/misk.web.metadata/toFormattedJson
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/to-formatted-json/#toformattedjson","title":"toFormattedJson","text":"[jvm]\\ fun <T> JsonAdapter<T>.toFormattedJson(value: T): String
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/","title":"Metadata - Misk","text":"//misk-config/misk.web.metadata/Metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#metadata","title":"Metadata","text":"[jvm]\\ open class Metadata@JvmOverloadsconstructor(val metadata: Any, val prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), val descriptionString: String = \"\")
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#constructors","title":"Constructors","text":"Metadata [jvm]@JvmOverloadsconstructor(metadata: Any, prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), descriptionString: String = \"\")"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: StringDescription of what the metadata covers or administrator instructions. metadata [jvm]val metadata: AnyMetadata object, should be a data class for easy built-in serialization to JSON. prettyPrint [jvm]val prettyPrint: StringPretty Print representation of the metadata used in the admin dashboard. Most metadata should create a Moshi JSON adapter and use toFormattedJson to do this."},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>HTML block for the content. Can be overridden to show more complex UI than the default prettyPrint console output. descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>HTML block for description. Can be overridden to show more complex UI or documentation."},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/-metadata/","title":"Metadata - Misk","text":"//misk-config/misk.web.metadata/Metadata/Metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/-metadata/#metadata","title":"Metadata","text":"[jvm]\\
@JvmOverloads
constructor(metadata: Any, prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), descriptionString: String = \"\")
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/content-block/","title":"contentBlock - Misk","text":"//misk-config/misk.web.metadata/Metadata/contentBlock
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/content-block/#contentblock","title":"contentBlock","text":"[jvm]\\ open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>
HTML block for the content. Can be overridden to show more complex UI than the default prettyPrint console output.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-block/","title":"descriptionBlock - Misk","text":"//misk-config/misk.web.metadata/Metadata/descriptionBlock
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-block/#descriptionblock","title":"descriptionBlock","text":"[jvm]\\ open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>
HTML block for description. Can be overridden to show more complex UI or documentation.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-string/","title":"descriptionString - Misk","text":"//misk-config/misk.web.metadata/Metadata/descriptionString
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-string/#descriptionstring","title":"descriptionString","text":"[jvm]\\ val descriptionString: String
Description of what the metadata covers or administrator instructions.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/metadata/","title":"metadata - Misk","text":"//misk-config/misk.web.metadata/Metadata/metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/metadata/#metadata","title":"metadata","text":"[jvm]\\ val metadata: Any
Metadata object, should be a data class for easy built-in serialization to JSON.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/pretty-print/","title":"prettyPrint - Misk","text":"//misk-config/misk.web.metadata/Metadata/prettyPrint
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/pretty-print/#prettyprint","title":"prettyPrint","text":"[jvm]\\ val prettyPrint: String
Pretty Print representation of the metadata used in the admin dashboard. Most metadata should create a Moshi JSON adapter and use toFormattedJson to do this.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/","title":"MetadataModule - Misk","text":"//misk-config/misk.web.metadata/MetadataModule
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/#metadatamodule","title":"MetadataModule","text":"[jvm]\\ class MetadataModule<T : Metadata>(provider: MetadataProvider<T>) : KAbstractModule
Installs a new Metadata type with associated provider to expose in AllMetadataAction.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/#constructors","title":"Constructors","text":"MetadataModule [jvm]constructor(provider: MetadataProvider<T>)"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/-metadata-module/","title":"MetadataModule - Misk","text":"//misk-config/misk.web.metadata/MetadataModule/MetadataModule
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/-metadata-module/#metadatamodule","title":"MetadataModule","text":"[jvm]\\ constructor(provider: MetadataProvider<T>)
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/","title":"MetadataProvider - Misk","text":"//misk-config/misk.web.metadata/MetadataProvider
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/#metadataprovider","title":"MetadataProvider","text":"[jvm]\\ interface MetadataProvider<T : Metadata> : Provider<T>
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: StringUnique identifier for the type of metadata. Ie. \"web-actions\" or \"config\"."},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract override fun get(): T"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/id/","title":"id - Misk","text":"//misk-config/misk.web.metadata/MetadataProvider/id
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/id/#id","title":"id","text":"[jvm]\\ abstract val id: String
Unique identifier for the type of metadata. Ie. \"web-actions\" or \"config\".
"},{"location":"0.x/misk-core/","title":"misk-core - Misk","text":"//misk-core
"},{"location":"0.x/misk-core/#misk-core","title":"misk-core","text":""},{"location":"0.x/misk-core/#packages","title":"Packages","text":"Name misk.backoff misk.concurrent misk.config misk.healthchecks misk.logging misk.random misk.retries misk.sampling misk.security.ssl misk.tokens misk.web.mediatype"},{"location":"0.x/misk-core/misk-core/misk.backoff/","title":"Package-level declarations - Misk","text":"//misk-core/misk.backoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.backoff/#types","title":"Types","text":"Name Summary Backoff [jvm]interface BackoffCalculates how long to backoff on a retry. Backoffs are stateful and not thread-safe DontRetryException [jvm]class DontRetryException : Exception ExponentialBackoff [jvm]open class ExponentialBackoff@JvmOverloadsconstructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() }) : BackoffPerforms exponential backoff with optional jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags) FlatBackoff [jvm]class FlatBackoff@JvmOverloadsconstructor(val duration: Duration = Duration.ofMillis(0)) : Backoff FullJitterBackoff [jvm]class FullJitterBackoff(baseDelay: () -> Duration, maxDelay: () -> Duration) : ExponentialBackoffPerforms exponential backoff with 100% jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags)"},{"location":"0.x/misk-core/misk-core/misk.backoff/#functions","title":"Functions","text":"Name Summary retry [jvm]@JvmOverloadsfun <A> retry(upTo: Int, withBackoff: Backoff, onRetry: (retryCount: Int, Exception) -> Unit? = null, block: (retryCount: Int) -> A): ARetries the provided function up to a certain number of times, applying the given backoff between each retry. If provided, the onRetry callback is called when a retry happens, allowing clients to perform a task (log, emit metrics) every time a retry occurs. The retry function is provided with current retry count, in case this is relevant."},{"location":"0.x/misk-core/misk-core/misk.backoff/retry/","title":"retry - Misk","text":"//misk-core/misk.backoff/retry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/retry/#retry","title":"retry","text":"[jvm]\\
@JvmOverloads
fun <A> retry(upTo: Int, withBackoff: Backoff, onRetry: (retryCount: Int, Exception) -> Unit? = null, block: (retryCount: Int) -> A): A
Retries the provided function up to a certain number of times, applying the given backoff between each retry. If provided, the onRetry callback is called when a retry happens, allowing clients to perform a task (log, emit metrics) every time a retry occurs. The retry function is provided with current retry count, in case this is relevant.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/","title":"Backoff - Misk","text":"//misk-core/misk.backoff/Backoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/#backoff","title":"Backoff","text":"interface Backoff
Calculates how long to backoff on a retry. Backoffs are stateful and not thread-safe
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/#inheritors","title":"Inheritors","text":"ExponentialBackoff FlatBackoff"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]abstract fun nextRetry(): Duration reset [jvm]abstract fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/next-retry/","title":"nextRetry - Misk","text":"//misk-core/misk.backoff/Backoff/nextRetry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/next-retry/#nextretry","title":"nextRetry","text":"[jvm]\\ abstract fun nextRetry(): Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/next-retry/#return","title":"Return","text":"Determines the amount of time to wait before the next retry.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/reset/","title":"reset - Misk","text":"//misk-core/misk.backoff/Backoff/reset
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/reset/#reset","title":"reset","text":"[jvm]\\ abstract fun reset()
Resets the backoff, typically when a request has succeeded
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/","title":"DontRetryException - Misk","text":"//misk-core/misk.backoff/DontRetryException
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#dontretryexception","title":"DontRetryException","text":"[jvm]\\ class DontRetryException : Exception
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#constructors","title":"Constructors","text":"DontRetryException [jvm]constructor(message: String? = null)constructor(cause: Exception?)constructor(message: String?, cause: Exception?)"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/-dont-retry-exception/","title":"DontRetryException - Misk","text":"//misk-core/misk.backoff/DontRetryException/DontRetryException
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/-dont-retry-exception/#dontretryexception","title":"DontRetryException","text":"[jvm]\\ constructor(message: String? = null)
constructor(cause: Exception?)
constructor(message: String?, cause: Exception?)
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/","title":"ExponentialBackoff - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#exponentialbackoff","title":"ExponentialBackoff","text":"open class ExponentialBackoff@JvmOverloadsconstructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() }) : Backoff
Performs exponential backoff with optional jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags)
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#inheritors","title":"Inheritors","text":"FullJitterBackoff"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#constructors","title":"Constructors","text":"ExponentialBackoff [jvm]constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)Creates a new unjittered ExponentialBackoff using a function for the base and max retry delays.constructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitterFromNextDelay: (Long) -> Duration)Creates a new jittered ExponentialBackoff using a function for the base and max retry delays, and a function for the jitter amount.constructor(baseDelay: Duration, maxDelay: Duration, jitterFromNextDelay: (Long) -> Duration)Creates a new jittered ExponentialBackoff from fixed delays and jitter amounts and a function for the jitter.constructor(baseDelay: Duration, maxDelay: Duration, jitter: Duration)Creates a new ExponentialBackoff from fixed delays and jitter amountsconstructor(baseDelay: Duration, maxDelay: Duration)Creates a new ExponentialBackoff from fixed delays, without jitter@JvmOverloadsconstructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() })"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]open override fun nextRetry(): Duration reset [jvm]open override fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/","title":"ExponentialBackoff - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff/ExponentialBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#exponentialbackoff","title":"ExponentialBackoff","text":"[jvm]\\ constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)
Creates a new unjittered ExponentialBackoff using a function for the base and max retry delays.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters","title":"Parameters","text":"jvm
baseDelay The Supplier for the base delay maxDelay The Supplier for maximum amount of time to wait between retries[jvm]\\ constructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitterFromNextDelay: (Long) -> Duration)
Creates a new jittered ExponentialBackoff using a function for the base and max retry delays, and a function for the jitter amount.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_1","title":"Parameters","text":"jvm
baseDelay The Supplier for the base delay maxDelay The Supplier for maximum amount of time to wait between retries jitterFromNextDelay The Supplier for maximum amount of time to wait between retries[jvm]\\ constructor(baseDelay: Duration, maxDelay: Duration, jitterFromNextDelay: (Long) -> Duration)
Creates a new jittered ExponentialBackoff from fixed delays and jitter amounts and a function for the jitter.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_2","title":"Parameters","text":"jvm
baseDelay The base retry delay maxDelay The max amount of time to delay jitterFromNextDelay The Supplier for maximum amount of time to wait between retries[jvm]\\ constructor(baseDelay: Duration, maxDelay: Duration, jitter: Duration)
Creates a new ExponentialBackoff from fixed delays and jitter amounts
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_3","title":"Parameters","text":"jvm
baseDelay The base retry delay maxDelay The max amount of time to delay jitter The amount of jitter to introduce[jvm]\\ constructor(baseDelay: Duration, maxDelay: Duration)
Creates a new ExponentialBackoff from fixed delays, without jitter
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_4","title":"Parameters","text":"jvm
baseDelay The base retry delay maxDelay The max amount of time to delay[jvm]\\
@JvmOverloads
constructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() })
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/next-retry/","title":"nextRetry - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff/nextRetry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/next-retry/#nextretry","title":"nextRetry","text":"[jvm]\\ open override fun nextRetry(): Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/next-retry/#return","title":"Return","text":"Determines the amount of time to wait before the next retry.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/reset/","title":"reset - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff/reset
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
Resets the backoff, typically when a request has succeeded
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/","title":"FlatBackoff - Misk","text":"//misk-core/misk.backoff/FlatBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#flatbackoff","title":"FlatBackoff","text":"[jvm]\\ class FlatBackoff@JvmOverloadsconstructor(val duration: Duration = Duration.ofMillis(0)) : Backoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#constructors","title":"Constructors","text":"FlatBackoff [jvm]@JvmOverloadsconstructor(duration: Duration = Duration.ofMillis(0))"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#properties","title":"Properties","text":"Name Summary duration [jvm]val duration: Duration"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]open override fun nextRetry(): Duration reset [jvm]open override fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/-flat-backoff/","title":"FlatBackoff - Misk","text":"//misk-core/misk.backoff/FlatBackoff/FlatBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/-flat-backoff/#flatbackoff","title":"FlatBackoff","text":"[jvm]\\
@JvmOverloads
constructor(duration: Duration = Duration.ofMillis(0))
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/duration/","title":"duration - Misk","text":"//misk-core/misk.backoff/FlatBackoff/duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/duration/#duration","title":"duration","text":"[jvm]\\ val duration: Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/next-retry/","title":"nextRetry - Misk","text":"//misk-core/misk.backoff/FlatBackoff/nextRetry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/next-retry/#nextretry","title":"nextRetry","text":"[jvm]\\ open override fun nextRetry(): Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/next-retry/#return","title":"Return","text":"Determines the amount of time to wait before the next retry.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/reset/","title":"reset - Misk","text":"//misk-core/misk.backoff/FlatBackoff/reset
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
Resets the backoff, typically when a request has succeeded
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/","title":"FullJitterBackoff - Misk","text":"//misk-core/misk.backoff/FullJitterBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/#fulljitterbackoff","title":"FullJitterBackoff","text":"[jvm]\\ class FullJitterBackoff(baseDelay: () -> Duration, maxDelay: () -> Duration) : ExponentialBackoff
Performs exponential backoff with 100% jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags)
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/#constructors","title":"Constructors","text":"FullJitterBackoff [jvm]constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]open override fun nextRetry(): Duration reset [jvm]open override fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/-full-jitter-backoff/","title":"FullJitterBackoff - Misk","text":"//misk-core/misk.backoff/FullJitterBackoff/FullJitterBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/-full-jitter-backoff/#fulljitterbackoff","title":"FullJitterBackoff","text":"[jvm]\\ constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk-core/misk.concurrent
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.concurrent/#types","title":"Types","text":"Name Summary ExecutorServiceFactory [jvm]interface ExecutorServiceFactoryInject this rather than using the Executors factory class to create thread pools. Executors created with this factory will automatically be shut down when the service or test completes. Sleeper [jvm]interface SleeperAbstraction for Thread.sleep() that allows for testing."},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/","title":"ExecutorServiceFactory - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/#executorservicefactory","title":"ExecutorServiceFactory","text":"[jvm]\\ interface ExecutorServiceFactory
Inject this rather than using the Executors factory class to create thread pools. Executors created with this factory will automatically be shut down when the service or test completes.
For all functions, nameFormat a string in the format specified by ThreadFactoryBuilder.setNameFormat, like \"rpc-pool-%d\". If the string has a single %d placeholder it will be assigned sequentially. Omit the placeholder if only one thread will be required.
//misk-core/misk.concurrent/ExecutorServiceFactory/fixed
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/fixed/#fixed","title":"fixed","text":"[jvm]\\ abstract fun fixed(nameFormat: String, threadCount: Int): ExecutorService
Returns an executor service that uses Executors.newFixedThreadPool.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/scheduled/","title":"scheduled - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory/scheduled
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/scheduled/#scheduled","title":"scheduled","text":"[jvm]\\ abstract fun scheduled(nameFormat: String, threadCount: Int): ScheduledExecutorService
Returns an executor service that uses Executors.newScheduledThreadPool.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/single/","title":"single - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory/single
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/single/#single","title":"single","text":"[jvm]\\ abstract fun single(nameFormat: String): ExecutorService
Returns an executor service that uses Executors.newSingleThreadExecutor.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/unbounded/","title":"unbounded - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory/unbounded
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/unbounded/#unbounded","title":"unbounded","text":"[jvm]\\ abstract fun unbounded(nameFormat: String): ExecutorService
Returns an executor service that uses Executors.newCachedThreadPool.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/","title":"Sleeper - Misk","text":"//misk-core/misk.concurrent/Sleeper
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/#sleeper","title":"Sleeper","text":"[jvm]\\ interface Sleeper
Abstraction for Thread.sleep() that allows for testing.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/#functions","title":"Functions","text":"Name Summary sleep [jvm]abstract fun sleep(duration: Duration)"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/sleep/","title":"sleep - Misk","text":"//misk-core/misk.concurrent/Sleeper/sleep
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/sleep/#sleep","title":"sleep","text":"[jvm]\\ abstract fun sleep(duration: Duration)
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/","title":"Companion - Misk","text":"//misk-core/misk.concurrent/Sleeper/Companion
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT [jvm]val DEFAULT: Sleeper"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/-d-e-f-a-u-l-t/","title":"DEFAULT - Misk","text":"//misk-core/misk.concurrent/Sleeper/Companion/DEFAULT
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/-d-e-f-a-u-l-t/#default","title":"DEFAULT","text":"[jvm]\\ val DEFAULT: Sleeper
"},{"location":"0.x/misk-core/misk-core/misk.config/","title":"Package-level declarations - Misk","text":"//misk-core/misk.config
"},{"location":"0.x/misk-core/misk-core/misk.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.config/#types","title":"Types","text":"Name Summary Config [jvm]interface Config : Config"},{"location":"0.x/misk-core/misk-core/misk.config/-config/","title":"Config - Misk","text":"//misk-core/misk.config/Config
"},{"location":"0.x/misk-core/misk-core/misk.config/-config/#config","title":"Config","text":"[jvm]\\ interface Config : Config
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/","title":"Package-level declarations - Misk","text":"//misk-core/misk.healthchecks
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.healthchecks/#types","title":"Types","text":"Name Summary HealthCheck [jvm]interface HealthCheckAllows users to define custom health checks. An app with a failing HealthCheck will fail the readiness check inReadinessCheckAction, indicating that the app should not accept traffic. HealthStatus [jvm]data class HealthStatus(val isHealthy: Boolean, val messages: List<String>)"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-check/","title":"HealthCheck - Misk","text":"//misk-core/misk.healthchecks/HealthCheck
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-check/#healthcheck","title":"HealthCheck","text":"[jvm]\\ interface HealthCheck
Allows users to define custom health checks. An app with a failing HealthCheck will fail the readiness check in ReadinessCheckAction, indicating that the app should not accept traffic.
//misk-core/misk.healthchecks/HealthCheck/status
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-check/status/#status","title":"status","text":"[jvm]\\ abstract fun status(): HealthStatus
Computes whether a component of an application is healthy. For example, an implementing class can check database connectivity.
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/","title":"HealthStatus - Misk","text":"//misk-core/misk.healthchecks/HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#healthstatus","title":"HealthStatus","text":"[jvm]\\ data class HealthStatus(val isHealthy: Boolean, val messages: List<String>)
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#constructors","title":"Constructors","text":"HealthStatus [jvm]constructor(isHealthy: Boolean, messages: List<String>)"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#properties","title":"Properties","text":"Name Summary isHealthy [jvm]val isHealthy: Boolean messages [jvm]val messages: List<String>"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-health-status/","title":"HealthStatus - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-health-status/#healthstatus","title":"HealthStatus","text":"[jvm]\\ constructor(isHealthy: Boolean, messages: List<String>)
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/is-healthy/","title":"isHealthy - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/isHealthy
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/is-healthy/#ishealthy","title":"isHealthy","text":"[jvm]\\ val isHealthy: Boolean
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/messages/","title":"messages - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/messages
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/messages/#messages","title":"messages","text":"[jvm]\\ val messages: List<String>
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/","title":"Companion - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/Companion
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/#functions","title":"Functions","text":"Name Summary healthy [jvm]fun healthy(vararg messages: String): HealthStatus unhealthy [jvm]fun unhealthy(vararg messages: String): HealthStatus"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/healthy/","title":"healthy - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/Companion/healthy
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/healthy/#healthy","title":"healthy","text":"[jvm]\\ fun healthy(vararg messages: String): HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/unhealthy/","title":"unhealthy - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/Companion/unhealthy
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/unhealthy/#unhealthy","title":"unhealthy","text":"[jvm]\\ fun unhealthy(vararg messages: String): HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-core/misk.logging
"},{"location":"0.x/misk-core/misk-core/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.logging/#types","title":"Types","text":"Name Summary SampledLogger [jvm]class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger"},{"location":"0.x/misk-core/misk-core/misk.logging/#functions","title":"Functions","text":"Name Summary sampled [jvm]fun KLogger.sampled(sampler: Sampler): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton."},{"location":"0.x/misk-core/misk-core/misk.logging/sampled/","title":"sampled - Misk","text":"//misk-core/misk.logging/sampled
"},{"location":"0.x/misk-core/misk-core/misk.logging/sampled/#sampled","title":"sampled","text":"[jvm]\\ fun KLogger.sampled(sampler: Sampler): KLogger
Returns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton.
To get a rate limited logger:
val logger = getLogger().sampled(RateLimitingSampler(RATE_PER_SECOND))
To get a probabilistic sampler
val logger = getLogger().sampled(PercentSampler(PERCENTAGE_TO_ALLOW))"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/","title":"SampledLogger - Misk","text":"
//misk-core/misk.logging/SampledLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#constructors","title":"Constructors","text":"SampledLogger [jvm]constructor(underlyingLogger: KLogger, sampler: Sampler)"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#properties","title":"Properties","text":"Name Summary underlyingLogger [jvm]open override val underlyingLogger: KLogger"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#functions","title":"Functions","text":"Name Summary atDebug [jvm]@CheckReturnValueopen fun atDebug(): LoggingEventBuilder atError [jvm]@CheckReturnValueopen fun atError(): LoggingEventBuilder atInfo [jvm]@CheckReturnValueopen fun atInfo(): LoggingEventBuilder atLevel [jvm]@CheckReturnValueopen fun atLevel(p0: Level): LoggingEventBuilder atTrace [jvm]@CheckReturnValueopen fun atTrace(): LoggingEventBuilder atWarn [jvm]@CheckReturnValueopen fun atWarn(): LoggingEventBuilder catching [jvm]open override fun <T : Throwable> catching(throwable: T) debug [jvm]open override fun debug(msg: () -> Any?)open override fun debug(msg: String?)open override fun debug(format: String?, arg: Any?)open override fun debug(format: String?, vararg arguments: Any?)open override fun debug(msg: String?, t: Throwable?)open override fun debug(t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: String?)open override fun debug(format: String?, arg1: Any?, arg2: Any?)open override fun debug(marker: Marker?, format: String?, arg: Any?)open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)open override fun debug(marker: Marker?, msg: String?, t: Throwable?)open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) entry [jvm]open override fun entry(vararg argArray: Any?) error [jvm]open override fun error(msg: () -> Any?)open override fun error(msg: String?)open override fun error(format: String?, arg: Any?)open override fun error(format: String?, vararg arguments: Any?)open override fun error(msg: String?, t: Throwable?)open override fun error(t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, msg: () -> Any?)open override fun error(marker: Marker?, msg: String?)open override fun error(format: String?, arg1: Any?, arg2: Any?)open override fun error(marker: Marker?, format: String?, arg: Any?)open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)open override fun error(marker: Marker?, msg: String?, t: Throwable?)open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) exit [jvm]open override fun exit()open override fun <T> exit(result: T): T getName [jvm]open override fun getName(): String info [jvm]open override fun info(msg: () -> Any?)open override fun info(msg: String?)open override fun info(format: String?, arg: Any?)open override fun info(format: String?, vararg arguments: Any?)open override fun info(msg: String?, t: Throwable?)open override fun info(t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, msg: () -> Any?)open override fun info(marker: Marker?, msg: String?)open override fun info(format: String?, arg1: Any?, arg2: Any?)open override fun info(marker: Marker?, format: String?, arg: Any?)open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)open override fun info(marker: Marker?, msg: String?, t: Throwable?)open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) isDebugEnabled [jvm]open override fun isDebugEnabled(): Booleanopen override fun isDebugEnabled(marker: Marker?): Boolean isEnabledForLevel [jvm]open fun isEnabledForLevel(p0: Level): Boolean isErrorEnabled [jvm]open override fun isErrorEnabled(): Booleanopen override fun isErrorEnabled(marker: Marker?): Boolean isInfoEnabled [jvm]open override fun isInfoEnabled(): Booleanopen override fun isInfoEnabled(marker: Marker?): Boolean isTraceEnabled [jvm]open override fun isTraceEnabled(): Booleanopen override fun isTraceEnabled(marker: Marker?): Boolean isWarnEnabled [jvm]open override fun isWarnEnabled(): Booleanopen override fun isWarnEnabled(marker: Marker?): Boolean makeLoggingEventBuilder [jvm]open fun makeLoggingEventBuilder(p0: Level): LoggingEventBuilder sampled [jvm]fun KLogger.sampled(sampler: Sampler): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton. throwing [jvm]open override fun <T : Throwable> throwing(throwable: T): T trace [jvm]open override fun trace(msg: () -> Any?)open override fun trace(msg: String?)open override fun trace(format: String?, arg: Any?)open override fun trace(format: String?, vararg arguments: Any?)open override fun trace(msg: String?, t: Throwable?)open override fun trace(t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: String?)open override fun trace(format: String?, arg1: Any?, arg2: Any?)open override fun trace(marker: Marker?, format: String?, arg: Any?)open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)open override fun trace(marker: Marker?, msg: String?, t: Throwable?)open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) warn [jvm]open override fun warn(msg: () -> Any?)open override fun warn(msg: String?)open override fun warn(format: String?, arg: Any?)open override fun warn(format: String?, vararg arguments: Any?)open override fun warn(msg: String?, t: Throwable?)open override fun warn(t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: String?)open override fun warn(format: String?, arg1: Any?, arg2: Any?)open override fun warn(marker: Marker?, format: String?, arg: Any?)open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)open override fun warn(marker: Marker?, msg: String?, t: Throwable?)open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/-sampled-logger/","title":"SampledLogger - Misk","text":"//misk-core/misk.logging/SampledLogger/SampledLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ constructor(underlyingLogger: KLogger, sampler: Sampler)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/catching/","title":"catching - Misk","text":"//misk-core/misk.logging/SampledLogger/catching
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/catching/#catching","title":"catching","text":"[jvm]\\ open override fun <T : Throwable> catching(throwable: T)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/debug/","title":"debug - Misk","text":"//misk-core/misk.logging/SampledLogger/debug
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/debug/#debug","title":"debug","text":"[jvm]\\ open override fun debug(msg: () -> Any?)
open override fun debug(t: Throwable?, msg: () -> Any?)
open override fun debug(marker: Marker?, msg: () -> Any?)
open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun debug(msg: String?)
open override fun debug(format: String?, arg: Any?)
open override fun debug(format: String?, arg1: Any?, arg2: Any?)
open override fun debug(format: String?, vararg arguments: Any?)
open override fun debug(msg: String?, t: Throwable?)
open override fun debug(marker: Marker?, msg: String?)
open override fun debug(marker: Marker?, format: String?, arg: Any?)
open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun debug(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/entry/","title":"entry - Misk","text":"//misk-core/misk.logging/SampledLogger/entry
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/entry/#entry","title":"entry","text":"[jvm]\\ open override fun entry(vararg argArray: Any?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/error/","title":"error - Misk","text":"//misk-core/misk.logging/SampledLogger/error
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/error/#error","title":"error","text":"[jvm]\\ open override fun error(msg: () -> Any?)
open override fun error(t: Throwable?, msg: () -> Any?)
open override fun error(marker: Marker?, msg: () -> Any?)
open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun error(msg: String?)
open override fun error(format: String?, arg: Any?)
open override fun error(format: String?, arg1: Any?, arg2: Any?)
open override fun error(format: String?, vararg arguments: Any?)
open override fun error(msg: String?, t: Throwable?)
open override fun error(marker: Marker?, msg: String?)
open override fun error(marker: Marker?, format: String?, arg: Any?)
open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun error(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/exit/","title":"exit - Misk","text":"//misk-core/misk.logging/SampledLogger/exit
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/exit/#exit","title":"exit","text":"[jvm]\\ open override fun exit()
open override fun <T> exit(result: T): T
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/get-name/","title":"getName - Misk","text":"//misk-core/misk.logging/SampledLogger/getName
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/get-name/#getname","title":"getName","text":"[jvm]\\ open override fun getName(): String
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/info/","title":"info - Misk","text":"//misk-core/misk.logging/SampledLogger/info
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/info/#info","title":"info","text":"[jvm]\\ open override fun info(msg: () -> Any?)
open override fun info(t: Throwable?, msg: () -> Any?)
open override fun info(marker: Marker?, msg: () -> Any?)
open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun info(msg: String?)
open override fun info(format: String?, arg: Any?)
open override fun info(format: String?, arg1: Any?, arg2: Any?)
open override fun info(format: String?, vararg arguments: Any?)
open override fun info(msg: String?, t: Throwable?)
open override fun info(marker: Marker?, msg: String?)
open override fun info(marker: Marker?, format: String?, arg: Any?)
open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun info(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-debug-enabled/","title":"isDebugEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isDebugEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-debug-enabled/#isdebugenabled","title":"isDebugEnabled","text":"[jvm]\\ open override fun isDebugEnabled(): Boolean
open override fun isDebugEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-error-enabled/","title":"isErrorEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isErrorEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-error-enabled/#iserrorenabled","title":"isErrorEnabled","text":"[jvm]\\ open override fun isErrorEnabled(): Boolean
open override fun isErrorEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-info-enabled/","title":"isInfoEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isInfoEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-info-enabled/#isinfoenabled","title":"isInfoEnabled","text":"[jvm]\\ open override fun isInfoEnabled(): Boolean
open override fun isInfoEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-trace-enabled/","title":"isTraceEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isTraceEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-trace-enabled/#istraceenabled","title":"isTraceEnabled","text":"[jvm]\\ open override fun isTraceEnabled(): Boolean
open override fun isTraceEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-warn-enabled/","title":"isWarnEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isWarnEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-warn-enabled/#iswarnenabled","title":"isWarnEnabled","text":"[jvm]\\ open override fun isWarnEnabled(): Boolean
open override fun isWarnEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/throwing/","title":"throwing - Misk","text":"//misk-core/misk.logging/SampledLogger/throwing
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/throwing/#throwing","title":"throwing","text":"[jvm]\\ open override fun <T : Throwable> throwing(throwable: T): T
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/trace/","title":"trace - Misk","text":"//misk-core/misk.logging/SampledLogger/trace
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/trace/#trace","title":"trace","text":"[jvm]\\ open override fun trace(msg: () -> Any?)
open override fun trace(t: Throwable?, msg: () -> Any?)
open override fun trace(marker: Marker?, msg: () -> Any?)
open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun trace(msg: String?)
open override fun trace(format: String?, arg: Any?)
open override fun trace(format: String?, arg1: Any?, arg2: Any?)
open override fun trace(format: String?, vararg arguments: Any?)
open override fun trace(msg: String?, t: Throwable?)
open override fun trace(marker: Marker?, msg: String?)
open override fun trace(marker: Marker?, format: String?, arg: Any?)
open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)
open override fun trace(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/underlying-logger/","title":"underlyingLogger - Misk","text":"//misk-core/misk.logging/SampledLogger/underlyingLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/underlying-logger/#underlyinglogger","title":"underlyingLogger","text":"[jvm]\\ open override val underlyingLogger: KLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/warn/","title":"warn - Misk","text":"//misk-core/misk.logging/SampledLogger/warn
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/warn/#warn","title":"warn","text":"[jvm]\\ open override fun warn(msg: () -> Any?)
open override fun warn(t: Throwable?, msg: () -> Any?)
open override fun warn(marker: Marker?, msg: () -> Any?)
open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun warn(msg: String?)
open override fun warn(format: String?, arg: Any?)
open override fun warn(format: String?, vararg arguments: Any?)
open override fun warn(format: String?, arg1: Any?, arg2: Any?)
open override fun warn(msg: String?, t: Throwable?)
open override fun warn(marker: Marker?, msg: String?)
open override fun warn(marker: Marker?, format: String?, arg: Any?)
open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun warn(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.random/","title":"Package-level declarations - Misk","text":"//misk-core/misk.random
"},{"location":"0.x/misk-core/misk-core/misk.random/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.random/#types","title":"Types","text":"Name Summary Random [jvm]@Singletonopen class Random@Injectconstructor : RandomAbstraction for Java\u2019s Random that allows for testing. ThreadLocalRandom [jvm]@Singletonopen class ThreadLocalRandom@InjectconstructorAbstraction for Java\u2019s ThreadLocalRandom that allows for testing."},{"location":"0.x/misk-core/misk-core/misk.random/-random/","title":"Random - Misk","text":"//misk-core/misk.random/Random
"},{"location":"0.x/misk-core/misk-core/misk.random/-random/#random","title":"Random","text":"[jvm]\\ @Singleton
open class Random@Injectconstructor : Random
Abstraction for Java\u2019s Random that allows for testing.
"},{"location":"0.x/misk-core/misk-core/misk.random/-random/#constructors","title":"Constructors","text":"Random [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.random/-random/#functions","title":"Functions","text":"Name Summary doubles [jvm]open override fun doubles(): DoubleStreamopen override fun doubles(p0: Long): DoubleStreamopen override fun doubles(p0: Double, p1: Double): DoubleStreamopen override fun doubles(p0: Long, p1: Double, p2: Double): DoubleStream ints [jvm]open override fun ints(): IntStreamopen override fun ints(p0: Long): IntStreamopen override fun ints(p0: Int, p1: Int): IntStreamopen override fun ints(p0: Long, p1: Int, p2: Int): IntStream isDeprecated [jvm]open fun isDeprecated(): Boolean longs [jvm]open override fun longs(): LongStreamopen override fun longs(p0: Long): LongStreamopen override fun longs(p0: Long, p1: Long): LongStreamopen override fun longs(p0: Long, p1: Long, p2: Long): LongStream nextBoolean [jvm]open override fun nextBoolean(): Boolean nextBytes [jvm]open override fun nextBytes(p0: ByteArray) nextDouble [jvm]open override fun nextDouble(): Doubleopen fun nextDouble(p0: Double): Doubleopen fun nextDouble(p0: Double, p1: Double): Double nextExponential [jvm]open fun nextExponential(): Double nextFloat [jvm]open override fun nextFloat(): Floatopen fun nextFloat(p0: Float): Floatopen fun nextFloat(p0: Float, p1: Float): Float nextGaussian [jvm]open override fun nextGaussian(): Doubleopen fun nextGaussian(p0: Double, p1: Double): Double nextInt [jvm]open override fun nextInt(): Intopen override fun nextInt(p0: Int): Intopen fun nextInt(p0: Int, p1: Int): Int nextLong [jvm]open override fun nextLong(): Longopen fun nextLong(p0: Long): Longopen fun nextLong(p0: Long, p1: Long): Long setSeed [jvm]open fun setSeed(p0: Long)"},{"location":"0.x/misk-core/misk-core/misk.random/-random/-random/","title":"Random - Misk","text":"//misk-core/misk.random/Random/Random
"},{"location":"0.x/misk-core/misk-core/misk.random/-random/-random/#random","title":"Random","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/","title":"ThreadLocalRandom - Misk","text":"//misk-core/misk.random/ThreadLocalRandom
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/#threadlocalrandom","title":"ThreadLocalRandom","text":"[jvm]\\ @Singleton
open class ThreadLocalRandom@Injectconstructor
Abstraction for Java\u2019s ThreadLocalRandom that allows for testing.
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/#constructors","title":"Constructors","text":"ThreadLocalRandom [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/#functions","title":"Functions","text":"Name Summary current [jvm]open fun current(): Random"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/-thread-local-random/","title":"ThreadLocalRandom - Misk","text":"//misk-core/misk.random/ThreadLocalRandom/ThreadLocalRandom
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/-thread-local-random/#threadlocalrandom","title":"ThreadLocalRandom","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/current/","title":"current - Misk","text":"//misk-core/misk.random/ThreadLocalRandom/current
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/current/#current","title":"current","text":"[jvm]\\ open fun current(): Random
"},{"location":"0.x/misk-core/misk-core/misk.retries/","title":"Package-level declarations - Misk","text":"//misk-core/misk.retries
"},{"location":"0.x/misk-core/misk-core/misk.retries/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.retries/#functions","title":"Functions","text":"Name Summary doNotRetry [jvm]inline fun <T : Exception> doNotRetry(): RetryPolicy<Throwable>Returns a RetryPolicy that will throw the error that triggered the retry if it is type T. Otherwise, it voices no objection to retrying. retryWithHooks [jvm]suspend fun <T> retryWithHooks(policy: RetryPolicy<Throwable>, beforeRetryHook: () -> Unit, op: () -> T): TThis is a retry helper function with some hooks."},{"location":"0.x/misk-core/misk-core/misk.retries/do-not-retry/","title":"doNotRetry - Misk","text":"//misk-core/misk.retries/doNotRetry
"},{"location":"0.x/misk-core/misk-core/misk.retries/do-not-retry/#donotretry","title":"doNotRetry","text":"[jvm]\\ inline fun <T : Exception> doNotRetry(): RetryPolicy<Throwable>
Returns a RetryPolicy that will throw the error that triggered the retry if it is type T. Otherwise, it voices no objection to retrying.
"},{"location":"0.x/misk-core/misk-core/misk.retries/retry-with-hooks/","title":"retryWithHooks - Misk","text":"//misk-core/misk.retries/retryWithHooks
"},{"location":"0.x/misk-core/misk-core/misk.retries/retry-with-hooks/#retrywithhooks","title":"retryWithHooks","text":"[jvm]\\ suspend fun <T> retryWithHooks(policy: RetryPolicy<Throwable>, beforeRetryHook: () -> Unit, op: () -> T): T
This is a retry helper function with some hooks.
//misk-core/misk.sampling
"},{"location":"0.x/misk-core/misk-core/misk.sampling/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.sampling/#types","title":"Types","text":"Name Summary AlwaysSampler [jvm]@Singletonclass AlwaysSampler@Injectconstructor : SamplerSampler that always invokes an action PercentSampler [jvm]class PercentSampler@JvmOverloadsconstructor(val samplePercentage: () -> Int, val random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) }) : SamplerA Sampler randomly invokes an action based on a sample percentage RateLimiter [jvm]class RateLimiterA deterministic testable rate limiter that uses two variables: RateLimitingSampler [jvm]class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler Sampler [jvm]interface Sampler"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/","title":"AlwaysSampler - Misk","text":"//misk-core/misk.sampling/AlwaysSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\ @Singleton
class AlwaysSampler@Injectconstructor : Sampler
Sampler that always invokes an action
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/#constructors","title":"Constructors","text":"AlwaysSampler [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/-always-sampler/","title":"AlwaysSampler - Misk","text":"//misk-core/misk.sampling/AlwaysSampler/AlwaysSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/AlwaysSampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/","title":"PercentSampler - Misk","text":"//misk-core/misk.sampling/PercentSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#percentsampler","title":"PercentSampler","text":"[jvm]\\ class PercentSampler@JvmOverloadsconstructor(val samplePercentage: () -> Int, val random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) }) : Sampler
A Sampler randomly invokes an action based on a sample percentage
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#constructors","title":"Constructors","text":"PercentSampler [jvm]constructor(samplePercentage: Int, random: () -> Int)constructor(samplePercentage: Int)@JvmOverloadsconstructor(samplePercentage: () -> Int, random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) })"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#properties","title":"Properties","text":"Name Summary random [jvm]val random: () -> Int samplePercentage [jvm]val samplePercentage: () -> Int"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/-percent-sampler/","title":"PercentSampler - Misk","text":"//misk-core/misk.sampling/PercentSampler/PercentSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/-percent-sampler/#percentsampler","title":"PercentSampler","text":"[jvm]\\ constructor(samplePercentage: Int, random: () -> Int)
constructor(samplePercentage: Int)
@JvmOverloads
constructor(samplePercentage: () -> Int, random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) })
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/random/","title":"random - Misk","text":"//misk-core/misk.sampling/PercentSampler/random
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/random/#random","title":"random","text":"[jvm]\\ val random: () -> Int
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample-percentage/","title":"samplePercentage - Misk","text":"//misk-core/misk.sampling/PercentSampler/samplePercentage
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample-percentage/#samplepercentage","title":"samplePercentage","text":"[jvm]\\ val samplePercentage: () -> Int
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/PercentSampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/","title":"RateLimiter - Misk","text":"//misk-core/misk.sampling/RateLimiter
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\ class RateLimiter
A deterministic testable rate limiter that uses two variables:
The implementation tracks a future timestamp that permits are consumed until.
This class is similar to Guava\u2019s rate limiter. Unlike Guava\u2019s rate limiter this class is testable by application code using the rate limiter. It also has very predictable behavior because its internal mechanisms are simpler than Guava\u2019s.
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor(ticker: Ticker, sleeper: Sleeper)"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#properties","title":"Properties","text":"Name Summary permitsPerSecond [jvm]@Volatilevar permitsPerSecond: Long"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#functions","title":"Functions","text":"Name Summary getPermitsRemaining [jvm]fun getPermitsRemaining(unit: TimeUnit, timeout: Long): LongReturns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit. tryAcquire [jvm]fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): BooleanAttempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available."},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/get-permits-remaining/","title":"getPermitsRemaining - Misk","text":"//misk-core/misk.sampling/RateLimiter/getPermitsRemaining
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/get-permits-remaining/#getpermitsremaining","title":"getPermitsRemaining","text":"[jvm]\\ fun getPermitsRemaining(unit: TimeUnit, timeout: Long): Long
Returns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit.
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/permits-per-second/","title":"permitsPerSecond - Misk","text":"//misk-core/misk.sampling/RateLimiter/permitsPerSecond
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/permits-per-second/#permitspersecond","title":"permitsPerSecond","text":"[jvm]\\
@Volatile
var permitsPerSecond: Long
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"//misk-core/misk.sampling/RateLimiter/tryAcquire
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"[jvm]\\ fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): Boolean
Attempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available.
Returns true if permits were acquired.
This always returns false if you request more than 1 window size worth of permits. If you need many permits, shrink your batch size. This is intended to smooth out consumption of the resources guarded by this rate limiter.
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/","title":"Factory - Misk","text":"//misk-core/misk.sampling/RateLimiter/Factory
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory@Injectconstructor(ticker: Ticker, sleeper: Sleeper)
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor(ticker: Ticker, sleeper: Sleeper)"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(rate: Long): RateLimiter"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/-factory/","title":"Factory - Misk","text":"//misk-core/misk.sampling/RateLimiter/Factory/Factory
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor(ticker: Ticker, sleeper: Sleeper)
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/create/","title":"create - Misk","text":"//misk-core/misk.sampling/RateLimiter/Factory/create
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/create/#create","title":"create","text":"[jvm]\\ fun create(rate: Long): RateLimiter
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//misk-core/misk.sampling/RateLimitingSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/#constructors","title":"Constructors","text":"RateLimitingSampler [jvm]constructor(ratePerSecond: Long)constructor(rateLimiter: RateLimiter)"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//misk-core/misk.sampling/RateLimitingSampler/RateLimitingSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ constructor(ratePerSecond: Long)
constructor(rateLimiter: RateLimiter)
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/RateLimitingSampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/","title":"Sampler - Misk","text":"//misk-core/misk.sampling/Sampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/#sampler","title":"Sampler","text":"interface Sampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/#inheritors","title":"Inheritors","text":"PercentSampler RateLimitingSampler AlwaysSampler"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]abstract fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/Sampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sample/#sample","title":"sample","text":"[jvm]\\ abstract fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sampled-call/","title":"sampledCall - Misk","text":"//misk-core/misk.sampling/Sampler/sampledCall
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sampled-call/#sampledcall","title":"sampledCall","text":"[jvm]\\ open fun sampledCall(f: () -> Unit)
If sample returns true, runs the given lambda
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/","title":"Package-level declarations - Misk","text":"//misk-core/misk.security.ssl
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#types","title":"Types","text":"Name Summary CertificateAndKey [jvm]typealias CertificateAndKey = wisp.security.ssl.CertificateAndKey CertStore [jvm]typealias CertStore = wisp.security.ssl.CertStoreA certificate and its private key. CertStoreConfig [jvm]data class CertStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS) SslContextFactory [jvm]class SslContextFactory@Injectconstructor(sslLoader: SslLoader) SslLoader [jvm]class SslLoaderLoads keys and certificates from the file system. TrustStore [jvm]typealias TrustStore = wisp.security.ssl.TrustStoreA set of trusted root certificates. TrustStoreConfig [jvm]data class TrustStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#properties","title":"Properties","text":"Name Summary onlyAlias [jvm]val KeyStore.onlyAlias: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#functions","title":"Functions","text":"Name Summary aliasesOfType [jvm]inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String> getCertificateAndKey [jvm]fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey? getPrivateKey [jvm]fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKeyfun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey getX509Certificate [jvm]fun KeyStore.getX509Certificate(): X509Certificatefun KeyStore.getX509Certificate(alias: String): X509Certificate getX509CertificateChain [jvm]fun KeyStore.getX509CertificateChain(): Array<X509Certificate>fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/aliases-of-type/","title":"aliasesOfType - Misk","text":"//misk-core/misk.security.ssl/aliasesOfType
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/aliases-of-type/#aliasesoftype","title":"aliasesOfType","text":"[jvm]\\ fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/aliases-of-type/#return","title":"Return","text":"all aliases present in the keystore of a given entry type.
[jvm]\\ inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/","title":"getCertificateAndKey - Misk","text":"//misk-core/misk.security.ssl/getCertificateAndKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/#getcertificateandkey","title":"getCertificateAndKey","text":"[jvm]\\ fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/#return","title":"Return","text":"the certificate and key pair for the given alias
[jvm]\\ fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/#return_1","title":"Return","text":"the one and only CertificateAndKey in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/","title":"getPrivateKey - Misk","text":"//misk-core/misk.security.ssl/getPrivateKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/#getprivatekey","title":"getPrivateKey","text":"[jvm]\\ fun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/#return","title":"Return","text":"the PrivateKey with the given alias
[jvm]\\ fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/#return_1","title":"Return","text":"the one and only PrivateKey in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/","title":"getX509CertificateChain - Misk","text":"//misk-core/misk.security.ssl/getX509CertificateChain
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/#getx509certificatechain","title":"getX509CertificateChain","text":"[jvm]\\ fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/#return","title":"Return","text":"the X509Certificate chain with the provided alias
[jvm]\\ fun KeyStore.getX509CertificateChain(): Array<X509Certificate>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/#return_1","title":"Return","text":"the one and only X509Certificate chain in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/","title":"getX509Certificate - Misk","text":"//misk-core/misk.security.ssl/getX509Certificate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/#getx509certificate","title":"getX509Certificate","text":"[jvm]\\ fun KeyStore.getX509Certificate(alias: String): X509Certificate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/#return","title":"Return","text":"The X509Certificate with the provided alias
[jvm]\\ fun KeyStore.getX509Certificate(): X509Certificate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/#return_1","title":"Return","text":"the one and only X509Certificate in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/only-alias/","title":"onlyAlias - Misk","text":"//misk-core/misk.security.ssl/onlyAlias
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/only-alias/#onlyalias","title":"onlyAlias","text":"[jvm]\\ val KeyStore.onlyAlias: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/only-alias/#return","title":"Return","text":"the only alias in the keystore, if the keystore only has a single entry
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store/","title":"CertStore - Misk","text":"//misk-core/misk.security.ssl/CertStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store/#certstore","title":"CertStore","text":"[jvm]\\ typealias CertStore = wisp.security.ssl.CertStore
A certificate and its private key.
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\ data class CertStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#constructors","title":"Constructors","text":"CertStoreConfig [jvm]@Injectconstructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): CertStoreConfig"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/CertStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\
@Inject
constructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/format/","title":"format - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/format
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/passphrase/","title":"passphrase - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/passphrase
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/resource/","title":"resource - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/resource
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/toWispConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): CertStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-certificate-and-key/","title":"CertificateAndKey - Misk","text":"//misk-core/misk.security.ssl/CertificateAndKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-certificate-and-key/#certificateandkey","title":"CertificateAndKey","text":"[jvm]\\ typealias CertificateAndKey = wisp.security.ssl.CertificateAndKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\ class SslContextFactory@Injectconstructor(sslLoader: SslLoader)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#constructors","title":"Constructors","text":"SslContextFactory [jvm]@Injectconstructor(sslLoader: SslLoader)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: SslContextFactory"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsfun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext@JvmOverloadsfun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext loadTrustManagers [jvm]fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/SslContextFactory
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\
@Inject
constructor(sslLoader: SslLoader)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/create/","title":"create - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/create
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/create/#create","title":"create","text":"[jvm]\\
@JvmOverloads
fun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext
@JvmOverloads
fun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/create/#return","title":"Return","text":"A new SSLContext for the given certstore and optional truststore config
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/delegate/","title":"delegate - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/delegate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: SslContextFactory
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/load-trust-managers/","title":"loadTrustManagers - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/loadTrustManagers
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/load-trust-managers/#loadtrustmanagers","title":"loadTrustManagers","text":"[jvm]\\ fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/load-trust-managers/#return","title":"Return","text":"a set of TrustManagers based on the certificates in the given truststore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/","title":"SslLoader - Misk","text":"//misk-core/misk.security.ssl/SslLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#sslloader","title":"SslLoader","text":"[jvm]\\ class SslLoader
Loads keys and certificates from the file system.
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: SslLoader resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#functions","title":"Functions","text":"Name Summary loadCertStore [jvm]fun loadCertStore(config: CertStoreConfig): CertStore?@JvmOverloadsfun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore? loadTrustStore [jvm]fun loadTrustStore(config: TrustStoreConfig): TrustStore?@JvmOverloadsfun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/delegate/","title":"delegate - Misk","text":"//misk-core/misk.security.ssl/SslLoader/delegate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: SslLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-cert-store/","title":"loadCertStore - Misk","text":"//misk-core/misk.security.ssl/SslLoader/loadCertStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-cert-store/#loadcertstore","title":"loadCertStore","text":"[jvm]\\
@JvmOverloads
fun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore?
fun loadCertStore(config: CertStoreConfig): CertStore?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-trust-store/","title":"loadTrustStore - Misk","text":"//misk-core/misk.security.ssl/SslLoader/loadTrustStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-trust-store/#loadtruststore","title":"loadTrustStore","text":"[jvm]\\
@JvmOverloads
fun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?
fun loadTrustStore(config: TrustStoreConfig): TrustStore?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/resource-loader/","title":"resourceLoader - Misk","text":"//misk-core/misk.security.ssl/SslLoader/resourceLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/","title":"Companion - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/#properties","title":"Properties","text":"Name Summary FORMAT_JCEKS [jvm]const val FORMAT_JCEKS: String FORMAT_JKS [jvm]const val FORMAT_JKS: String FORMAT_PEM [jvm]const val FORMAT_PEM: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/","title":"FORMAT_JCEKS - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion/FORMAT_JCEKS
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/#format_jceks","title":"FORMAT_JCEKS","text":"[jvm]\\ const val FORMAT_JCEKS: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/","title":"FORMAT_JKS - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion/FORMAT_JKS
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/#format_jks","title":"FORMAT_JKS","text":"[jvm]\\ const val FORMAT_JKS: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/","title":"FORMAT_PEM - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion/FORMAT_PEM
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/#format_pem","title":"FORMAT_PEM","text":"[jvm]\\ const val FORMAT_PEM: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store/","title":"TrustStore - Misk","text":"//misk-core/misk.security.ssl/TrustStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store/#truststore","title":"TrustStore","text":"[jvm]\\ typealias TrustStore = wisp.security.ssl.TrustStore
A set of trusted root certificates.
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\ data class TrustStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#constructors","title":"Constructors","text":"TrustStoreConfig [jvm]@Injectconstructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): TrustStoreConfig"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/TrustStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\
@Inject
constructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/format/","title":"format - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/format
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/passphrase/","title":"passphrase - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/passphrase
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/resource/","title":"resource - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/resource
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/toWispConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): TrustStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.tokens/","title":"Package-level declarations - Misk","text":"//misk-core/misk.tokens
"},{"location":"0.x/misk-core/misk-core/misk.tokens/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.tokens/#types","title":"Types","text":"Name Summary FakeTokenGenerator [jvm]@Singletonclass FakeTokenGenerator@Injectconstructor : TokenGenerator FakeTokenGenerator2 [jvm]@Singletonclass FakeTokenGenerator2@Injectconstructor : TokenGenerator2 FakeTokenGeneratorModule [jvm]class FakeTokenGeneratorModule : KAbstractModule RealTokenGenerator [jvm]@Singletonclass RealTokenGenerator@Injectconstructor : TokenGenerator RealTokenGenerator2 [jvm]@Singletonclass RealTokenGenerator2@Injectconstructor : TokenGenerator2 TokenGenerator [jvm]typealias TokenGenerator = wisp.token.TokenGenerator TokenGenerator2 [jvm]interface TokenGenerator2 TokenGeneratorModule [jvm]class TokenGeneratorModule : KAbstractModule"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\ @Singleton
class FakeTokenGenerator@Injectconstructor : TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/#constructors","title":"Constructors","text":"FakeTokenGenerator [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator/FakeTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/","title":"FakeTokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/FakeTokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/#faketokengeneratormodule","title":"FakeTokenGeneratorModule","text":"[jvm]\\ class FakeTokenGeneratorModule : KAbstractModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/#constructors","title":"Constructors","text":"FakeTokenGeneratorModule [jvm]constructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/-fake-token-generator-module/","title":"FakeTokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/FakeTokenGeneratorModule/FakeTokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/-fake-token-generator-module/#faketokengeneratormodule","title":"FakeTokenGeneratorModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/","title":"FakeTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/#faketokengenerator2","title":"FakeTokenGenerator2","text":"[jvm]\\ @Singleton
class FakeTokenGenerator2@Injectconstructor : TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/#constructors","title":"Constructors","text":"FakeTokenGenerator2 [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/-fake-token-generator2/","title":"FakeTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator2/FakeTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/-fake-token-generator2/#faketokengenerator2","title":"FakeTokenGenerator2","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/generate/","title":"generate - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator2/generate
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\ @Singleton
class RealTokenGenerator@Injectconstructor : TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/#constructors","title":"Constructors","text":"RealTokenGenerator [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator/RealTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/","title":"RealTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/#realtokengenerator2","title":"RealTokenGenerator2","text":"[jvm]\\ @Singleton
class RealTokenGenerator2@Injectconstructor : TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/#constructors","title":"Constructors","text":"RealTokenGenerator2 [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/-real-token-generator2/","title":"RealTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator2/RealTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/-real-token-generator2/#realtokengenerator2","title":"RealTokenGenerator2","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/generate/","title":"generate - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator2/generate
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator/","title":"TokenGenerator - Misk","text":"//misk-core/misk.tokens/TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator/#tokengenerator","title":"TokenGenerator","text":"[jvm]\\ typealias TokenGenerator = wisp.token.TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/","title":"TokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/TokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/#tokengeneratormodule","title":"TokenGeneratorModule","text":"[jvm]\\ class TokenGeneratorModule : KAbstractModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/#constructors","title":"Constructors","text":"TokenGeneratorModule [jvm]constructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/-token-generator-module/","title":"TokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/TokenGeneratorModule/TokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/-token-generator-module/#tokengeneratormodule","title":"TokenGeneratorModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/","title":"TokenGenerator2 - Misk","text":"//misk-core/misk.tokens/TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#tokengenerator2","title":"TokenGenerator2","text":"interface TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#inheritors","title":"Inheritors","text":"FakeTokenGenerator2 RealTokenGenerator2"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#functions","title":"Functions","text":"Name Summary generate [jvm]abstract fun generate(label: String? = null, length: Int = 25): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/generate/","title":"generate - Misk","text":"//misk-core/misk.tokens/TokenGenerator2/generate
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/generate/#generate","title":"generate","text":"[jvm]\\ abstract fun generate(label: String? = null, length: Int = 25): String
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/","title":"Companion - Misk","text":"//misk-core/misk.tokens/TokenGenerator2/Companion
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/#functions","title":"Functions","text":"Name Summary canonicalize [jvm]fun canonicalize(token: String): StringReturns a token semantically equal totoken but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted."},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/canonicalize/","title":"canonicalize - Misk","text":"//misk-core/misk.tokens/TokenGenerator2/Companion/canonicalize
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/canonicalize/#canonicalize","title":"canonicalize","text":"[jvm]\\ fun canonicalize(token: String): String
Returns a token semantically equal to token but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted.
Call this when accepting tokens that may have been transcribed by a user. It is not necessary to canonicalize tokens that haven\u2019t been manually entered; they will already be in canonical form.
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/canonicalize/#throws","title":"Throws","text":"IllegalArgumentException iftoken contains a character that cannot be mapped and that is not a space."},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/","title":"Package-level declarations - Misk","text":"//misk-core/misk.web.mediatype
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/#types","title":"Types","text":"Name Summary MediaRange [jvm]data class MediaRange@JvmOverloadsconstructor(val type: String, val subtype: String, val charset: Charset? = null, val qualityFactor: Double = 1.0, val parameters: Map<String, String> = mapOf(), val extensions: Map<String, String> = mapOf(), rawText: String) : Comparable<MediaRange> An RFC-2616 media range MediaTypes [jvm]object MediaTypes"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/#functions","title":"Functions","text":"Name Summary asMediaRange [jvm]fun String.asMediaRange(): MediaRange asMediaType [jvm]fun String.asMediaType(): MediaType compareTo [jvm]fun MediaType.compareTo(other: MediaType): Int"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-range/","title":"asMediaRange - Misk","text":"//misk-core/misk.web.mediatype/asMediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-range/#asmediarange","title":"asMediaRange","text":"[jvm]\\ fun String.asMediaRange(): MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-type/","title":"asMediaType - Misk","text":"//misk-core/misk.web.mediatype/asMediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-type/#asmediatype","title":"asMediaType","text":"[jvm]\\ fun String.asMediaType(): MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/compare-to/","title":"compareTo - Misk","text":"//misk-core/misk.web.mediatype/compareTo
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ fun MediaType.compareTo(other: MediaType): Int
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/","title":"MediaRange - Misk","text":"//misk-core/misk.web.mediatype/MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#mediarange","title":"MediaRange","text":"[jvm]\\ data class MediaRange@JvmOverloadsconstructor(val type: String, val subtype: String, val charset: Charset? = null, val qualityFactor: Double = 1.0, val parameters: Map<String, String> = mapOf(), val extensions: Map<String, String> = mapOf(), rawText: String) : Comparable<MediaRange>
An RFC-2616 media range
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#constructors","title":"Constructors","text":"MediaRange [jvm]@JvmOverloadsconstructor(type: String, subtype: String, charset: Charset? = null, qualityFactor: Double = 1.0, parameters: Map<String, String> = mapOf(), extensions: Map<String, String> = mapOf(), rawText: String)"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Matcher [jvm]class Matcher@JvmOverloadsconstructor(val mediaRange: MediaRange, val matchesCharset: Boolean = false) : Comparable<MediaRange.Matcher>"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#properties","title":"Properties","text":"Name Summary charset [jvm]val charset: Charset? = null extensions [jvm]val extensions: Map<String, String> parameters [jvm]val parameters: Map<String, String> qualityFactor [jvm]val qualityFactor: Double = 1.0 subtype [jvm]val subtype: String type [jvm]val type: String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: MediaRange): Int matcher [jvm]fun matcher(mediaType: MediaType): MediaRange.Matcher? toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-media-range/","title":"MediaRange - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-media-range/#mediarange","title":"MediaRange","text":"[jvm]\\
@JvmOverloads
constructor(type: String, subtype: String, charset: Charset? = null, qualityFactor: Double = 1.0, parameters: Map<String, String> = mapOf(), extensions: Map<String, String> = mapOf(), rawText: String)
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/charset/","title":"charset - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/charset
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/charset/#charset","title":"charset","text":"[jvm]\\ val charset: Charset? = null
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/compare-to/","title":"compareTo - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/compareTo
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: MediaRange): Int
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/extensions/","title":"extensions - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/extensions
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/extensions/#extensions","title":"extensions","text":"[jvm]\\ val extensions: Map<String, String>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/matcher/","title":"matcher - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/matcher
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/matcher/#matcher","title":"matcher","text":"[jvm]\\ fun matcher(mediaType: MediaType): MediaRange.Matcher?
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/parameters/","title":"parameters - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/parameters
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/parameters/#parameters","title":"parameters","text":"[jvm]\\ val parameters: Map<String, String>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/quality-factor/","title":"qualityFactor - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/qualityFactor
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/quality-factor/#qualityfactor","title":"qualityFactor","text":"[jvm]\\ val qualityFactor: Double = 1.0
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/subtype/","title":"subtype - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/subtype
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/subtype/#subtype","title":"subtype","text":"[jvm]\\ val subtype: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/to-string/","title":"toString - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/toString
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/type/","title":"type - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/type
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/","title":"Companion - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/#properties","title":"Properties","text":"Name Summary ALL_MEDIA [jvm]val ALL_MEDIA: MediaRange WILDCARD [jvm]const val WILDCARD: String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(s: String): MediaRange parseRanges [jvm]fun parseRanges(s: String, swallowExceptions: Boolean = false): List<MediaRange>"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-a-l-l_-m-e-d-i-a/","title":"ALL_MEDIA - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/ALL_MEDIA
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-a-l-l_-m-e-d-i-a/#all_media","title":"ALL_MEDIA","text":"[jvm]\\ val ALL_MEDIA: MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-w-i-l-d-c-a-r-d/","title":"WILDCARD - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/WILDCARD
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-w-i-l-d-c-a-r-d/#wildcard","title":"WILDCARD","text":"[jvm]\\ const val WILDCARD: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse-ranges/","title":"parseRanges - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/parseRanges
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse-ranges/#parseranges","title":"parseRanges","text":"[jvm]\\ fun parseRanges(s: String, swallowExceptions: Boolean = false): List<MediaRange>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse/","title":"parse - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/parse
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(s: String): MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/","title":"Matcher - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#matcher","title":"Matcher","text":"[jvm]\\ class Matcher@JvmOverloadsconstructor(val mediaRange: MediaRange, val matchesCharset: Boolean = false) : Comparable<MediaRange.Matcher>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#constructors","title":"Constructors","text":"Matcher [jvm]@JvmOverloadsconstructor(mediaRange: MediaRange, matchesCharset: Boolean = false)"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#properties","title":"Properties","text":"Name Summary matchesCharset [jvm]val matchesCharset: Boolean = false mediaRange [jvm]val mediaRange: MediaRange"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: MediaRange.Matcher): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/-matcher/","title":"Matcher - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/Matcher
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/-matcher/#matcher","title":"Matcher","text":"[jvm]\\
@JvmOverloads
constructor(mediaRange: MediaRange, matchesCharset: Boolean = false)
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/compare-to/","title":"compareTo - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/compareTo
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: MediaRange.Matcher): Int
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/matches-charset/","title":"matchesCharset - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/matchesCharset
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/matches-charset/#matchescharset","title":"matchesCharset","text":"[jvm]\\ val matchesCharset: Boolean = false
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/media-range/","title":"mediaRange - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/mediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/media-range/#mediarange","title":"mediaRange","text":"[jvm]\\ val mediaRange: MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/to-string/","title":"toString - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/toString
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/","title":"MediaTypes - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/#mediatypes","title":"MediaTypes","text":"[jvm]\\ object MediaTypes
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/#properties","title":"Properties","text":"Name Summary ALL [jvm]const val ALL: String ALL_MEDIA_TYPE [jvm]val ALL_MEDIA_TYPE: MediaType APPLICATION_FORM_URLENCODED [jvm]const val APPLICATION_FORM_URLENCODED: String APPLICATION_GRPC [jvm]const val APPLICATION_GRPC: String APPLICATION_GRPC_MEDIA_TYPE [jvm]val APPLICATION_GRPC_MEDIA_TYPE: MediaType APPLICATION_JAVASCRIPT [jvm]const val APPLICATION_JAVASCRIPT: String APPLICATION_JAVASCRIPT_MEDIA_TYPE [jvm]val APPLICATION_JAVASCRIPT_MEDIA_TYPE: MediaType APPLICATION_JSON [jvm]const val APPLICATION_JSON: String APPLICATION_JSON_MEDIA_TYPE [jvm]val APPLICATION_JSON_MEDIA_TYPE: MediaType APPLICATION_OCTETSTREAM [jvm]const val APPLICATION_OCTETSTREAM: String APPLICATION_OCTETSTREAM_MEDIA_TYPE [jvm]val APPLICATION_OCTETSTREAM_MEDIA_TYPE: MediaType APPLICATION_PROTOBUF [jvm]const val APPLICATION_PROTOBUF: String APPLICATION_PROTOBUF_MEDIA_TYPE [jvm]val APPLICATION_PROTOBUF_MEDIA_TYPE: MediaType APPLICATION_XML [jvm]const val APPLICATION_XML: String APPLICATION_XML_MEDIA_TYPE [jvm]val APPLICATION_XML_MEDIA_TYPE: MediaType IMAGE_GIF [jvm]const val IMAGE_GIF: String IMAGE_GIF_MEDIA_TYPE [jvm]val IMAGE_GIF_MEDIA_TYPE: MediaType IMAGE_ICO [jvm]const val IMAGE_ICO: String IMAGE_ICO_MEDIA_TYPE [jvm]val IMAGE_ICO_MEDIA_TYPE: MediaType IMAGE_JPEG [jvm]const val IMAGE_JPEG: String IMAGE_JPEG_MEDIA_TYPE [jvm]val IMAGE_JPEG_MEDIA_TYPE: MediaType IMAGE_PNG [jvm]const val IMAGE_PNG: String IMAGE_PNG_MEDIA_TYPE [jvm]val IMAGE_PNG_MEDIA_TYPE: MediaType IMAGE_SVG [jvm]const val IMAGE_SVG: String IMAGE_SVG_MEDIA_TYPE [jvm]val IMAGE_SVG_MEDIA_TYPE: MediaType TEXT_CSS [jvm]const val TEXT_CSS: String TEXT_CSS_MEDIA_TYPE [jvm]val TEXT_CSS_MEDIA_TYPE: MediaType TEXT_HTML [jvm]const val TEXT_HTML: String TEXT_HTML_MEDIA_TYPE [jvm]val TEXT_HTML_MEDIA_TYPE: MediaType TEXT_PLAIN_UTF8 [jvm]const val TEXT_PLAIN_UTF8: String TEXT_PLAIN_UTF8_MEDIA_TYPE [jvm]val TEXT_PLAIN_UTF8_MEDIA_TYPE: MediaType TURBO_STREAM [jvm]const val TURBO_STREAM: String TURBO_STREAM_MEDIA_TYPE [jvm]val TURBO_STREAM_MEDIA_TYPE: MediaType"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/#functions","title":"Functions","text":"Name Summary fromFileExtension [jvm]fun fromFileExtension(ext: String): MediaType"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l/","title":"ALL - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/ALL
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l/#all","title":"ALL","text":"[jvm]\\ const val ALL: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l_-m-e-d-i-a_-t-y-p-e/","title":"ALL_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/ALL_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l_-m-e-d-i-a_-t-y-p-e/#all_media_type","title":"ALL_MEDIA_TYPE","text":"[jvm]\\ val ALL_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-f-o-r-m_-u-r-l-e-n-c-o-d-e-d/","title":"APPLICATION_FORM_URLENCODED - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_FORM_URLENCODED
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-f-o-r-m_-u-r-l-e-n-c-o-d-e-d/#application_form_urlencoded","title":"APPLICATION_FORM_URLENCODED","text":"[jvm]\\ const val APPLICATION_FORM_URLENCODED: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c/","title":"APPLICATION_GRPC - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_GRPC
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c/#application_grpc","title":"APPLICATION_GRPC","text":"[jvm]\\ const val APPLICATION_GRPC: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_GRPC_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_GRPC_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c_-m-e-d-i-a_-t-y-p-e/#application_grpc_media_type","title":"APPLICATION_GRPC_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_GRPC_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t/","title":"APPLICATION_JAVASCRIPT - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JAVASCRIPT
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t/#application_javascript","title":"APPLICATION_JAVASCRIPT","text":"[jvm]\\ const val APPLICATION_JAVASCRIPT: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_JAVASCRIPT_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JAVASCRIPT_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t_-m-e-d-i-a_-t-y-p-e/#application_javascript_media_type","title":"APPLICATION_JAVASCRIPT_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_JAVASCRIPT_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n/","title":"APPLICATION_JSON - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JSON
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n/#application_json","title":"APPLICATION_JSON","text":"[jvm]\\ const val APPLICATION_JSON: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_JSON_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JSON_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n_-m-e-d-i-a_-t-y-p-e/#application_json_media_type","title":"APPLICATION_JSON_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_JSON_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m/","title":"APPLICATION_OCTETSTREAM - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_OCTETSTREAM
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m/#application_octetstream","title":"APPLICATION_OCTETSTREAM","text":"[jvm]\\ const val APPLICATION_OCTETSTREAM: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_OCTETSTREAM_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_OCTETSTREAM_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/#application_octetstream_media_type","title":"APPLICATION_OCTETSTREAM_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_OCTETSTREAM_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f/","title":"APPLICATION_PROTOBUF - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_PROTOBUF
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f/#application_protobuf","title":"APPLICATION_PROTOBUF","text":"[jvm]\\ const val APPLICATION_PROTOBUF: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_PROTOBUF_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_PROTOBUF_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f_-m-e-d-i-a_-t-y-p-e/#application_protobuf_media_type","title":"APPLICATION_PROTOBUF_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_PROTOBUF_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l/","title":"APPLICATION_XML - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_XML
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l/#application_xml","title":"APPLICATION_XML","text":"[jvm]\\ const val APPLICATION_XML: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_XML_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_XML_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l_-m-e-d-i-a_-t-y-p-e/#application_xml_media_type","title":"APPLICATION_XML_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_XML_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f/","title":"IMAGE_GIF - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_GIF
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f/#image_gif","title":"IMAGE_GIF","text":"[jvm]\\ const val IMAGE_GIF: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_GIF_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_GIF_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f_-m-e-d-i-a_-t-y-p-e/#image_gif_media_type","title":"IMAGE_GIF_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_GIF_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o/","title":"IMAGE_ICO - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_ICO
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o/#image_ico","title":"IMAGE_ICO","text":"[jvm]\\ const val IMAGE_ICO: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_ICO_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_ICO_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o_-m-e-d-i-a_-t-y-p-e/#image_ico_media_type","title":"IMAGE_ICO_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_ICO_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g/","title":"IMAGE_JPEG - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_JPEG
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g/#image_jpeg","title":"IMAGE_JPEG","text":"[jvm]\\ const val IMAGE_JPEG: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_JPEG_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_JPEG_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g_-m-e-d-i-a_-t-y-p-e/#image_jpeg_media_type","title":"IMAGE_JPEG_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_JPEG_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g/","title":"IMAGE_PNG - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_PNG
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g/#image_png","title":"IMAGE_PNG","text":"[jvm]\\ const val IMAGE_PNG: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_PNG_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_PNG_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g_-m-e-d-i-a_-t-y-p-e/#image_png_media_type","title":"IMAGE_PNG_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_PNG_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g/","title":"IMAGE_SVG - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_SVG
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g/#image_svg","title":"IMAGE_SVG","text":"[jvm]\\ const val IMAGE_SVG: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_SVG_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_SVG_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g_-m-e-d-i-a_-t-y-p-e/#image_svg_media_type","title":"IMAGE_SVG_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_SVG_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s/","title":"TEXT_CSS - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_CSS
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s/#text_css","title":"TEXT_CSS","text":"[jvm]\\ const val TEXT_CSS: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s_-m-e-d-i-a_-t-y-p-e/","title":"TEXT_CSS_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_CSS_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s_-m-e-d-i-a_-t-y-p-e/#text_css_media_type","title":"TEXT_CSS_MEDIA_TYPE","text":"[jvm]\\ val TEXT_CSS_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l/","title":"TEXT_HTML - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_HTML
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l/#text_html","title":"TEXT_HTML","text":"[jvm]\\ const val TEXT_HTML: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l_-m-e-d-i-a_-t-y-p-e/","title":"TEXT_HTML_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_HTML_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l_-m-e-d-i-a_-t-y-p-e/#text_html_media_type","title":"TEXT_HTML_MEDIA_TYPE","text":"[jvm]\\ val TEXT_HTML_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8/","title":"TEXT_PLAIN_UTF8 - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_PLAIN_UTF8
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8/#text_plain_utf8","title":"TEXT_PLAIN_UTF8","text":"[jvm]\\ const val TEXT_PLAIN_UTF8: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8_-m-e-d-i-a_-t-y-p-e/","title":"TEXT_PLAIN_UTF8_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_PLAIN_UTF8_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8_-m-e-d-i-a_-t-y-p-e/#text_plain_utf8_media_type","title":"TEXT_PLAIN_UTF8_MEDIA_TYPE","text":"[jvm]\\ val TEXT_PLAIN_UTF8_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m/","title":"TURBO_STREAM - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TURBO_STREAM
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m/#turbo_stream","title":"TURBO_STREAM","text":"[jvm]\\ const val TURBO_STREAM: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/","title":"TURBO_STREAM_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TURBO_STREAM_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/#turbo_stream_media_type","title":"TURBO_STREAM_MEDIA_TYPE","text":"[jvm]\\ val TURBO_STREAM_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/from-file-extension/","title":"fromFileExtension - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/fromFileExtension
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/from-file-extension/#fromfileextension","title":"fromFileExtension","text":"[jvm]\\ fun fromFileExtension(ext: String): MediaType
"},{"location":"0.x/misk-cron/","title":"misk-cron - Misk","text":"//misk-cron
"},{"location":"0.x/misk-cron/#misk-cron","title":"misk-cron","text":""},{"location":"0.x/misk-cron/#packages","title":"Packages","text":"Name misk.cron"},{"location":"0.x/misk-cron/misk-cron/misk.cron/","title":"Package-level declarations - Misk","text":"//misk-cron/misk.cron
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-cron/misk-cron/misk.cron/#types","title":"Types","text":"Name Summary CronEntryModule [jvm]class CronEntryModule<A : Runnable> : KAbstractModule CronManager [jvm]@Singletonclass CronManager@Injectconstructor CronModule [jvm]class CronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KInstallOnceModule CronPattern [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])annotation class CronPattern(val pattern: String) FakeCronModule [jvm]class FakeCronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KAbstractModule"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/","title":"CronEntryModule - Misk","text":"//misk-cron/misk.cron/CronEntryModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/#cronentrymodule","title":"CronEntryModule","text":"[jvm]\\ class CronEntryModule<A : Runnable> : KAbstractModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/","title":"Companion - Misk","text":"//misk-cron/misk.cron/CronEntryModule/Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <A : Runnable> create(): CronEntryModule<A>[jvm]fun <A : Runnable> create(cronRunnableClass: KClass<A>): CronEntryModule<A>Registers a cron runnable."},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/create/","title":"create - Misk","text":"//misk-cron/misk.cron/CronEntryModule/Companion/create
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <A : Runnable> create(): CronEntryModule<A>
[jvm]\\ fun <A : Runnable> create(cronRunnableClass: KClass<A>): CronEntryModule<A>
Registers a cron runnable.
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/create/#parameters","title":"Parameters","text":"jvm
cronRunnableClass : The cron runnable to register."},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/","title":"CronManager - Misk","text":"//misk-cron/misk.cron/CronManager
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#cronmanager","title":"CronManager","text":"[jvm]\\ @Singleton
class CronManager@Injectconstructor
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#constructors","title":"Constructors","text":"CronManager [jvm]@Injectconstructor()"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion CronEntry [jvm]data class CronEntry(val name: String, val cronTab: String, val executionTime: ExecutionTime, val runnable: Runnable)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#functions","title":"Functions","text":"Name Summary runReadyCrons [jvm]fun runReadyCrons(lastRun: Instant) waitForCronsComplete [jvm]fun waitForCronsComplete()"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-manager/","title":"CronManager - Misk","text":"//misk-cron/misk.cron/CronManager/CronManager
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-manager/#cronmanager","title":"CronManager","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/run-ready-crons/","title":"runReadyCrons - Misk","text":"//misk-cron/misk.cron/CronManager/runReadyCrons
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/run-ready-crons/#runreadycrons","title":"runReadyCrons","text":"[jvm]\\ fun runReadyCrons(lastRun: Instant)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/wait-for-crons-complete/","title":"waitForCronsComplete - Misk","text":"//misk-cron/misk.cron/CronManager/waitForCronsComplete
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/wait-for-crons-complete/#waitforcronscomplete","title":"waitForCronsComplete","text":"[jvm]\\ fun waitForCronsComplete()
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-companion/","title":"Companion - Misk","text":"//misk-cron/misk.cron/CronManager/Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/","title":"CronEntry - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/#cronentry","title":"CronEntry","text":"[jvm]\\ data class CronEntry(val name: String, val cronTab: String, val executionTime: ExecutionTime, val runnable: Runnable)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/#constructors","title":"Constructors","text":"CronEntry [jvm]constructor(name: String, cronTab: String, executionTime: ExecutionTime, runnable: Runnable)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/#properties","title":"Properties","text":"Name Summary cronTab [jvm]val cronTab: String executionTime [jvm]val executionTime: ExecutionTime name [jvm]val name: String runnable [jvm]val runnable: Runnable"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/-cron-entry/","title":"CronEntry - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/CronEntry
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/-cron-entry/#cronentry","title":"CronEntry","text":"[jvm]\\ constructor(name: String, cronTab: String, executionTime: ExecutionTime, runnable: Runnable)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/cron-tab/","title":"cronTab - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/cronTab
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/cron-tab/#crontab","title":"cronTab","text":"[jvm]\\ val cronTab: String
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/execution-time/","title":"executionTime - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/executionTime
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/execution-time/#executiontime","title":"executionTime","text":"[jvm]\\ val executionTime: ExecutionTime
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/name/","title":"name - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/name
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/runnable/","title":"runnable - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/runnable
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/runnable/#runnable","title":"runnable","text":"[jvm]\\ val runnable: Runnable
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/","title":"CronModule - Misk","text":"//misk-cron/misk.cron/CronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/#cronmodule","title":"CronModule","text":"[jvm]\\ class CronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KInstallOnceModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/#constructors","title":"Constructors","text":"CronModule [jvm]@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int provideTaskQueue [jvm]@Provides@Singletonfun provideTaskQueue(queueFactory: RepeatedTaskQueueFactory): RepeatedTaskQueue"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/-cron-module/","title":"CronModule - Misk","text":"//misk-cron/misk.cron/CronModule/CronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/-cron-module/#cronmodule","title":"CronModule","text":"[jvm]\\
@JvmOverloads
constructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/provide-task-queue/","title":"provideTaskQueue - Misk","text":"//misk-cron/misk.cron/CronModule/provideTaskQueue
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/provide-task-queue/#providetaskqueue","title":"provideTaskQueue","text":"[jvm]\\
@Provides
@Singleton
fun provideTaskQueue(queueFactory: RepeatedTaskQueueFactory): RepeatedTaskQueue
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/","title":"CronPattern - Misk","text":"//misk-cron/misk.cron/CronPattern
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/#cronpattern","title":"CronPattern","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class CronPattern(val pattern: String)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/#properties","title":"Properties","text":"Name Summary pattern [jvm]val pattern: String"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/pattern/","title":"pattern - Misk","text":"//misk-cron/misk.cron/CronPattern/pattern
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/pattern/#pattern","title":"pattern","text":"[jvm]\\ val pattern: String
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/","title":"FakeCronModule - Misk","text":"//misk-cron/misk.cron/FakeCronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/#fakecronmodule","title":"FakeCronModule","text":"[jvm]\\ class FakeCronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KAbstractModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/#constructors","title":"Constructors","text":"FakeCronModule [jvm]@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/-fake-cron-module/","title":"FakeCronModule - Misk","text":"//misk-cron/misk.cron/FakeCronModule/FakeCronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/-fake-cron-module/#fakecronmodule","title":"FakeCronModule","text":"[jvm]\\
@JvmOverloads
constructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())
"},{"location":"0.x/misk-crypto/","title":"misk-crypto - Misk","text":"//misk-crypto
"},{"location":"0.x/misk-crypto/#misk-crypto","title":"misk-crypto","text":""},{"location":"0.x/misk-crypto/#packages","title":"Packages","text":"Name misk.crypto misk.crypto.internal misk.crypto.pgp misk.crypto.pgp.internal"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/#types","title":"Types","text":"Name Summary AeadKeyManager [jvm]@Singletonclass AeadKeyManager : MappedKeyManager<Aead> Holds a map of every Aead key name to its primitive listed in the configuration for this app. AwsKmsClientModule [jvm]class AwsKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModuleAWS specific KMS client module. Currently uses a file path to a JSON credentials file to initialize the client. If no file is provided, tries to initialize the client using the default credentials path as specified in AwsKmsClient.withDefaultCredentials BucketNameSource [jvm]interface BucketNameSourceBind this to an instance to control how external buckets are referenced. CiphertextFormat [jvm]class CiphertextFormatWraps a ciphertext and the encryption context associated with it in a ByteArray. CryptoConfig [jvm]data class CryptoConfig@JvmOverloadsconstructor(val keys: List<Key>?, val kms_uri: String, val external_data_keys: Map<KeyAlias, KeyType>? = null) : ConfigMain configuration object representing to be used in the app. CryptoModule [jvm]class CryptoModule(config: CryptoConfig) : KAbstractModuleConfigures and registers the keys listed in the configuration file. Each key is read, decrypted, and then bound via Google Guice and added to a MappedKeyManager. DeterministicAeadKeyManager [jvm]@Singletonclass DeterministicAeadKeyManager : MappedKeyManager<DeterministicAead> Holds a map of every DeterministicAead key name to its primitive listed in the configuration for this app. DigitalSignature [jvm]data class DigitalSignature(val signer: PublicKeySign, val verifier: PublicKeyVerify) DigitalSignatureKeyManager [jvm]@Singletonclass DigitalSignatureKeyManager : MappedKeyManager<DigitalSignature> Holds a map of every key name to its corresponding PublicKeySign and PublicKeyVerify primitives. ExternalDataKeys [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class ExternalDataKeysThis annotation is used to decorate the collection of external data keys used in the service. ExternalKeyManagerException [jvm]class ExternalKeyManagerException(message: String) : IOExceptionThrown on creation if external key does not exist. ExternalKeyResolver [jvm]class ExternalKeyResolver@Injectconstructor(val allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>) : KeyResolverExternalKeyResolver implements an KeyResolver that fetches Tink keysets from an external source, such as an S3 bucket. If multiple sources are registered (by binding implementations of KeyResolver), the first one to contain the key (via ExternalKeySource.keyExists) is the key that is used. ExternalKeySource [jvm]interface ExternalKeySourceImplement an ExternalKeySource to provide Tink keysets from an external location, such as an S3 bucket or an NFS share. GcpKmsClientModule [jvm]class GcpKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModuleGCP specific KMS client module. Uses a file path to a JSON credentials file to initialize the client. HybridDecryptKeyManager [jvm]@Singletonclass HybridDecryptKeyManager : MappedKeyManager<HybridDecrypt> Holds a map of every HybridDecrypt key name to its corresponding primitive listed in the configuration for this app. HybridEncryptKeyManager [jvm]@Singletonclass HybridEncryptKeyManager : MappedKeyManager<HybridEncrypt> Holds a map of every HybridEncrypt key name to its corresponding primitive listed in the configuration for this app. Key [jvm]data class Key@JvmOverloadsconstructor(val key_name: String, val key_type: KeyType, val encrypted_key: Secret<String>? = null, val kms_uri: String? = null) : ConfigDescribes a specific key KeyAlias [jvm]typealias KeyAlias = StringA KeyAlias is how we refer to a Tink keyset. KeyNotFoundException [jvm]class KeyNotFoundException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : GeneralSecurityException KeyReader [jvm]open class KeyReader KeyResolver [jvm]interface KeyResolverKeyResolver provides an interface to access keys indexed by aliases. Optionally, callers can register a callback to be invoked when a key is updated. KeyType [jvm]enum KeyType : Enum<KeyType> Supported key types LocalConfigKeyResolver [jvm]class LocalConfigKeyResolver(keys: List<Key>, defaultKmsUri: String) : KeyResolverLocalConfigKeyResolver provides keys that are stored locally and protected by a single KMS key. MacKeyManager [jvm]@Singletonclass MacKeyManager : MappedKeyManager<Mac> Holds a map of every Mac key name to its primitive listed in the configuration for this app. MappedKeyManager [jvm]sealed class MappedKeyManager<KeyT> MiskAWSKMS [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class MiskAWSKMSThis annotation is used to specify which com.amazonaws.services.kms.AWSKMS instance should be used by misk to construct a KmsClient and communicate with the KMS service MiskKmsClient [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class MiskKmsClientThis annotation is used to specify the KmsClient that\u2019s being used by misk to load encryption keys PgpDecrypterManager [jvm]@Singletonclass PgpDecrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpDecrypter> Holds a map of every PgpDecrypter key name to its primitive listed in the configuration for this app. PgpEncrypterManager [jvm]@Singletonclass PgpEncrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpEncrypter> Holds a map of every PgpEncrypter key name to its primitive listed in the configuration for this app. S3KeySource [jvm]class S3KeySource@Injectconstructor(deployment: Deployment, defaultS3: AmazonS3, val allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider) : ExternalKeySourceS3KeySource implements an ExternalKeySource that fetches Tink keysets from an S3 bucket. Keysets are indexed by an alias and a region, and are encrypted with a key in the KMS using an envelope key encryption scheme. Each Keyset is protected by a KMS key in each service region. ServiceKeys [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class ServiceKeysThis annotation is used to decorate the collection of service keys used in the service. StreamingAeadKeyManager [jvm]@Singletonclass StreamingAeadKeyManager@Injectconstructor(injector: Injector) : MappedKeyManager<StreamingAead> Holds a map of every StreamingAead key name to its primitive listed in the configuration for this app."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/#functions","title":"Functions","text":"Name Summary computeMac [jvm]fun Mac.computeMac(data: String): StringExtension function for conveniently computing an HMAC and encoding it with Base64. verifyMac [jvm]fun Mac.verifyMac(tag: String, data: String)Extension function for conveniently verifying a message\u2019s authenticity. This function expects the tag string variable to contain a Base64 encoded array of bytes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/compute-mac/","title":"computeMac - Misk","text":"//misk-crypto/misk.crypto/computeMac
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/compute-mac/#computemac","title":"computeMac","text":"[jvm]\\ fun Mac.computeMac(data: String): String
Extension function for conveniently computing an HMAC and encoding it with Base64.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/verify-mac/","title":"verifyMac - Misk","text":"//misk-crypto/misk.crypto/verifyMac
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/verify-mac/#verifymac","title":"verifyMac","text":"[jvm]\\ fun Mac.verifyMac(tag: String, data: String)
Extension function for conveniently verifying a message\u2019s authenticity. This function expects the tag string variable to contain a Base64 encoded array of bytes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aead-key-manager/","title":"AeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/AeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aead-key-manager/#aeadkeymanager","title":"AeadKeyManager","text":"[jvm]\\ @Singleton
class AeadKeyManager : MappedKeyManager<Aead>
Holds a map of every Aead key name to its primitive listed in the configuration for this app.
Users may use this object to obtain an Aead dynamically:
val myKey: Aead = aeadKeyManager[\"myKey\"]\nNote: Aead instances provided by this module are envelope Aead instances. This means that all data is encrypted with an ephemeral data encryption key (DEK), which is then protected by a key-encryption key (KEK) and stored inline with ciphertext. This effectively means that ciphertext will be a bit larger than the plaintext, and that migrating keys (KEKs) should not require the re-encryption of stored data.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aead-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): Aead"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/","title":"AwsKmsClientModule - Misk","text":"//misk-crypto/misk.crypto/AwsKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/#awskmsclientmodule","title":"AwsKmsClientModule","text":"[jvm]\\ class AwsKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModule
AWS specific KMS client module. Currently uses a file path to a JSON credentials file to initialize the client. If no file is provided, tries to initialize the client using the default credentials path as specified in AwsKmsClient.withDefaultCredentials
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/#constructors","title":"Constructors","text":"AwsKmsClientModule [jvm]@JvmOverloadsconstructor(credentialsPath: String? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) getKmsClient [jvm]@Provides@Singletonfun getKmsClient(): KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/-aws-kms-client-module/","title":"AwsKmsClientModule - Misk","text":"//misk-crypto/misk.crypto/AwsKmsClientModule/AwsKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/-aws-kms-client-module/#awskmsclientmodule","title":"AwsKmsClientModule","text":"[jvm]\\
@JvmOverloads
constructor(credentialsPath: String? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/get-kms-client/","title":"getKmsClient - Misk","text":"//misk-crypto/misk.crypto/AwsKmsClientModule/getKmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/get-kms-client/#getkmsclient","title":"getKmsClient","text":"[jvm]\\
@Provides
@Singleton
fun getKmsClient(): KmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/","title":"BucketNameSource - Misk","text":"//misk-crypto/misk.crypto/BucketNameSource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/#bucketnamesource","title":"BucketNameSource","text":"[jvm]\\ interface BucketNameSource
Bind this to an instance to control how external buckets are referenced.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/#functions","title":"Functions","text":"Name Summary getBucketName [jvm]abstract fun getBucketName(deployment: Deployment): StringName of the bucket that stores keys getBucketRegion [jvm]open fun getBucketRegion(deployment: Deployment): String?The region that the bucket lives in."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-name/","title":"getBucketName - Misk","text":"//misk-crypto/misk.crypto/BucketNameSource/getBucketName
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-name/#getbucketname","title":"getBucketName","text":"[jvm]\\ abstract fun getBucketName(deployment: Deployment): String
Name of the bucket that stores keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-region/","title":"getBucketRegion - Misk","text":"//misk-crypto/misk.crypto/BucketNameSource/getBucketRegion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-region/#getbucketregion","title":"getBucketRegion","text":"[jvm]\\ open fun getBucketRegion(deployment: Deployment): String?
The region that the bucket lives in.
Returns null for same region as the service.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/","title":"CiphertextFormat - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/#ciphertextformat","title":"CiphertextFormat","text":"[jvm]\\ class CiphertextFormat
Wraps a ciphertext and the encryption context associated with it in a ByteArray.
Misk uses Tink to encrypt data, which uses Encryption Context (EC), or Additional Authentication Data (AAD) to authenticate ciphertext. This class introduces a new, higher level abstraction, that\u2019ll be used instead of the AAD byte array interfaces Tink exposes to users. The main reasons to do this are:
Map<String, String>[ AAD:\n[ varint: pair count ]\n [ pairs:\n ( [ varint: key length ] [ ByteArray: key ]\n [ varint: value length ] [ ByteArray: value ]\n )*\n ]\n]\nThe final output will be serialized using the following format:
[ 0xEE: magic+version ]\n[ varint: AAD length ]\n[ AAD ]\n[ tink ciphertext ]\nFor the full documentation of the CiphertextFormat serialization, read FORMAT.md
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion EncryptionContextMismatchException [jvm]class EncryptionContextMismatchException(message: String) : GeneralSecurityException InvalidCiphertextFormatException [jvm]class InvalidCiphertextFormatException(message: String) : GeneralSecurityException InvalidEncryptionContextException [jvm]class InvalidEncryptionContextException(message: String) : GeneralSecurityException MissingEncryptionContextException [jvm]class MissingEncryptionContextException : GeneralSecurityException UnexpectedEncryptionContextException [jvm]class UnexpectedEncryptionContextException : GeneralSecurityException"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/#properties","title":"Properties","text":"Name Summary CURRENT_VERSION [jvm]const val CURRENT_VERSION: Int = 238Current version of the encryption packet schema"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/#functions","title":"Functions","text":"Name Summary deserializeFleFormat [jvm]fun deserializeFleFormat(serialized: ByteArray): Pair<ByteArray, Map<String, String?>>Extracts the ciphertext and encryption context from the serialized ByteArray."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/-c-u-r-r-e-n-t_-v-e-r-s-i-o-n/","title":"CURRENT_VERSION - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/Companion/CURRENT_VERSION
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/-c-u-r-r-e-n-t_-v-e-r-s-i-o-n/#current_version","title":"CURRENT_VERSION","text":"[jvm]\\ const val CURRENT_VERSION: Int = 238
Current version of the encryption packet schema
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/deserialize-fle-format/","title":"deserializeFleFormat - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/Companion/deserializeFleFormat
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/deserialize-fle-format/#deserializefleformat","title":"deserializeFleFormat","text":"[jvm]\\ fun deserializeFleFormat(serialized: ByteArray): Pair<ByteArray, Map<String, String?>>
Extracts the ciphertext and encryption context from the serialized ByteArray.
This method is meant to be used with field-level-encryption in Hibernate only.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/","title":"EncryptionContextMismatchException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/EncryptionContextMismatchException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#encryptioncontextmismatchexception","title":"EncryptionContextMismatchException","text":"[jvm]\\ class EncryptionContextMismatchException(message: String) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#constructors","title":"Constructors","text":"EncryptionContextMismatchException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/-encryption-context-mismatch-exception/","title":"EncryptionContextMismatchException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/EncryptionContextMismatchException/EncryptionContextMismatchException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/-encryption-context-mismatch-exception/#encryptioncontextmismatchexception","title":"EncryptionContextMismatchException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/","title":"InvalidCiphertextFormatException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidCiphertextFormatException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#invalidciphertextformatexception","title":"InvalidCiphertextFormatException","text":"[jvm]\\ class InvalidCiphertextFormatException(message: String) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#constructors","title":"Constructors","text":"InvalidCiphertextFormatException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/-invalid-ciphertext-format-exception/","title":"InvalidCiphertextFormatException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidCiphertextFormatException/InvalidCiphertextFormatException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/-invalid-ciphertext-format-exception/#invalidciphertextformatexception","title":"InvalidCiphertextFormatException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/","title":"InvalidEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#invalidencryptioncontextexception","title":"InvalidEncryptionContextException","text":"[jvm]\\ class InvalidEncryptionContextException(message: String) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#constructors","title":"Constructors","text":"InvalidEncryptionContextException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/-invalid-encryption-context-exception/","title":"InvalidEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidEncryptionContextException/InvalidEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/-invalid-encryption-context-exception/#invalidencryptioncontextexception","title":"InvalidEncryptionContextException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/","title":"MissingEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/MissingEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#missingencryptioncontextexception","title":"MissingEncryptionContextException","text":"[jvm]\\ class MissingEncryptionContextException : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#constructors","title":"Constructors","text":"MissingEncryptionContextException [jvm]constructor()"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/-missing-encryption-context-exception/","title":"MissingEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/MissingEncryptionContextException/MissingEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/-missing-encryption-context-exception/#missingencryptioncontextexception","title":"MissingEncryptionContextException","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/","title":"UnexpectedEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/UnexpectedEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#unexpectedencryptioncontextexception","title":"UnexpectedEncryptionContextException","text":"[jvm]\\ class UnexpectedEncryptionContextException : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#constructors","title":"Constructors","text":"UnexpectedEncryptionContextException [jvm]constructor()"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/-unexpected-encryption-context-exception/","title":"UnexpectedEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/UnexpectedEncryptionContextException/UnexpectedEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/-unexpected-encryption-context-exception/#unexpectedencryptioncontextexception","title":"UnexpectedEncryptionContextException","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/","title":"CryptoConfig - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/#cryptoconfig","title":"CryptoConfig","text":"[jvm]\\ data class CryptoConfig@JvmOverloadsconstructor(val keys: List<Key>?, val kms_uri: String, val external_data_keys: Map<KeyAlias, KeyType>? = null) : Config
Main configuration object representing to be used in the app.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/#constructors","title":"Constructors","text":"CryptoConfig [jvm]@JvmOverloadsconstructor(keys: List<Key>?, kms_uri: String, external_data_keys: Map<KeyAlias, KeyType>? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/#properties","title":"Properties","text":"Name Summary external_data_keys [jvm]val external_data_keys: Map<KeyAlias, KeyType>? = nullThe key references (map of alias to type) of keys we want to use that are loaded from an external key source, such as an S3 bucket. keys [jvm]val keys: List<Key>? kms_uri [jvm]val kms_uri: StringThe KMS\u2019 key URI. For GCP users that may look like:gcp-kms://projects/<project>/locations/<location>/keyRings/<keyRing>/cryptoKeys/<key> For AWS users the Key URI looks like: aws-kms://arn:aws:kms:<region>:<account-id>:key/<key-id>"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/-crypto-config/","title":"CryptoConfig - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/CryptoConfig
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/-crypto-config/#cryptoconfig","title":"CryptoConfig","text":"[jvm]\\
@JvmOverloads
constructor(keys: List<Key>?, kms_uri: String, external_data_keys: Map<KeyAlias, KeyType>? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/external_data_keys/","title":"external_data_keys - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/external_data_keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/external_data_keys/#external_data_keys","title":"external_data_keys","text":"[jvm]\\ val external_data_keys: Map<KeyAlias, KeyType>? = null
The key references (map of alias to type) of keys we want to use that are loaded from an external key source, such as an S3 bucket.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/keys/","title":"keys - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/keys/#keys","title":"keys","text":"[jvm]\\ val keys: List<Key>?
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/kms_uri/","title":"kms_uri - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/kms_uri
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/kms_uri/#kms_uri","title":"kms_uri","text":"[jvm]\\ val kms_uri: String
The KMS\u2019 key URI. For GCP users that may look like: gcp-kms://projects/<project>/locations/<location>/keyRings/<keyRing>/cryptoKeys/<key> For AWS users the Key URI looks like: aws-kms://arn:aws:kms:<region>:<account-id>:key/<key-id>
//misk-crypto/misk.crypto/CryptoModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/#cryptomodule","title":"CryptoModule","text":"[jvm]\\ class CryptoModule(config: CryptoConfig) : KAbstractModule
Configures and registers the keys listed in the configuration file. Each key is read, decrypted, and then bound via Google Guice and added to a MappedKeyManager.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/#constructors","title":"Constructors","text":"CryptoModule [jvm]constructor(config: CryptoConfig)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/-crypto-module/","title":"CryptoModule - Misk","text":"//misk-crypto/misk.crypto/CryptoModule/CryptoModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/-crypto-module/#cryptomodule","title":"CryptoModule","text":"[jvm]\\ constructor(config: CryptoConfig)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-deterministic-aead-key-manager/","title":"DeterministicAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/DeterministicAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-deterministic-aead-key-manager/#deterministicaeadkeymanager","title":"DeterministicAeadKeyManager","text":"[jvm]\\ @Singleton
class DeterministicAeadKeyManager : MappedKeyManager<DeterministicAead>
Holds a map of every DeterministicAead key name to its primitive listed in the configuration for this app.
Users may use this object to obtain an DeterministicAead dynamically:
val myKey: DeterministicAead = deterministicAeadKeyManager[\"myKey\"]\nNote that DeterministicAead objects do not provide secrecy to the same level as AEAD do, since multiple plaintexts encrypted with the same key will produce identical ciphertext. This behavior is desirable when querying data via its ciphertext (i.e. equality will hold), but an attacker can detect repeated plaintexts.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-deterministic-aead-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): DeterministicAead"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/","title":"DigitalSignature - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/#digitalsignature","title":"DigitalSignature","text":"[jvm]\\ data class DigitalSignature(val signer: PublicKeySign, val verifier: PublicKeyVerify)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/#constructors","title":"Constructors","text":"DigitalSignature [jvm]constructor(signer: PublicKeySign, verifier: PublicKeyVerify)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/#properties","title":"Properties","text":"Name Summary signer [jvm]val signer: PublicKeySign verifier [jvm]val verifier: PublicKeyVerify"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/-digital-signature/","title":"DigitalSignature - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature/DigitalSignature
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/-digital-signature/#digitalsignature","title":"DigitalSignature","text":"[jvm]\\ constructor(signer: PublicKeySign, verifier: PublicKeyVerify)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/signer/","title":"signer - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature/signer
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/signer/#signer","title":"signer","text":"[jvm]\\ val signer: PublicKeySign
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/verifier/","title":"verifier - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature/verifier
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/verifier/#verifier","title":"verifier","text":"[jvm]\\ val verifier: PublicKeyVerify
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/","title":"DigitalSignatureKeyManager - Misk","text":"//misk-crypto/misk.crypto/DigitalSignatureKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/#digitalsignaturekeymanager","title":"DigitalSignatureKeyManager","text":"[jvm]\\ @Singleton
class DigitalSignatureKeyManager : MappedKeyManager<DigitalSignature>
Holds a map of every key name to its corresponding PublicKeySign and PublicKeyVerify primitives.
Users may use this class to obtain a PublicKeySign to sign data or PublicKeyVerify to verify the integrity of a message dynamically:
val signer: PublicKeySign = keyManager.getSigner(\"myDigitalSignatureKey\")\nval verifier: PublicKeyVerify = keyManager.getVerifier(\"mySigitalSignatureKey\")\nval signature = signer.sign(data)\nverifier.verify(signature, data)\n//misk-crypto/misk.crypto/DigitalSignatureKeyManager/getSigner
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/get-signer/#getsigner","title":"getSigner","text":"[jvm]\\ fun getSigner(name: String): PublicKeySign
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/get-verifier/","title":"getVerifier - Misk","text":"//misk-crypto/misk.crypto/DigitalSignatureKeyManager/getVerifier
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/get-verifier/#getverifier","title":"getVerifier","text":"[jvm]\\ fun getVerifier(name: String): PublicKeyVerify
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-data-keys/","title":"ExternalDataKeys - Misk","text":"//misk-crypto/misk.crypto/ExternalDataKeys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-data-keys/#externaldatakeys","title":"ExternalDataKeys","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class ExternalDataKeys
This annotation is used to decorate the collection of external data keys used in the service.
External data keys are defined in the configuration as a Map<KeyAlias, KeyType>.
This annotation can be useful for cases where one would need access to all external data keys available to the service.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/","title":"ExternalKeyManagerException - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyManagerException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#externalkeymanagerexception","title":"ExternalKeyManagerException","text":"[jvm]\\ class ExternalKeyManagerException(message: String) : IOException
Thrown on creation if external key does not exist.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#constructors","title":"Constructors","text":"ExternalKeyManagerException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/-external-key-manager-exception/","title":"ExternalKeyManagerException - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyManagerException/ExternalKeyManagerException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/-external-key-manager-exception/#externalkeymanagerexception","title":"ExternalKeyManagerException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/","title":"ExternalKeyResolver - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#externalkeyresolver","title":"ExternalKeyResolver","text":"[jvm]\\ class ExternalKeyResolver@Injectconstructor(val allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>) : KeyResolver
ExternalKeyResolver implements an KeyResolver that fetches Tink keysets from an external source, such as an S3 bucket. If multiple sources are registered (by binding implementations of KeyResolver), the first one to contain the key (via ExternalKeySource.keyExists) is the key that is used.
If a key is not found, an ExternalKeyManagerException exception is raised.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#constructors","title":"Constructors","text":"ExternalKeyResolver [jvm]@Injectconstructor(allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]open override val allKeyAliases: Map<KeyAlias, KeyType>All resolved key aliases and their respective KeyTypes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#functions","title":"Functions","text":"Name Summary getKeyByAlias [jvm]open override fun getKeyByAlias(alias: KeyAlias): Key?Fetch and return a Key (includes contents, type and a KMS ARN) by its alias."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-external-key-resolver/","title":"ExternalKeyResolver - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/ExternalKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-external-key-resolver/#externalkeyresolver","title":"ExternalKeyResolver","text":"[jvm]\\
@Inject
constructor(allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ open override val allKeyAliases: Map<KeyAlias, KeyType>
All resolved key aliases and their respective KeyTypes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/get-key-by-alias/","title":"getKeyByAlias - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/getKeyByAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/get-key-by-alias/#getkeybyalias","title":"getKeyByAlias","text":"[jvm]\\ open override fun getKeyByAlias(alias: KeyAlias): Key?
Fetch and return a Key (includes contents, type and a KMS ARN) by its alias.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/","title":"ExternalKeySource - Misk","text":"//misk-crypto/misk.crypto/ExternalKeySource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/#externalkeysource","title":"ExternalKeySource","text":"interface ExternalKeySource
Implement an ExternalKeySource to provide Tink keysets from an external location, such as an S3 bucket or an NFS share.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/#inheritors","title":"Inheritors","text":"S3KeySource"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/#functions","title":"Functions","text":"Name Summary getKey [jvm]abstract fun getKey(alias: KeyAlias): Key?Return a Key from an external key source. keyExists [jvm]abstract fun keyExists(alias: KeyAlias): BooleanCheck if a key alias exists in the key source."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/get-key/","title":"getKey - Misk","text":"//misk-crypto/misk.crypto/ExternalKeySource/getKey
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/get-key/#getkey","title":"getKey","text":"[jvm]\\ abstract fun getKey(alias: KeyAlias): Key?
Return a Key from an external key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/key-exists/","title":"keyExists - Misk","text":"//misk-crypto/misk.crypto/ExternalKeySource/keyExists
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/key-exists/#keyexists","title":"keyExists","text":"[jvm]\\ abstract fun keyExists(alias: KeyAlias): Boolean
Check if a key alias exists in the key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/","title":"GcpKmsClientModule - Misk","text":"//misk-crypto/misk.crypto/GcpKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/#gcpkmsclientmodule","title":"GcpKmsClientModule","text":"[jvm]\\ class GcpKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModule
GCP specific KMS client module. Uses a file path to a JSON credentials file to initialize the client.
//misk-crypto/misk.crypto/GcpKmsClientModule/GcpKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/-gcp-kms-client-module/#gcpkmsclientmodule","title":"GcpKmsClientModule","text":"[jvm]\\
@JvmOverloads
constructor(credentialsPath: String? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/get-kms-client/","title":"getKmsClient - Misk","text":"//misk-crypto/misk.crypto/GcpKmsClientModule/getKmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/get-kms-client/#getkmsclient","title":"getKmsClient","text":"[jvm]\\
@Provides
@Singleton
fun getKmsClient(): KmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-decrypt-key-manager/","title":"HybridDecryptKeyManager - Misk","text":"//misk-crypto/misk.crypto/HybridDecryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-decrypt-key-manager/#hybriddecryptkeymanager","title":"HybridDecryptKeyManager","text":"[jvm]\\ @Singleton
class HybridDecryptKeyManager : MappedKeyManager<HybridDecrypt>
Holds a map of every HybridDecrypt key name to its corresponding primitive listed in the configuration for this app.
Users may this class to obtain a HybridDecrypt object dynamically:
val hybridDecrypt: HybridDecrypt = hybridKeyManager[\"myHybridKey\"]\n//misk-crypto/misk.crypto/HybridEncryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-encrypt-key-manager/#hybridencryptkeymanager","title":"HybridEncryptKeyManager","text":"[jvm]\\ @Singleton
class HybridEncryptKeyManager : MappedKeyManager<HybridEncrypt>
Holds a map of every HybridEncrypt key name to its corresponding primitive listed in the configuration for this app.
Users may use this class to obtain a HybridEncrypt object dynamically:
val hybridEncrypt: HybridEncrypt = hybridKeyManager[\"myHybridKey\"]\nNote: Hybrid encryption is intentionally divided to 2 separate key managers, HybridEncryptKeyManager and HybridDecryptKeyManager, so that the public portion of the keyset could be exported to other services. This configuration helps achieve the goal of allowing some services to encrypt only and other services to both encrypt and decrypt.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-encrypt-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): HybridEncrypt"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/","title":"Key - Misk","text":"//misk-crypto/misk.crypto/Key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/#key","title":"Key","text":"[jvm]\\ data class Key@JvmOverloadsconstructor(val key_name: String, val key_type: KeyType, val encrypted_key: Secret<String>? = null, val kms_uri: String? = null) : Config
Describes a specific key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/#constructors","title":"Constructors","text":"Key [jvm]@JvmOverloadsconstructor(key_name: String, key_type: KeyType, encrypted_key: Secret<String>? = null, kms_uri: String? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/#properties","title":"Properties","text":"Name Summary encrypted_key [jvm]val encrypted_key: Secret<String>? = nullIn config it\u2019s the path to a file containing the encrypted key material in Tink\u2019s JSON format. However MiskConfig will read the contents of the file, so this variable is the file\u2019s contents. key_name [jvm]val key_name: StringDescriptive short string for the key. This name will be used when injecting the corresponding key object in the app, like: key_type [jvm]val key_type: KeyTypeType of Tink primitive to initialize. kms_uri [jvm]val kms_uri: String? = nullA key-specific, and region-specific KMS uri that was used to encrypt this key."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/-key/","title":"Key - Misk","text":"//misk-crypto/misk.crypto/Key/Key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/-key/#key","title":"Key","text":"[jvm]\\
@JvmOverloads
constructor(key_name: String, key_type: KeyType, encrypted_key: Secret<String>? = null, kms_uri: String? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/encrypted_key/","title":"encrypted_key - Misk","text":"//misk-crypto/misk.crypto/Key/encrypted_key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/encrypted_key/#encrypted_key","title":"encrypted_key","text":"[jvm]\\ val encrypted_key: Secret<String>? = null
In config it\u2019s the path to a file containing the encrypted key material in Tink\u2019s JSON format. However MiskConfig will read the contents of the file, so this variable is the file\u2019s contents.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/key_name/","title":"key_name - Misk","text":"//misk-crypto/misk.crypto/Key/key_name
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/key_name/#key_name","title":"key_name","text":"[jvm]\\ val key_name: String
Descriptive short string for the key. This name will be used when injecting the corresponding key object in the app, like:
@Inject @Named(\"keyName\") lateinit var myKey: Aead\n//misk-crypto/misk.crypto/Key/key_type
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/key_type/#key_type","title":"key_type","text":"[jvm]\\ val key_type: KeyType
Type of Tink primitive to initialize.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/kms_uri/","title":"kms_uri - Misk","text":"//misk-crypto/misk.crypto/Key/kms_uri
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/kms_uri/#kms_uri","title":"kms_uri","text":"[jvm]\\ val kms_uri: String? = null
A key-specific, and region-specific KMS uri that was used to encrypt this key.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-alias/","title":"KeyAlias - Misk","text":"//misk-crypto/misk.crypto/KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-alias/#keyalias","title":"KeyAlias","text":"[jvm]\\ typealias KeyAlias = String
A KeyAlias is how we refer to a Tink keyset.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/","title":"KeyNotFoundException - Misk","text":"//misk-crypto/misk.crypto/KeyNotFoundException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#keynotfoundexception","title":"KeyNotFoundException","text":"[jvm]\\ class KeyNotFoundException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#constructors","title":"Constructors","text":"KeyNotFoundException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/-key-not-found-exception/","title":"KeyNotFoundException - Misk","text":"//misk-crypto/misk.crypto/KeyNotFoundException/KeyNotFoundException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/-key-not-found-exception/#keynotfoundexception","title":"KeyNotFoundException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/","title":"KeyReader - Misk","text":"//misk-crypto/misk.crypto/KeyReader
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#keyreader","title":"KeyReader","text":"open class KeyReader
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#inheritors","title":"Inheritors","text":"AeadEnvelopeProvider DeterministicAeadProvider MacProvider DigitalSignatureSignerProvider DigitalSignatureVerifierProvider HybridEncryptProvider HybridDecryptProvider StreamingAeadProvider PgpDecrypterProvider PgpEncrypterProvider"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#constructors","title":"Constructors","text":"KeyReader [jvm]constructor()"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#properties","title":"Properties","text":"Name Summary keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#functions","title":"Functions","text":"Name Summary readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-key-reader/","title":"KeyReader - Misk","text":"//misk-crypto/misk.crypto/KeyReader/KeyReader
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-key-reader/#keyreader","title":"KeyReader","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/key-sources/","title":"keySources - Misk","text":"//misk-crypto/misk.crypto/KeyReader/keySources
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/key-sources/#keysources","title":"keySources","text":"[jvm]\\
@Inject
lateinit var keySources: Set<KeyResolver>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/kms-client/","title":"kmsClient - Misk","text":"//misk-crypto/misk.crypto/KeyReader/kmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/kms-client/#kmsclient","title":"kmsClient","text":"[jvm]\\
@Inject
lateinit var kmsClient: KmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/read-key/","title":"readKey - Misk","text":"//misk-crypto/misk.crypto/KeyReader/readKey
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/read-key/#readkey","title":"readKey","text":"[jvm]\\ fun readKey(alias: KeyAlias): KeysetHandle
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/KeyReader/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/#properties","title":"Properties","text":"Name Summary KEK_TEMPLATE [jvm]val KEK_TEMPLATE: KeyTemplate"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/-k-e-k_-t-e-m-p-l-a-t-e/","title":"KEK_TEMPLATE - Misk","text":"//misk-crypto/misk.crypto/KeyReader/Companion/KEK_TEMPLATE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/-k-e-k_-t-e-m-p-l-a-t-e/#kek_template","title":"KEK_TEMPLATE","text":"[jvm]\\ val KEK_TEMPLATE: KeyTemplate
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/","title":"KeyResolver - Misk","text":"//misk-crypto/misk.crypto/KeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#keyresolver","title":"KeyResolver","text":"interface KeyResolver
KeyResolver provides an interface to access keys indexed by aliases. Optionally, callers can register a callback to be invoked when a key is updated.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#inheritors","title":"Inheritors","text":"ExternalKeyResolver LocalConfigKeyResolver"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]abstract val allKeyAliases: Map<KeyAlias, KeyType>All resolved key aliases and their respective KeyTypes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#functions","title":"Functions","text":"Name Summary getKeyByAlias [jvm]abstract fun getKeyByAlias(alias: KeyAlias): Key?Fetch and return a Key (includes contents, type and a KMS ARN) by its alias."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/KeyResolver/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ abstract val allKeyAliases: Map<KeyAlias, KeyType>
All resolved key aliases and their respective KeyTypes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/get-key-by-alias/","title":"getKeyByAlias - Misk","text":"//misk-crypto/misk.crypto/KeyResolver/getKeyByAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/get-key-by-alias/#getkeybyalias","title":"getKeyByAlias","text":"[jvm]\\ abstract fun getKeyByAlias(alias: KeyAlias): Key?
Fetch and return a Key (includes contents, type and a KMS ARN) by its alias.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/","title":"KeyType - Misk","text":"//misk-crypto/misk.crypto/KeyType
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#keytype","title":"KeyType","text":"[jvm]\\ enum KeyType : Enum<KeyType>
Supported key types
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#entries","title":"Entries","text":"AEAD [jvm]AEAD DAEAD [jvm]DAEAD MAC [jvm]MAC DIGITAL_SIGNATURE [jvm]DIGITAL_SIGNATURE HYBRID_ENCRYPT [jvm]HYBRID_ENCRYPT HYBRID_ENCRYPT_DECRYPT [jvm]HYBRID_ENCRYPT_DECRYPT STREAMING_AEAD [jvm]STREAMING_AEAD PGP_DECRYPT [jvm]PGP_DECRYPT PGP_ENCRYPT [jvm]PGP_ENCRYPT SIGNATURE [jvm]SIGNATUREAlias for DIGITAL_SIGNATURE."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<KeyType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): KeyTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<KeyType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/entries/","title":"entries - Misk","text":"//misk-crypto/misk.crypto/KeyType/entries
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<KeyType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/value-of/","title":"valueOf - Misk","text":"//misk-crypto/misk.crypto/KeyType/valueOf
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): KeyType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/values/","title":"values - Misk","text":"//misk-crypto/misk.crypto/KeyType/values
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<KeyType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-a-e-a-d/","title":"AEAD - Misk","text":"//misk-crypto/misk.crypto/KeyType/AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-a-e-a-d/#aead","title":"AEAD","text":"[jvm]\\ AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-a-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-a-e-a-d/","title":"DAEAD - Misk","text":"//misk-crypto/misk.crypto/KeyType/DAEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-a-e-a-d/#daead","title":"DAEAD","text":"[jvm]\\ DAEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-a-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-i-g-i-t-a-l_-s-i-g-n-a-t-u-r-e/","title":"DIGITAL_SIGNATURE - Misk","text":"//misk-crypto/misk.crypto/KeyType/DIGITAL_SIGNATURE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-i-g-i-t-a-l_-s-i-g-n-a-t-u-r-e/#digital_signature","title":"DIGITAL_SIGNATURE","text":"[jvm]\\ DIGITAL_SIGNATURE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-i-g-i-t-a-l_-s-i-g-n-a-t-u-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t/","title":"HYBRID_ENCRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/HYBRID_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t/#hybrid_encrypt","title":"HYBRID_ENCRYPT","text":"[jvm]\\ HYBRID_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t_-d-e-c-r-y-p-t/","title":"HYBRID_ENCRYPT_DECRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/HYBRID_ENCRYPT_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t_-d-e-c-r-y-p-t/#hybrid_encrypt_decrypt","title":"HYBRID_ENCRYPT_DECRYPT","text":"[jvm]\\ HYBRID_ENCRYPT_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t_-d-e-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-m-a-c/","title":"MAC - Misk","text":"//misk-crypto/misk.crypto/KeyType/MAC
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-m-a-c/#mac","title":"MAC","text":"[jvm]\\ MAC
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-m-a-c/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-d-e-c-r-y-p-t/","title":"PGP_DECRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/PGP_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-d-e-c-r-y-p-t/#pgp_decrypt","title":"PGP_DECRYPT","text":"[jvm]\\ PGP_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-d-e-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-e-n-c-r-y-p-t/","title":"PGP_ENCRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/PGP_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-e-n-c-r-y-p-t/#pgp_encrypt","title":"PGP_ENCRYPT","text":"[jvm]\\ PGP_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-e-n-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-i-g-n-a-t-u-r-e/","title":"SIGNATURE - Misk","text":"//misk-crypto/misk.crypto/KeyType/SIGNATURE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-i-g-n-a-t-u-r-e/#signature","title":"SIGNATURE","text":"[jvm]\\ SIGNATURE
Alias for DIGITAL_SIGNATURE.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-i-g-n-a-t-u-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-t-r-e-a-m-i-n-g_-a-e-a-d/","title":"STREAMING_AEAD - Misk","text":"//misk-crypto/misk.crypto/KeyType/STREAMING_AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-t-r-e-a-m-i-n-g_-a-e-a-d/#streaming_aead","title":"STREAMING_AEAD","text":"[jvm]\\ STREAMING_AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-t-r-e-a-m-i-n-g_-a-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/","title":"LocalConfigKeyResolver - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#localconfigkeyresolver","title":"LocalConfigKeyResolver","text":"[jvm]\\ class LocalConfigKeyResolver(keys: List<Key>, defaultKmsUri: String) : KeyResolver
LocalConfigKeyResolver provides keys that are stored locally and protected by a single KMS key.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#constructors","title":"Constructors","text":"LocalConfigKeyResolver [jvm]constructor(keys: List<Key>, defaultKmsUri: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]open override val allKeyAliases: Map<KeyAlias, KeyType>All resolved key aliases and their respective KeyTypes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#functions","title":"Functions","text":"Name Summary getKeyByAlias [jvm]open override fun getKeyByAlias(alias: KeyAlias): Key?Fetch and return a Key (includes contents, type and a KMS ARN) by its alias."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/-local-config-key-resolver/","title":"LocalConfigKeyResolver - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver/LocalConfigKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/-local-config-key-resolver/#localconfigkeyresolver","title":"LocalConfigKeyResolver","text":"[jvm]\\ constructor(keys: List<Key>, defaultKmsUri: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ open override val allKeyAliases: Map<KeyAlias, KeyType>
All resolved key aliases and their respective KeyTypes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/get-key-by-alias/","title":"getKeyByAlias - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver/getKeyByAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/get-key-by-alias/#getkeybyalias","title":"getKeyByAlias","text":"[jvm]\\ open override fun getKeyByAlias(alias: KeyAlias): Key?
Fetch and return a Key (includes contents, type and a KMS ARN) by its alias.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mac-key-manager/","title":"MacKeyManager - Misk","text":"//misk-crypto/misk.crypto/MacKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mac-key-manager/#mackeymanager","title":"MacKeyManager","text":"[jvm]\\ @Singleton
class MacKeyManager : MappedKeyManager<Mac>
Holds a map of every Mac key name to its primitive listed in the configuration for this app.
Users may use this class to obtain a Mac object dynamically:
val hmac: Mac = macKeyManager[\"myHmac\"]\n//misk-crypto/misk.crypto/MappedKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/#mappedkeymanager","title":"MappedKeyManager","text":"sealed class MappedKeyManager<KeyT>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/#inheritors","title":"Inheritors","text":"AeadKeyManager DeterministicAeadKeyManager MacKeyManager DigitalSignatureKeyManager HybridEncryptKeyManager HybridDecryptKeyManager StreamingAeadKeyManager PgpEncrypterManager PgpDecrypterManager"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): KeyT"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto/MappedKeyManager/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/get/#get","title":"get","text":"[jvm]\\ operator fun get(name: String): KeyT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-a-w-s-k-m-s/","title":"MiskAWSKMS - Misk","text":"//misk-crypto/misk.crypto/MiskAWSKMS
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-a-w-s-k-m-s/#miskawskms","title":"MiskAWSKMS","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class MiskAWSKMS
This annotation is used to specify which com.amazonaws.services.kms.AWSKMS instance should be used by misk to construct a KmsClient and communicate with the KMS service
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-kms-client/","title":"MiskKmsClient - Misk","text":"//misk-crypto/misk.crypto/MiskKmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-kms-client/#miskkmsclient","title":"MiskKmsClient","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class MiskKmsClient
This annotation is used to specify the KmsClient that\u2019s being used by misk to load encryption keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-decrypter-manager/","title":"PgpDecrypterManager - Misk","text":"//misk-crypto/misk.crypto/PgpDecrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-decrypter-manager/#pgpdecryptermanager","title":"PgpDecrypterManager","text":"[jvm]\\ @Singleton
class PgpDecrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpDecrypter>
Holds a map of every PgpDecrypter key name to its primitive listed in the configuration for this app.
val myKey: PgpDecrypter = pgpDecrypterManager[\"myKey\"]\n//misk-crypto/misk.crypto/PgpDecrypterManager/PgpDecrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-decrypter-manager/-pgp-decrypter-manager/#pgpdecryptermanager","title":"PgpDecrypterManager","text":"[jvm]\\
@Inject
constructor(injector: Injector)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-encrypter-manager/","title":"PgpEncrypterManager - Misk","text":"//misk-crypto/misk.crypto/PgpEncrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-encrypter-manager/#pgpencryptermanager","title":"PgpEncrypterManager","text":"[jvm]\\ @Singleton
class PgpEncrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpEncrypter>
Holds a map of every PgpEncrypter key name to its primitive listed in the configuration for this app.
val myKey: PgpEncrypter = pgpEncrypterManager[\"myKey\"]\n//misk-crypto/misk.crypto/PgpEncrypterManager/PgpEncrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-encrypter-manager/-pgp-encrypter-manager/#pgpencryptermanager","title":"PgpEncrypterManager","text":"[jvm]\\
@Inject
constructor(injector: Injector)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/","title":"S3KeySource - Misk","text":"//misk-crypto/misk.crypto/S3KeySource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#s3keysource","title":"S3KeySource","text":"[jvm]\\ class S3KeySource@Injectconstructor(deployment: Deployment, defaultS3: AmazonS3, val allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider) : ExternalKeySource
S3KeySource implements an ExternalKeySource that fetches Tink keysets from an S3 bucket. Keysets are indexed by an alias and a region, and are encrypted with a key in the KMS using an envelope key encryption scheme. Each Keyset is protected by a KMS key in each service region.
For example, if we are to load a key aliased by \"example_key\" in the staging environment, we\u2019d expect the following layout:
bucket \u21b3 example_key \u21b3 us-east-1 \u21b3 us-west-2
And the metadata of the region-specified object will contain the KMS key arn that was used to protect it under the key x-amz-meta-kms-key-arn, and the type of the key under x-amz-meta-key-type. These keys are exposed in the S3 api without the x-amz-meta- prefix.
The envelope scheme itself is from misk-crypto and is defined in KeyReader
If a requested key alias does not exist, this will raise a ExternalKeyManagerException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#constructors","title":"Constructors","text":"S3KeySource [jvm]@Injectconstructor(deployment: Deployment, defaultS3: AmazonS3, allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]val allKeyAliases: Map<KeyAlias, KeyType>"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#functions","title":"Functions","text":"Name Summary getKey [jvm]open override fun getKey(alias: KeyAlias): KeyReturn a Key from an external key source. keyExists [jvm]open override fun keyExists(alias: KeyAlias): BooleanCheck if a key alias exists in the key source."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-s3-key-source/","title":"S3KeySource - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/S3KeySource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-s3-key-source/#s3keysource","title":"S3KeySource","text":"[jvm]\\
@Inject
constructor(deployment: Deployment, defaultS3: AmazonS3, allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ val allKeyAliases: Map<KeyAlias, KeyType>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/get-key/","title":"getKey - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/getKey
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/get-key/#getkey","title":"getKey","text":"[jvm]\\ open override fun getKey(alias: KeyAlias): Key
Return a Key from an external key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/key-exists/","title":"keyExists - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/keyExists
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/key-exists/#keyexists","title":"keyExists","text":"[jvm]\\ open override fun keyExists(alias: KeyAlias): Boolean
Check if a key alias exists in the key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-service-keys/","title":"ServiceKeys - Misk","text":"//misk-crypto/misk.crypto/ServiceKeys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-service-keys/#servicekeys","title":"ServiceKeys","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class ServiceKeys
This annotation is used to decorate the collection of service keys used in the service.
This annotation can be useful for cases where one would need access to all service keys as a Map<KeyAlias, KeyType>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/","title":"StreamingAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/StreamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/#streamingaeadkeymanager","title":"StreamingAeadKeyManager","text":"[jvm]\\ @Singleton
class StreamingAeadKeyManager@Injectconstructor(injector: Injector) : MappedKeyManager<StreamingAead>
Holds a map of every StreamingAead key name to its primitive listed in the configuration for this app.
Users may use this object to obtain an StreamingAead dynamically:
val myKey: StreamingAead = streamingAeadKeyManager[\"myKey\"]\nNote: StreamingAead is useful when the data to be encrypted is too large to be processed in a single step. Typical use cases include encryption of large files or encryption of live data streams
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/#constructors","title":"Constructors","text":"StreamingAeadKeyManager [jvm]@Injectconstructor(injector: Injector)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): StreamingAead"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/-streaming-aead-key-manager/","title":"StreamingAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/StreamingAeadKeyManager/StreamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/-streaming-aead-key-manager/#streamingaeadkeymanager","title":"StreamingAeadKeyManager","text":"[jvm]\\
@Inject
constructor(injector: Injector)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto.internal
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/#types","title":"Types","text":"Name Summary AeadEnvelopeProvider [jvm]class AeadEnvelopeProvider(val key: KeyAlias) : KeyReader, Provider<Aead> We only support AEAD keys via envelope encryption. DeterministicAeadProvider [jvm]class DeterministicAeadProvider(val key: KeyAlias) : KeyReader, Provider<DeterministicAead> DigitalSignatureSignerProvider [jvm]class DigitalSignatureSignerProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeySign> DigitalSignatureVerifierProvider [jvm]class DigitalSignatureVerifierProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeyVerify> HybridDecryptProvider [jvm]class HybridDecryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridDecrypt> HybridEncryptProvider [jvm]class HybridEncryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridEncrypt> MacProvider [jvm]class MacProvider(val key: KeyAlias) : KeyReader, Provider<Mac> StreamingAeadProvider [jvm]class StreamingAeadProvider(val key: KeyAlias) : KeyReader, Provider<StreamingAead>"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/","title":"AeadEnvelopeProvider - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#aeadenvelopeprovider","title":"AeadEnvelopeProvider","text":"[jvm]\\ class AeadEnvelopeProvider(val key: KeyAlias) : KeyReader, Provider<Aead>
We only support AEAD keys via envelope encryption.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#constructors","title":"Constructors","text":"AeadEnvelopeProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: AeadKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Aead readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/-aead-envelope-provider/","title":"AeadEnvelopeProvider - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/AeadEnvelopeProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/-aead-envelope-provider/#aeadenvelopeprovider","title":"AeadEnvelopeProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Aead
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: AeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/","title":"DeterministicAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#deterministicaeadprovider","title":"DeterministicAeadProvider","text":"[jvm]\\ class DeterministicAeadProvider(val key: KeyAlias) : KeyReader, Provider<DeterministicAead>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#constructors","title":"Constructors","text":"DeterministicAeadProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: DeterministicAeadKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DeterministicAead readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/-deterministic-aead-provider/","title":"DeterministicAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/DeterministicAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/-deterministic-aead-provider/#deterministicaeadprovider","title":"DeterministicAeadProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DeterministicAead
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: DeterministicAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/","title":"DigitalSignatureSignerProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#digitalsignaturesignerprovider","title":"DigitalSignatureSignerProvider","text":"[jvm]\\ class DigitalSignatureSignerProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeySign>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#constructors","title":"Constructors","text":"DigitalSignatureSignerProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: DigitalSignatureKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PublicKeySign readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/-digital-signature-signer-provider/","title":"DigitalSignatureSignerProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/DigitalSignatureSignerProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/-digital-signature-signer-provider/#digitalsignaturesignerprovider","title":"DigitalSignatureSignerProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PublicKeySign
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: DigitalSignatureKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/","title":"DigitalSignatureVerifierProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#digitalsignatureverifierprovider","title":"DigitalSignatureVerifierProvider","text":"[jvm]\\ class DigitalSignatureVerifierProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeyVerify>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#constructors","title":"Constructors","text":"DigitalSignatureVerifierProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: DigitalSignatureKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PublicKeyVerify readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/-digital-signature-verifier-provider/","title":"DigitalSignatureVerifierProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/DigitalSignatureVerifierProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/-digital-signature-verifier-provider/#digitalsignatureverifierprovider","title":"DigitalSignatureVerifierProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PublicKeyVerify
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: DigitalSignatureKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/","title":"HybridDecryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#hybriddecryptprovider","title":"HybridDecryptProvider","text":"[jvm]\\ class HybridDecryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridDecrypt>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#constructors","title":"Constructors","text":"HybridDecryptProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyDecryptManager [jvm]@Injectlateinit var keyDecryptManager: HybridDecryptKeyManager keyEncryptManager [jvm]@Injectlateinit var keyEncryptManager: HybridEncryptKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): HybridDecrypt readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/-hybrid-decrypt-provider/","title":"HybridDecryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/HybridDecryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/-hybrid-decrypt-provider/#hybriddecryptprovider","title":"HybridDecryptProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): HybridDecrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-decrypt-manager/","title":"keyDecryptManager - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/keyDecryptManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-decrypt-manager/#keydecryptmanager","title":"keyDecryptManager","text":"[jvm]\\
@Inject
lateinit var keyDecryptManager: HybridDecryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-encrypt-manager/","title":"keyEncryptManager - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/keyEncryptManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-encrypt-manager/#keyencryptmanager","title":"keyEncryptManager","text":"[jvm]\\
@Inject
lateinit var keyEncryptManager: HybridEncryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/","title":"HybridEncryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#hybridencryptprovider","title":"HybridEncryptProvider","text":"[jvm]\\ class HybridEncryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridEncrypt>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#constructors","title":"Constructors","text":"HybridEncryptProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: HybridEncryptKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): HybridEncrypt readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/-hybrid-encrypt-provider/","title":"HybridEncryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/HybridEncryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/-hybrid-encrypt-provider/#hybridencryptprovider","title":"HybridEncryptProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): HybridEncrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: HybridEncryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/","title":"MacProvider - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#macprovider","title":"MacProvider","text":"[jvm]\\ class MacProvider(val key: KeyAlias) : KeyReader, Provider<Mac>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#constructors","title":"Constructors","text":"MacProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: MacKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Mac readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/-mac-provider/","title":"MacProvider - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/MacProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/-mac-provider/#macprovider","title":"MacProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Mac
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: MacKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/","title":"StreamingAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#streamingaeadprovider","title":"StreamingAeadProvider","text":"[jvm]\\ class StreamingAeadProvider(val key: KeyAlias) : KeyReader, Provider<StreamingAead>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#constructors","title":"Constructors","text":"StreamingAeadProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient streamingAeadKeyManager [jvm]@Injectlateinit var streamingAeadKeyManager: StreamingAeadKeyManager"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): StreamingAead readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/-streaming-aead-provider/","title":"StreamingAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/StreamingAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/-streaming-aead-provider/#streamingaeadprovider","title":"StreamingAeadProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): StreamingAead
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/streaming-aead-key-manager/","title":"streamingAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/streamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/streaming-aead-key-manager/#streamingaeadkeymanager","title":"streamingAeadKeyManager","text":"[jvm]\\
@Inject
lateinit var streamingAeadKeyManager: StreamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto.pgp
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/#types","title":"Types","text":"Name Summary PgpDecrypter [jvm]interface PgpDecrypterA PgpDecrypter is tied to a private PGP key which it uses to decrypt messages. PgpEncrypter [jvm]interface PgpEncrypterA PgpEncrypter is tied to a public PGP key which it uses to encrypt messages."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/","title":"PgpDecrypter - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpDecrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/#pgpdecrypter","title":"PgpDecrypter","text":"[jvm]\\ interface PgpDecrypter
A PgpDecrypter is tied to a private PGP key which it uses to decrypt messages.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/#functions","title":"Functions","text":"Name Summary decrypt [jvm]abstract fun decrypt(ciphertext: ByteArray): ByteArray"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/decrypt/","title":"decrypt - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpDecrypter/decrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/decrypt/#decrypt","title":"decrypt","text":"[jvm]\\ abstract fun decrypt(ciphertext: ByteArray): ByteArray
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/","title":"PgpEncrypter - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpEncrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/#pgpencrypter","title":"PgpEncrypter","text":"[jvm]\\ interface PgpEncrypter
A PgpEncrypter is tied to a public PGP key which it uses to encrypt messages.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/#functions","title":"Functions","text":"Name Summary encrypt [jvm]abstract fun encrypt(plaintext: ByteArray, armored: Boolean): ByteArrayEncrypts the given byte array. Armored refers to whether to output in a text format or not."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/encrypt/","title":"encrypt - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpEncrypter/encrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/encrypt/#encrypt","title":"encrypt","text":"[jvm]\\ abstract fun encrypt(plaintext: ByteArray, armored: Boolean): ByteArray
Encrypts the given byte array. Armored refers to whether to output in a text format or not.
For example, with armored we get output like:
-----BEGIN PGP MESSAGE----- Version: BCPG C# v1.6.1.0
hQIMA0tM4ZUzpKCkAQ//ZO8hVhp6LMxshCLqcqgPkXcU1kBHPQjiUBs6QPxaQFcg PIXJEdZWQ1RkMUKdCfzjvevizi/2NWAwZ797fELdbpVyH6JI2Me1Ov10f8qgYvbG V0GJ3loRt84KjKdVocKguJVfMvOeMVJanPpxfPt3Ak+Nt/voZHmJdTkV4cjWTmcU x31xqc5LZcvgF4Lv+ZcMw090b281yMENwALnvQJ9FQg5WTfZ+YautUMwWGk8W8XM H3tYkdh3jKizy8YTw+zfVDn1yhw2BgSFp0QIgHIQQ2Q2gyknRfj4zdfs/4bZYcu1 KNgj9op/IejZNstP9JWw4labC78nTIW5s1f0LWF5hhZUkxeAOEyVluUVJgEw44B4 LKb0p/8jb4J/dVrsmaTDOONZ48wtNjZOTV61DhCnn+UiNVSfQe6I7XMtFpEH0PN4 WzermmeEgjw1MADeh0jg/9wMM/p9UnTxihGQrPRgHYUu45jI3ys3qArsD2GvAi9y QYqsuRJNB7EEu2clBRASA3zoWkpqbs3H9S2fB9Sf9ZzZTPCzowOdK1oe0vlMVt3A mCILe05s2nowwBrBWu4PHUTkllsnLliHhrihu9sqXCHy6u1pdNQMvJgY6kbgQmsG bVY+brdkLdQ1BxbTT1YixzLm//zqMqGC1ZJUsr5PAIbNtyKK6u6+mCkZj0Y3fU3J Il0x5V09QcC9AHyxJ8VMOxzhQZjwVYNtD6SGeY8jOyfUScY= =DHKq -----END PGP MESSAGE-----
Without the armored encoding we would get binary data which isn\u2019t viewable in text format.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto.pgp.internal
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/#types","title":"Types","text":"Name Summary PgpDecrypterProvider [jvm]class PgpDecrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpDecrypter> PgpEncrypterProvider [jvm]class PgpEncrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpEncrypter> PgpKeyJsonFile [jvm]data class PgpKeyJsonFile(val region: String, val encrypted_private_key: String, val public_key: String, val pgp: PgpKeyJsonFileMetadata, val aws_kms_key_id: String) PgpKeyJsonFileMetadata [jvm]data class PgpKeyJsonFileMetadata(val name: String, val email: String, val comment: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/","title":"PgpDecrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpDecrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#pgpdecrypterprovider","title":"PgpDecrypterProvider","text":"[jvm]\\ class PgpDecrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpDecrypter>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#constructors","title":"Constructors","text":"PgpDecrypterProvider [jvm]constructor(alias: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#properties","title":"Properties","text":"Name Summary keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PgpDecrypter readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/-pgp-decrypter-provider/","title":"PgpDecrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpDecrypterProvider/PgpDecrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/-pgp-decrypter-provider/#pgpdecrypterprovider","title":"PgpDecrypterProvider","text":"[jvm]\\ constructor(alias: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpDecrypterProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PgpDecrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/","title":"PgpEncrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpEncrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#pgpencrypterprovider","title":"PgpEncrypterProvider","text":"[jvm]\\ class PgpEncrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpEncrypter>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#constructors","title":"Constructors","text":"PgpEncrypterProvider [jvm]constructor(alias: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#properties","title":"Properties","text":"Name Summary keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PgpEncrypter readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/-pgp-encrypter-provider/","title":"PgpEncrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpEncrypterProvider/PgpEncrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/-pgp-encrypter-provider/#pgpencrypterprovider","title":"PgpEncrypterProvider","text":"[jvm]\\ constructor(alias: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpEncrypterProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PgpEncrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/","title":"PgpKeyJsonFile - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/#pgpkeyjsonfile","title":"PgpKeyJsonFile","text":"[jvm]\\ data class PgpKeyJsonFile(val region: String, val encrypted_private_key: String, val public_key: String, val pgp: PgpKeyJsonFileMetadata, val aws_kms_key_id: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/#constructors","title":"Constructors","text":"PgpKeyJsonFile [jvm]constructor(region: String, encrypted_private_key: String, public_key: String, pgp: PgpKeyJsonFileMetadata, aws_kms_key_id: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/#properties","title":"Properties","text":"Name Summary aws_kms_key_id [jvm]val aws_kms_key_id: String encrypted_private_key [jvm]val encrypted_private_key: String pgp [jvm]val pgp: PgpKeyJsonFileMetadata public_key [jvm]val public_key: String region [jvm]val region: String"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/-pgp-key-json-file/","title":"PgpKeyJsonFile - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/PgpKeyJsonFile
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/-pgp-key-json-file/#pgpkeyjsonfile","title":"PgpKeyJsonFile","text":"[jvm]\\ constructor(region: String, encrypted_private_key: String, public_key: String, pgp: PgpKeyJsonFileMetadata, aws_kms_key_id: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/aws_kms_key_id/","title":"aws_kms_key_id - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/aws_kms_key_id
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/aws_kms_key_id/#aws_kms_key_id","title":"aws_kms_key_id","text":"[jvm]\\ val aws_kms_key_id: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/encrypted_private_key/","title":"encrypted_private_key - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/encrypted_private_key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/encrypted_private_key/#encrypted_private_key","title":"encrypted_private_key","text":"[jvm]\\ val encrypted_private_key: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/pgp/","title":"pgp - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/pgp
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/pgp/#pgp","title":"pgp","text":"[jvm]\\ val pgp: PgpKeyJsonFileMetadata
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/public_key/","title":"public_key - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/public_key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/public_key/#public_key","title":"public_key","text":"[jvm]\\ val public_key: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/region/","title":"region - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/region
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/region/#region","title":"region","text":"[jvm]\\ val region: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/","title":"PgpKeyJsonFileMetadata - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/#pgpkeyjsonfilemetadata","title":"PgpKeyJsonFileMetadata","text":"[jvm]\\ data class PgpKeyJsonFileMetadata(val name: String, val email: String, val comment: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/#constructors","title":"Constructors","text":"PgpKeyJsonFileMetadata [jvm]constructor(name: String, email: String, comment: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/#properties","title":"Properties","text":"Name Summary comment [jvm]val comment: String email [jvm]val email: String name [jvm]val name: String"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/-pgp-key-json-file-metadata/","title":"PgpKeyJsonFileMetadata - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/PgpKeyJsonFileMetadata
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/-pgp-key-json-file-metadata/#pgpkeyjsonfilemetadata","title":"PgpKeyJsonFileMetadata","text":"[jvm]\\ constructor(name: String, email: String, comment: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/comment/","title":"comment - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/comment
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/comment/#comment","title":"comment","text":"[jvm]\\ val comment: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/email/","title":"email - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/email
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/email/#email","title":"email","text":"[jvm]\\ val email: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/name/","title":"name - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/name
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-datadog/","title":"misk-datadog - Misk","text":"//misk-datadog
"},{"location":"0.x/misk-datadog/#misk-datadog","title":"misk-datadog","text":""},{"location":"0.x/misk-datadog/#packages","title":"Packages","text":"Name com.squareup.cash.tracing.datadog misk.tracing.backends.datadog"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/","title":"Package-level declarations - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/#types","title":"Types","text":"Name Summary MDCScopeListener [jvm]class MDCScopeListenerA scope listener that updates the MDC with the trace and span reference anytime a new scope is activated or closed."},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/","title":"MDCScopeListener - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#mdcscopelistener","title":"MDCScopeListener","text":"[jvm]\\ class MDCScopeListener
A scope listener that updates the MDC with the trace and span reference anytime a new scope is activated or closed.
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#constructors","title":"Constructors","text":"MDCScopeListener [jvm]constructor()"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#functions","title":"Functions","text":"Name Summary afterScopeActivated [jvm]fun afterScopeActivated() afterScopeClosed [jvm]fun afterScopeClosed()"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-m-d-c-scope-listener/","title":"MDCScopeListener - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/MDCScopeListener
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-m-d-c-scope-listener/#mdcscopelistener","title":"MDCScopeListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-activated/","title":"afterScopeActivated - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/afterScopeActivated
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-activated/#afterscopeactivated","title":"afterScopeActivated","text":"[jvm]\\ fun afterScopeActivated()
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-closed/","title":"afterScopeClosed - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/afterScopeClosed
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-closed/#afterscopeclosed","title":"afterScopeClosed","text":"[jvm]\\ fun afterScopeClosed()
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/","title":"Companion - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger MDC_DD_SPAN_ID [jvm]const val MDC_DD_SPAN_ID: String MDC_DD_TRACE_ID [jvm]const val MDC_DD_TRACE_ID: String MDC_SPAN_ID [jvm]const val MDC_SPAN_ID: String MDC_TRACE_ID [jvm]const val MDC_TRACE_ID: String"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-s-p-a-n_-i-d/","title":"MDC_DD_SPAN_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_DD_SPAN_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-s-p-a-n_-i-d/#mdc_dd_span_id","title":"MDC_DD_SPAN_ID","text":"[jvm]\\ const val MDC_DD_SPAN_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-t-r-a-c-e_-i-d/","title":"MDC_DD_TRACE_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_DD_TRACE_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-t-r-a-c-e_-i-d/#mdc_dd_trace_id","title":"MDC_DD_TRACE_ID","text":"[jvm]\\ const val MDC_DD_TRACE_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-s-p-a-n_-i-d/","title":"MDC_SPAN_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_SPAN_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-s-p-a-n_-i-d/#mdc_span_id","title":"MDC_SPAN_ID","text":"[jvm]\\ const val MDC_SPAN_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-t-r-a-c-e_-i-d/","title":"MDC_TRACE_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_TRACE_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-t-r-a-c-e_-i-d/#mdc_trace_id","title":"MDC_TRACE_ID","text":"[jvm]\\ const val MDC_TRACE_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/log/","title":"log - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/log
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/","title":"Package-level declarations - Misk","text":"//misk-datadog/misk.tracing.backends.datadog
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/#types","title":"Types","text":"Name Summary DatadogTracingBackendModule [jvm]class DatadogTracingBackendModule : KAbstractModuleBinds the datadog tracer to opentracing\u2019s Tracer"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/","title":"DatadogTracingBackendModule - Misk","text":"//misk-datadog/misk.tracing.backends.datadog/DatadogTracingBackendModule
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/#datadogtracingbackendmodule","title":"DatadogTracingBackendModule","text":"[jvm]\\ class DatadogTracingBackendModule : KAbstractModule
Binds the datadog tracer to opentracing\u2019s Tracer
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/#constructors","title":"Constructors","text":"DatadogTracingBackendModule [jvm]constructor()"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/-datadog-tracing-backend-module/","title":"DatadogTracingBackendModule - Misk","text":"//misk-datadog/misk.tracing.backends.datadog/DatadogTracingBackendModule/DatadogTracingBackendModule
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/-datadog-tracing-backend-module/#datadogtracingbackendmodule","title":"DatadogTracingBackendModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/","title":"misk-exceptions-dynamodb - Misk","text":"//misk-exceptions-dynamodb
"},{"location":"0.x/misk-exceptions-dynamodb/#misk-exceptions-dynamodb","title":"misk-exceptions-dynamodb","text":""},{"location":"0.x/misk-exceptions-dynamodb/#packages","title":"Packages","text":"Name misk.exceptions.dynamodb"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/","title":"Package-level declarations - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/#types","title":"Types","text":"Name Summary ClientExecutionTimeoutExceptionMapper [jvm]class ClientExecutionTimeoutExceptionMapper@Injectconstructor : ExceptionMapper<ClientExecutionTimeoutException> Maps ClientExecutionTimeoutException to 503 responses because the exception is concurrency related DynamoDbExceptionMapperModule [jvm]class DynamoDbExceptionMapperModule : KAbstractModule TransactionCanceledExceptionMapper [jvm]class TransactionCanceledExceptionMapper@Injectconstructor : ExceptionMapper<TransactionCanceledException> Maps certain TransactionCanceledExceptionMapper to 503 responses when the exception is concurrency related"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/","title":"ClientExecutionTimeoutExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/ClientExecutionTimeoutExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/#clientexecutiontimeoutexceptionmapper","title":"ClientExecutionTimeoutExceptionMapper","text":"[jvm]\\ class ClientExecutionTimeoutExceptionMapper@Injectconstructor : ExceptionMapper<ClientExecutionTimeoutException>
Maps ClientExecutionTimeoutException to 503 responses because the exception is concurrency related
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/#constructors","title":"Constructors","text":"ClientExecutionTimeoutExceptionMapper [jvm]@Injectconstructor()"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open fun loggingLevel(th: ClientExecutionTimeoutException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: ClientExecutionTimeoutException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: ClientExecutionTimeoutException): Response<ResponseBody>"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/-client-execution-timeout-exception-mapper/","title":"ClientExecutionTimeoutExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/ClientExecutionTimeoutExceptionMapper/ClientExecutionTimeoutExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/-client-execution-timeout-exception-mapper/#clientexecutiontimeoutexceptionmapper","title":"ClientExecutionTimeoutExceptionMapper","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/ClientExecutionTimeoutExceptionMapper/toResponse
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ open override fun toResponse(th: ClientExecutionTimeoutException): Response<ResponseBody>
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/","title":"DynamoDbExceptionMapperModule - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/DynamoDbExceptionMapperModule
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/#dynamodbexceptionmappermodule","title":"DynamoDbExceptionMapperModule","text":"[jvm]\\ class DynamoDbExceptionMapperModule : KAbstractModule
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/#constructors","title":"Constructors","text":"DynamoDbExceptionMapperModule [jvm]constructor()"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/-dynamo-db-exception-mapper-module/","title":"DynamoDbExceptionMapperModule - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/DynamoDbExceptionMapperModule/DynamoDbExceptionMapperModule
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/-dynamo-db-exception-mapper-module/#dynamodbexceptionmappermodule","title":"DynamoDbExceptionMapperModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/","title":"TransactionCanceledExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/#transactioncanceledexceptionmapper","title":"TransactionCanceledExceptionMapper","text":"[jvm]\\ class TransactionCanceledExceptionMapper@Injectconstructor : ExceptionMapper<TransactionCanceledException>
Maps certain TransactionCanceledExceptionMapper to 503 responses when the exception is concurrency related
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/#constructors","title":"Constructors","text":"TransactionCanceledExceptionMapper [jvm]@Injectconstructor()"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open override fun loggingLevel(th: TransactionCanceledException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: TransactionCanceledException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: TransactionCanceledException): Response<ResponseBody>"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/-transaction-canceled-exception-mapper/","title":"TransactionCanceledExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper/TransactionCanceledExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/-transaction-canceled-exception-mapper/#transactioncanceledexceptionmapper","title":"TransactionCanceledExceptionMapper","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper/loggingLevel
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"[jvm]\\ open override fun loggingLevel(th: TransactionCanceledException): Level
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper/toResponse
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ open override fun toResponse(th: TransactionCanceledException): Response<ResponseBody>
"},{"location":"0.x/misk-feature/","title":"misk-feature - Misk","text":"//misk-feature
"},{"location":"0.x/misk-feature/#misk-feature","title":"misk-feature","text":""},{"location":"0.x/misk-feature/#packages","title":"Packages","text":"Name misk.feature"},{"location":"0.x/misk-feature/misk-feature/misk.feature/","title":"Package-level declarations - Misk","text":"//misk-feature/misk.feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-feature/misk-feature/misk.feature/#types","title":"Types","text":"Name Summary Attributes [jvm]class Attributes@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false) : Attributes DynamicConfig [jvm]interface DynamicConfigInterface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys. Feature [jvm]class Feature(name: String) : Feature FeatureFlags [jvm]interface FeatureFlagsInterface for evaluating feature flags. FeatureService [jvm]interface FeatureService : ServiceMarker interface to integrate with the misk service graph. TrackerReference [jvm]interface TrackerReference : TrackerReference"},{"location":"0.x/misk-feature/misk-feature/misk.feature/#functions","title":"Functions","text":"Name Summary getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): Tinline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): Tinline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T toMisk [jvm]fun TrackerReference.toMisk(): TrackerReference trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-enum/","title":"getEnum - Misk","text":"//misk-feature/misk.feature/getEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T
inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-json/","title":"getJson - Misk","text":"//misk-feature/misk.feature/getJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-json/#getjson","title":"getJson","text":"[jvm]\\ inline fun <T> DynamicConfig.getJson(feature: Feature): T
inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/to-misk/","title":"toMisk - Misk","text":"//misk-feature/misk.feature/toMisk
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/to-misk/#tomisk","title":"toMisk","text":"[jvm]\\ fun TrackerReference.toMisk(): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-enum/","title":"trackEnum - Misk","text":"//misk-feature/misk.feature/trackEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-json/","title":"trackJson - Misk","text":"//misk-feature/misk.feature/trackJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/","title":"Attributes - Misk","text":"//misk-feature/misk.feature/Attributes
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#attributes","title":"Attributes","text":"[jvm]\\ class Attributes@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false) : Attributes
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#constructors","title":"Constructors","text":"Attributes [jvm]@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#properties","title":"Properties","text":"Name Summary anonymous [jvm]val anonymous: Boolean number [jvm]val number: Map<String, Number>? text [jvm]val text: Map<String, String>"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#functions","title":"Functions","text":"Name Summary copy [jvm]fun copy(text: Map<String, String>, number: Map<String, Number>?, anonymous: Boolean): Attributes equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String with [jvm]fun with(name: String, value: Number): Attributesfun with(name: String, value: String): Attributes"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/-attributes/","title":"Attributes - Misk","text":"//misk-feature/misk.feature/Attributes/Attributes
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/-attributes/#attributes","title":"Attributes","text":"[jvm]\\
@JvmOverloads
constructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/","title":"DynamicConfig - Misk","text":"//misk-feature/misk.feature/DynamicConfig
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/#dynamicconfig","title":"DynamicConfig","text":"[jvm]\\ interface DynamicConfig
Interface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]abstract fun getBoolean(feature: Feature): BooleanReturns the value of a boolean dynamic flag. getDouble [jvm]abstract fun getDouble(feature: Feature): DoubleReturns the value of a double dynamic flag. getEnum [jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): TReturns the value of an enumerated dynamic flag. getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T getInt [jvm]abstract fun getInt(feature: Feature): IntReturns the value of an integer dynamic flag. getJson [jvm]abstract fun <T> getJson(feature: Feature, clazz: Class<T>): TReturns the value of a JSON dynamic flag. getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): T getString [jvm]abstract fun getString(feature: Feature): StringReturns the value of a string dynamic flag. trackBoolean [jvm]abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value. trackDouble [jvm]abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a double dynamic config tracker which will be invoked whenever the double dynamic config changes value. trackEnum [jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value. trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value. trackJson [jvm]abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a json dynamic config tracker which will be invoked whenever the json dynamic config changes value. trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a string dynamic config tracker which will be invoked whenever the string dynamic config changes value."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature): Boolean
Returns the value of a boolean dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-double/","title":"getDouble - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature): Double
Returns the value of a double dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
Returns the value of an enumerated dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-int/","title":"getInt - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature): Int
Returns the value of an integer dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-json/","title":"getJson - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, clazz: Class<T>): T
Returns the value of a JSON dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-string/","title":"getString - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature): String
Returns the value of a string dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a double dynamic config tracker which will be invoked whenever the double dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-int/","title":"trackInt - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-json/","title":"trackJson - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a json dynamic config tracker which will be invoked whenever the json dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-string/","title":"trackString - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a string dynamic config tracker which will be invoked whenever the string dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/","title":"Feature - Misk","text":"//misk-feature/misk.feature/Feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#feature","title":"Feature","text":"[jvm]\\ class Feature(name: String) : Feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#constructors","title":"Constructors","text":"Feature [jvm]constructor(name: String)"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#functions","title":"Functions","text":"Name Summary equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/-feature/","title":"Feature - Misk","text":"//misk-feature/misk.feature/Feature/Feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/-feature/#feature","title":"Feature","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/","title":"FeatureFlags - Misk","text":"//misk-feature/misk.feature/FeatureFlags
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/#featureflags","title":"FeatureFlags","text":"[jvm]\\ interface FeatureFlags
Interface for evaluating feature flags.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(flag: BooleanFeatureFlag): BooleanCalculates the value of a boolean feature flag[jvm]abstract fun get(flag: DoubleFeatureFlag): DoubleCalculates the value of a double feature flag[jvm]abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): TCalculates the value of an enum feature flag[jvm]abstract fun get(flag: IntFeatureFlag): IntCalculates the value of an int feature flag[jvm]abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): TCalculates the value of a json feature flag[jvm]abstract fun get(flag: StringFeatureFlag): StringCalculates the value of a string feature flag getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Boolean[jvm]abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): BooleanCalculates the value of an boolean feature flag for the given key and attributes. getDouble [jvm]open fun getDouble(feature: Feature, key: String): Double[jvm]abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): DoubleCalculates the value of a double feature flag for the given key and attributes. getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of an enumerated feature flag for the given key and attributes. getEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getInt [jvm]open fun getInt(feature: Feature, key: String): Int[jvm]abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): IntCalculates the value of an integer feature flag for the given key and attributes. getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of a JSON feature flag for the given key and attributes. getJson [jvm]inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T getString [jvm]open fun getString(feature: Feature, key: String): String[jvm]abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a string feature flag for the given key and attributes. trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference[jvm]abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a tracker for the value of a boolean feature flag for the given key and attributes. trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference[jvm]abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a tracker for the value of a double feature flag for the given key and attributes. trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of an enumerated feature flag for the given key and attributes. trackEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference[jvm]abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a tracker for the value of an integer feature flag for the given key and attributes. trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of a JSON feature flag for the given key and attributes. trackJson [jvm]inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference[jvm]abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a tracker for the value of a string feature flag for the given key and attributes."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): Boolean
Calculates the value of an boolean feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-boolean/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getBoolean(feature: Feature, key: String): Boolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-double/","title":"getDouble - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): Double
Calculates the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-double/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getDouble(feature: Feature, key: String): Double
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/","title":"getEnum - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-int/","title":"getInt - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): Int
Calculates the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-int/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getInt(feature: Feature, key: String): Int
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/","title":"getJson - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-string/","title":"getString - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): String
Calculates the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-string/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getString(feature: Feature, key: String): String
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/","title":"get - Misk","text":"//misk-feature/misk.feature/FeatureFlags/get
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#get","title":"get","text":"[jvm]\\ abstract fun get(flag: BooleanFeatureFlag): Boolean
Calculates the value of a boolean feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: StringFeatureFlag): String
Calculates the value of a string feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_1","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_1","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: IntFeatureFlag): Int
Calculates the value of an int feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_2","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_2","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: DoubleFeatureFlag): Double
Calculates the value of a double feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_3","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_3","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
Calculates the value of an enum feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_4","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_4","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): T
Calculates the value of a json feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_5","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_5","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a tracker for the value of a boolean feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-boolean/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-double/","title":"trackDouble - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a tracker for the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-double/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#return","title":"Return","text":"a reference to the registered tracker allowing to un-register it
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation. tracker a tracker to be registered for processing of changed values"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-int/","title":"trackInt - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a tracker for the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-int/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/","title":"trackJson - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-string/","title":"trackString - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a tracker for the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-string/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-service/","title":"FeatureService - Misk","text":"//misk-feature/misk.feature/FeatureService
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-service/#featureservice","title":"FeatureService","text":"[jvm]\\ interface FeatureService : Service
Marker interface to integrate with the misk service graph.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-tracker-reference/","title":"TrackerReference - Misk","text":"//misk-feature/misk.feature/TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-tracker-reference/#trackerreference","title":"TrackerReference","text":"[jvm]\\ interface TrackerReference : TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-tracker-reference/#functions","title":"Functions","text":"Name Summary toMisk [jvm]fun TrackerReference.toMisk(): TrackerReference unregister [jvm]abstract fun unregister()"},{"location":"0.x/misk-gcp/","title":"misk-gcp - Misk","text":"//misk-gcp
"},{"location":"0.x/misk-gcp/#misk-gcp","title":"misk-gcp","text":""},{"location":"0.x/misk-gcp/#packages","title":"Packages","text":"Name misk.cloud.gcp misk.cloud.gcp.datastore misk.cloud.gcp.logging misk.cloud.gcp.security.keys misk.cloud.gcp.spanner misk.cloud.gcp.storage misk.cloud.gcp.tracing misk.logging"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/#types","title":"Types","text":"Name Summary GoogleCloudModule [jvm]class GoogleCloudModule(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig) : KAbstractModuleInstalls support for talking to real GCP services, either direct or via emulator TransportConfig [jvm]data class TransportConfig@JvmOverloadsconstructor(val connect_timeout_ms: Int = -1, val read_timeout_ms: Int = -1, val host: String? = null)Transport configuration for GCP services."},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/","title":"GoogleCloudModule - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/#googlecloudmodule","title":"GoogleCloudModule","text":"[jvm]\\ class GoogleCloudModule(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig) : KAbstractModule
Installs support for talking to real GCP services, either direct or via emulator
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/#constructors","title":"Constructors","text":"GoogleCloudModule [jvm]constructor(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideCloudDatastore [jvm]@Provides@Singletonfun provideCloudDatastore(credentials: Credentials, config: DatastoreConfig): Datastore provideCloudStorage [jvm]@Provides@Singletonfun provideCloudStorage(credentials: Credentials, config: StorageConfig): Storage provideServiceCredentials [jvm]@Provides@Singletonfun provideServiceCredentials(deployment: Deployment): Credentials"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/-google-cloud-module/","title":"GoogleCloudModule - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/GoogleCloudModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/-google-cloud-module/#googlecloudmodule","title":"GoogleCloudModule","text":"[jvm]\\ constructor(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-datastore/","title":"provideCloudDatastore - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/provideCloudDatastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-datastore/#provideclouddatastore","title":"provideCloudDatastore","text":"[jvm]\\
@Provides
@Singleton
fun provideCloudDatastore(credentials: Credentials, config: DatastoreConfig): Datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-storage/","title":"provideCloudStorage - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/provideCloudStorage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-storage/#providecloudstorage","title":"provideCloudStorage","text":"[jvm]\\
@Provides
@Singleton
fun provideCloudStorage(credentials: Credentials, config: StorageConfig): Storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-service-credentials/","title":"provideServiceCredentials - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/provideServiceCredentials
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-service-credentials/#provideservicecredentials","title":"provideServiceCredentials","text":"[jvm]\\
@Provides
@Singleton
fun provideServiceCredentials(deployment: Deployment): Credentials
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/","title":"TransportConfig - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/#transportconfig","title":"TransportConfig","text":"[jvm]\\ data class TransportConfig@JvmOverloadsconstructor(val connect_timeout_ms: Int = -1, val read_timeout_ms: Int = -1, val host: String? = null)
Transport configuration for GCP services.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/#constructors","title":"Constructors","text":"TransportConfig [jvm]@JvmOverloadsconstructor(connect_timeout_ms: Int = -1, read_timeout_ms: Int = -1, host: String? = null)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/#properties","title":"Properties","text":"Name Summary connect_timeout_ms [jvm]val connect_timeout_ms: Int host [jvm]val host: String? = null read_timeout_ms [jvm]val read_timeout_ms: Int"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/-transport-config/","title":"TransportConfig - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/-transport-config/#transportconfig","title":"TransportConfig","text":"[jvm]\\
@JvmOverloads
constructor(connect_timeout_ms: Int = -1, read_timeout_ms: Int = -1, host: String? = null)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/connect_timeout_ms/","title":"connect_timeout_ms - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/connect_timeout_ms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/connect_timeout_ms/#connect_timeout_ms","title":"connect_timeout_ms","text":"[jvm]\\ val connect_timeout_ms: Int
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/host/","title":"host - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/host
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/host/#host","title":"host","text":"[jvm]\\ val host: String? = null
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/read_timeout_ms/","title":"read_timeout_ms - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/read_timeout_ms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/read_timeout_ms/#read_timeout_ms","title":"read_timeout_ms","text":"[jvm]\\ val read_timeout_ms: Int
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/#types","title":"Types","text":"Name Summary DatastoreConfig [jvm]data class DatastoreConfig@JvmOverloadsconstructor(val transport: TransportConfig = TransportConfig()) : ConfigConfiguration for talking to Google datastore Keys [jvm]object Keys"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/#functions","title":"Functions","text":"Name Summary asList [jvm]fun <T> QueryResults<T>.asList(): List<T> getByteString [jvm]fun Entity.getByteString(name: String): ByteString getProto [jvm]fun <T> Entity.getProto(name: String, protoAdapter: ProtoAdapter<T>): T set [jvm]fun Entity.Builder.set(name: String, bytes: ByteString): Entity.Builder toByteString [jvm]fun Blob.toByteString(): ByteString"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/as-list/","title":"asList - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/asList
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/as-list/#aslist","title":"asList","text":"[jvm]\\ fun <T> QueryResults<T>.asList(): List<T>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-byte-string/","title":"getByteString - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/getByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-byte-string/#getbytestring","title":"getByteString","text":"[jvm]\\ fun Entity.getByteString(name: String): ByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-proto/","title":"getProto - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/getProto
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-proto/#getproto","title":"getProto","text":"[jvm]\\ fun <T> Entity.getProto(name: String, protoAdapter: ProtoAdapter<T>): T
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/set/","title":"set - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/set
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/set/#set","title":"set","text":"[jvm]\\ fun Entity.Builder.set(name: String, bytes: ByteString): Entity.Builder
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/to-byte-string/","title":"toByteString - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/toByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/to-byte-string/#tobytestring","title":"toByteString","text":"[jvm]\\ fun Blob.toByteString(): ByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/","title":"DatastoreConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/DatastoreConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/#datastoreconfig","title":"DatastoreConfig","text":"[jvm]\\ data class DatastoreConfig@JvmOverloadsconstructor(val transport: TransportConfig = TransportConfig()) : Config
Configuration for talking to Google datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/#constructors","title":"Constructors","text":"DatastoreConfig [jvm]@JvmOverloadsconstructor(transport: TransportConfig = TransportConfig())"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/#properties","title":"Properties","text":"Name Summary transport [jvm]val transport: TransportConfig"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/-datastore-config/","title":"DatastoreConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/DatastoreConfig/DatastoreConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/-datastore-config/#datastoreconfig","title":"DatastoreConfig","text":"[jvm]\\
@JvmOverloads
constructor(transport: TransportConfig = TransportConfig())
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/transport/","title":"transport - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/DatastoreConfig/transport
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/transport/#transport","title":"transport","text":"[jvm]\\ val transport: TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/","title":"Keys - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/Keys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/#keys","title":"Keys","text":"[jvm]\\ object Keys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/#functions","title":"Functions","text":"Name Summary newKey [jvm]fun newKey(projectId: String, kind: String, id: Long): Keyfun newKey(projectId: String, kind: String, name: String): Key"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/new-key/","title":"newKey - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/Keys/newKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/new-key/#newkey","title":"newKey","text":"[jvm]\\ fun newKey(projectId: String, kind: String, id: Long): Key
fun newKey(projectId: String, kind: String, name: String): Key
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.logging
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/#types","title":"Types","text":"Name Summary StackDriverLoggingConfig [jvm]data class StackDriverLoggingConfig@JvmOverloadsconstructor(val flush_level: Level = Level.ERROR, val filter_level: Level = Level.INFO, val resource_type: String?, val log: String = \"java.log\") : Config"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/","title":"StackDriverLoggingConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/#stackdriverloggingconfig","title":"StackDriverLoggingConfig","text":"[jvm]\\ data class StackDriverLoggingConfig@JvmOverloadsconstructor(val flush_level: Level = Level.ERROR, val filter_level: Level = Level.INFO, val resource_type: String?, val log: String = \"java.log\") : Config
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/#constructors","title":"Constructors","text":"StackDriverLoggingConfig [jvm]@JvmOverloadsconstructor(flush_level: Level = Level.ERROR, filter_level: Level = Level.INFO, resource_type: String?, log: String = \"java.log\")"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/#properties","title":"Properties","text":"Name Summary filter_level [jvm]val filter_level: Level flush_level [jvm]val flush_level: Level log [jvm]val log: String resource_type [jvm]val resource_type: String?"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/-stack-driver-logging-config/","title":"StackDriverLoggingConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/StackDriverLoggingConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/-stack-driver-logging-config/#stackdriverloggingconfig","title":"StackDriverLoggingConfig","text":"[jvm]\\
@JvmOverloads
constructor(flush_level: Level = Level.ERROR, filter_level: Level = Level.INFO, resource_type: String?, log: String = \"java.log\")
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/filter_level/","title":"filter_level - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/filter_level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/filter_level/#filter_level","title":"filter_level","text":"[jvm]\\ val filter_level: Level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/flush_level/","title":"flush_level - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/flush_level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/flush_level/#flush_level","title":"flush_level","text":"[jvm]\\ val flush_level: Level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/log/","title":"log - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/log
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/log/#log","title":"log","text":"[jvm]\\ val log: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/resource_type/","title":"resource_type - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/resource_type
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/resource_type/#resource_type","title":"resource_type","text":"[jvm]\\ val resource_type: String?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/#types","title":"Types","text":"Name Summary GcpKeyLocation [jvm]data class GcpKeyLocation(val location: String, val key_ring: String, val key_name: String) GcpKeyManagementModule [jvm]class GcpKeyManagementModule(config: GcpKmsConfig) : KAbstractModule GcpKmsConfig [jvm]data class GcpKmsConfig(val project_id: String, val key_locations: Map<String, GcpKeyLocation>) : Config"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/","title":"GcpKeyLocation - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/#gcpkeylocation","title":"GcpKeyLocation","text":"[jvm]\\ data class GcpKeyLocation(val location: String, val key_ring: String, val key_name: String)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/#constructors","title":"Constructors","text":"GcpKeyLocation [jvm]constructor(location: String, key_ring: String, key_name: String)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/#properties","title":"Properties","text":"Name Summary key_name [jvm]val key_name: String key_ring [jvm]val key_ring: String location [jvm]val location: String path [jvm]val path: String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/-gcp-key-location/","title":"GcpKeyLocation - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/GcpKeyLocation
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/-gcp-key-location/#gcpkeylocation","title":"GcpKeyLocation","text":"[jvm]\\ constructor(location: String, key_ring: String, key_name: String)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_name/","title":"key_name - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/key_name
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_name/#key_name","title":"key_name","text":"[jvm]\\ val key_name: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_ring/","title":"key_ring - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/key_ring
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_ring/#key_ring","title":"key_ring","text":"[jvm]\\ val key_ring: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/location/","title":"location - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/location
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/location/#location","title":"location","text":"[jvm]\\ val location: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/path/","title":"path - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/path
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/","title":"GcpKeyManagementModule - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyManagementModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/#gcpkeymanagementmodule","title":"GcpKeyManagementModule","text":"[jvm]\\ class GcpKeyManagementModule(config: GcpKmsConfig) : KAbstractModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/#constructors","title":"Constructors","text":"GcpKeyManagementModule [jvm]constructor(config: GcpKmsConfig)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providesKms [jvm]@Provides@Singletonfun providesKms(appName: String): CloudKMS"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/-gcp-key-management-module/","title":"GcpKeyManagementModule - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyManagementModule/GcpKeyManagementModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/-gcp-key-management-module/#gcpkeymanagementmodule","title":"GcpKeyManagementModule","text":"[jvm]\\ constructor(config: GcpKmsConfig)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/provides-kms/","title":"providesKms - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyManagementModule/providesKms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/provides-kms/#provideskms","title":"providesKms","text":"[jvm]\\
@Provides
@Singleton
fun providesKms(appName: String): CloudKMS
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/","title":"GcpKmsConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/#gcpkmsconfig","title":"GcpKmsConfig","text":"[jvm]\\ data class GcpKmsConfig(val project_id: String, val key_locations: Map<String, GcpKeyLocation>) : Config
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/#constructors","title":"Constructors","text":"GcpKmsConfig [jvm]constructor(project_id: String, key_locations: Map<String, GcpKeyLocation>)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/#properties","title":"Properties","text":"Name Summary key_locations [jvm]val key_locations: Map<String, GcpKeyLocation> project_id [jvm]val project_id: String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/-gcp-kms-config/","title":"GcpKmsConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig/GcpKmsConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/-gcp-kms-config/#gcpkmsconfig","title":"GcpKmsConfig","text":"[jvm]\\ constructor(project_id: String, key_locations: Map<String, GcpKeyLocation>)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/key_locations/","title":"key_locations - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig/key_locations
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/key_locations/#key_locations","title":"key_locations","text":"[jvm]\\ val key_locations: Map<String, GcpKeyLocation>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/project_id/","title":"project_id - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig/project_id
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/project_id/#project_id","title":"project_id","text":"[jvm]\\ val project_id: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/#types","title":"Types","text":"Name Summary GoogleSpannerModule [jvm]class GoogleSpannerModule(spannerConfig: SpannerConfig) : KAbstractModuleGoogleSpannerModule provides a Google Spanner client for your app. GoogleSpannerService [jvm]@Singletonclass GoogleSpannerService@Injectconstructor(spanner: Spanner) : AbstractIdleService SpannerConfig [jvm]data class SpannerConfig@JvmOverloadsconstructor(val credentials: Credentials? = null, val database: String, val emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), val instance_id: String, val project_id: String, val initial_retry_delay_ms: Long? = null, val max_retry_delay_s: Long? = null, val retry_delay_multiplier: Double? = null, val initial_rpc_timeout_s: Long? = null, val max_rpc_timeout_s: Long? = null, val rpc_timeout_multipler: Double? = null, val total_timeout_s: Long? = null, val max_attempts: Int? = null) : ConfigConfiguration for talking to Google datastore SpannerEmulatorConfig [jvm]data class SpannerEmulatorConfig@JvmOverloadsconstructor(val enabled: Boolean = false, val hostname: String = \"localhost\", val port: Int = 9010, val version: String? = null)Options for configuring the Spanner emulator."},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/","title":"GoogleSpannerModule - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/#googlespannermodule","title":"GoogleSpannerModule","text":"[jvm]\\ class GoogleSpannerModule(spannerConfig: SpannerConfig) : KAbstractModule
GoogleSpannerModule provides a Google Spanner client for your app.
For testing, install the emulator
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/#constructors","title":"Constructors","text":"GoogleSpannerModule [jvm]constructor(spannerConfig: SpannerConfig)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideCloudSpanner [jvm]@Provides@Singletonfun provideCloudSpanner(config: SpannerConfig): Spanner"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/-google-spanner-module/","title":"GoogleSpannerModule - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerModule/GoogleSpannerModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/-google-spanner-module/#googlespannermodule","title":"GoogleSpannerModule","text":"[jvm]\\ constructor(spannerConfig: SpannerConfig)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/provide-cloud-spanner/","title":"provideCloudSpanner - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerModule/provideCloudSpanner
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/provide-cloud-spanner/#providecloudspanner","title":"provideCloudSpanner","text":"[jvm]\\
@Provides
@Singleton
fun provideCloudSpanner(config: SpannerConfig): Spanner
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/","title":"GoogleSpannerService - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerService
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#googlespannerservice","title":"GoogleSpannerService","text":"[jvm]\\ @Singleton
class GoogleSpannerService@Injectconstructor(spanner: Spanner) : AbstractIdleService
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#constructors","title":"Constructors","text":"GoogleSpannerService [jvm]@Injectconstructor(spanner: Spanner)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-google-spanner-service/","title":"GoogleSpannerService - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerService/GoogleSpannerService
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-google-spanner-service/#googlespannerservice","title":"GoogleSpannerService","text":"[jvm]\\
@Inject
constructor(spanner: Spanner)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-companion/","title":"Companion - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerService/Companion
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/","title":"SpannerConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/#spannerconfig","title":"SpannerConfig","text":"[jvm]\\ data class SpannerConfig@JvmOverloadsconstructor(val credentials: Credentials? = null, val database: String, val emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), val instance_id: String, val project_id: String, val initial_retry_delay_ms: Long? = null, val max_retry_delay_s: Long? = null, val retry_delay_multiplier: Double? = null, val initial_rpc_timeout_s: Long? = null, val max_rpc_timeout_s: Long? = null, val rpc_timeout_multipler: Double? = null, val total_timeout_s: Long? = null, val max_attempts: Int? = null) : Config
Configuration for talking to Google datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/#constructors","title":"Constructors","text":"SpannerConfig [jvm]@JvmOverloadsconstructor(credentials: Credentials? = null, database: String, emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), instance_id: String, project_id: String, initial_retry_delay_ms: Long? = null, max_retry_delay_s: Long? = null, retry_delay_multiplier: Double? = null, initial_rpc_timeout_s: Long? = null, max_rpc_timeout_s: Long? = null, rpc_timeout_multipler: Double? = null, total_timeout_s: Long? = null, max_attempts: Int? = null)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/#properties","title":"Properties","text":"Name Summary credentials [jvm]val credentials: Credentials? = nullA set of Google Cloud credentials to use for making requests to Spanner. database [jvm]val database: StringName of the database to connect to within the Spanner instance. emulator [jvm]val emulator: SpannerEmulatorConfigConfiguration for the included Spanner emulator. initial_retry_delay_ms [jvm]val initial_retry_delay_ms: Long? = nullThe initial amount of time to wait before retrying the request. initial_rpc_timeout_s [jvm]val initial_rpc_timeout_s: Long? = nullConfigure RPC and total timeout settings. Timeout for the first RPC call. Subsequent retries will be based off this value. instance_id [jvm]val instance_id: StringID of the Spanner instance to connect to. max_attempts [jvm]val max_attempts: Int? = nullTotal number of attempts for an RPC. Setting to 1 means no retries will be attempted. max_retry_delay_s [jvm]val max_retry_delay_s: Long? = nullThe maximum amount of time to wait before retrying. I.e. after this value is reached, the wait time will not increase further by the multiplier. max_rpc_timeout_s [jvm]val max_rpc_timeout_s: Long? = nullThe max for the per RPC timeout. project_id [jvm]val project_id: StringID of the GCP project the Spanner instance is located in. retry_delay_multiplier [jvm]val retry_delay_multiplier: Double? = nullThe previous wait time is multiplied by this multiplier to come up with the next wait time, until the max is reached. rpc_timeout_multipler [jvm]val rpc_timeout_multipler: Double? = nullControls the change of timeout for each retry. total_timeout_s [jvm]val total_timeout_s: Long? = nullThe timeout for all calls (first call + all retries)."},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/-spanner-config/","title":"SpannerConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/SpannerConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/-spanner-config/#spannerconfig","title":"SpannerConfig","text":"[jvm]\\
@JvmOverloads
constructor(credentials: Credentials? = null, database: String, emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), instance_id: String, project_id: String, initial_retry_delay_ms: Long? = null, max_retry_delay_s: Long? = null, retry_delay_multiplier: Double? = null, initial_rpc_timeout_s: Long? = null, max_rpc_timeout_s: Long? = null, rpc_timeout_multipler: Double? = null, total_timeout_s: Long? = null, max_attempts: Int? = null)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/credentials/","title":"credentials - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/credentials
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/credentials/#credentials","title":"credentials","text":"[jvm]\\ val credentials: Credentials? = null
A set of Google Cloud credentials to use for making requests to Spanner.
If you have special behavior around managing service credentials in production environments, this is the place to configure that.
Note: We will attempt to automatically grab credentials from the environment where applicable, or ignore setting credentials for emulator development.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/database/","title":"database - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/database
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/database/#database","title":"database","text":"[jvm]\\ val database: String
Name of the database to connect to within the Spanner instance.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/emulator/","title":"emulator - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/emulator
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/emulator/#emulator","title":"emulator","text":"[jvm]\\ val emulator: SpannerEmulatorConfig
Configuration for the included Spanner emulator.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_retry_delay_ms/","title":"initial_retry_delay_ms - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/initial_retry_delay_ms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_retry_delay_ms/#initial_retry_delay_ms","title":"initial_retry_delay_ms","text":"[jvm]\\ val initial_retry_delay_ms: Long? = null
The initial amount of time to wait before retrying the request.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_rpc_timeout_s/","title":"initial_rpc_timeout_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/initial_rpc_timeout_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_rpc_timeout_s/#initial_rpc_timeout_s","title":"initial_rpc_timeout_s","text":"[jvm]\\ val initial_rpc_timeout_s: Long? = null
Configure RPC and total timeout settings. Timeout for the first RPC call. Subsequent retries will be based off this value.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/instance_id/","title":"instance_id - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/instance_id
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/instance_id/#instance_id","title":"instance_id","text":"[jvm]\\ val instance_id: String
ID of the Spanner instance to connect to.
Note: your local dev instance ID doesn\u2019t have to be related to an actual Spanner instance - any string will do.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_attempts/","title":"max_attempts - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/max_attempts
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_attempts/#max_attempts","title":"max_attempts","text":"[jvm]\\ val max_attempts: Int? = null
Total number of attempts for an RPC. Setting to 1 means no retries will be attempted.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_retry_delay_s/","title":"max_retry_delay_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/max_retry_delay_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_retry_delay_s/#max_retry_delay_s","title":"max_retry_delay_s","text":"[jvm]\\ val max_retry_delay_s: Long? = null
The maximum amount of time to wait before retrying. I.e. after this value is reached, the wait time will not increase further by the multiplier.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_rpc_timeout_s/","title":"max_rpc_timeout_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/max_rpc_timeout_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_rpc_timeout_s/#max_rpc_timeout_s","title":"max_rpc_timeout_s","text":"[jvm]\\ val max_rpc_timeout_s: Long? = null
The max for the per RPC timeout.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/project_id/","title":"project_id - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/project_id
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/project_id/#project_id","title":"project_id","text":"[jvm]\\ val project_id: String
ID of the GCP project the Spanner instance is located in.
Note: your local dev project ID doesn\u2019t have to be related to an actual GCP project - any string will do.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/retry_delay_multiplier/","title":"retry_delay_multiplier - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/retry_delay_multiplier
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/retry_delay_multiplier/#retry_delay_multiplier","title":"retry_delay_multiplier","text":"[jvm]\\ val retry_delay_multiplier: Double? = null
The previous wait time is multiplied by this multiplier to come up with the next wait time, until the max is reached.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/rpc_timeout_multipler/","title":"rpc_timeout_multipler - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/rpc_timeout_multipler
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/rpc_timeout_multipler/#rpc_timeout_multipler","title":"rpc_timeout_multipler","text":"[jvm]\\ val rpc_timeout_multipler: Double? = null
Controls the change of timeout for each retry.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/total_timeout_s/","title":"total_timeout_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/total_timeout_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/total_timeout_s/#total_timeout_s","title":"total_timeout_s","text":"[jvm]\\ val total_timeout_s: Long? = null
The timeout for all calls (first call + all retries).
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/","title":"SpannerEmulatorConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/#spanneremulatorconfig","title":"SpannerEmulatorConfig","text":"[jvm]\\ data class SpannerEmulatorConfig@JvmOverloadsconstructor(val enabled: Boolean = false, val hostname: String = \"localhost\", val port: Int = 9010, val version: String? = null)
Options for configuring the Spanner emulator.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/#constructors","title":"Constructors","text":"SpannerEmulatorConfig [jvm]@JvmOverloadsconstructor(enabled: Boolean = false, hostname: String = \"localhost\", port: Int = 9010, version: String? = null)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/#properties","title":"Properties","text":"Name Summary enabled [jvm]val enabled: Boolean = falseWhether or not to start the Spanner emulator when the GoogleSpannerModule is installed. hostname [jvm]val hostname: StringThe hostname where the Spanner emulator is hosted. In almost all cases, this should be left as \"localhost\". port [jvm]val port: Int = 9010The port where the Spanner emulator\u2019s gRPC port is hosted. version [jvm]val version: String? = null"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/-spanner-emulator-config/","title":"SpannerEmulatorConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/SpannerEmulatorConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/-spanner-emulator-config/#spanneremulatorconfig","title":"SpannerEmulatorConfig","text":"[jvm]\\
@JvmOverloads
constructor(enabled: Boolean = false, hostname: String = \"localhost\", port: Int = 9010, version: String? = null)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/enabled/","title":"enabled - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/enabled
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/enabled/#enabled","title":"enabled","text":"[jvm]\\ val enabled: Boolean = false
Whether or not to start the Spanner emulator when the GoogleSpannerModule is installed.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/hostname/","title":"hostname - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/hostname
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/hostname/#hostname","title":"hostname","text":"[jvm]\\ val hostname: String
The hostname where the Spanner emulator is hosted. In almost all cases, this should be left as \"localhost\".
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/port/","title":"port - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/port
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/port/#port","title":"port","text":"[jvm]\\ val port: Int = 9010
The port where the Spanner emulator\u2019s gRPC port is hosted.
By default, Spanner emulators run a gRPC port on 9010 and a REST / HTTP port on 9020. When spinning up an emulator, we will automatically reserve this port \"+ 10\" as the REST / HTTP port for Docker to bind to.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/version/","title":"version - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/version
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/version/#version","title":"version","text":"[jvm]\\ val version: String? = null
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#types","title":"Types","text":"Name Summary BaseCustomStorageRpc [jvm]abstract class BaseCustomStorageRpc : StorageRpcBase for custom storage implementations. Most operations on custom storage are unsupported; only those minimal methods requiring implementation are left abstract. LocalStorageConfig [jvm]data class LocalStorageConfig(val data_dir: String)Configuration for local (emulated) storage LocalStorageRpc [jvm]class LocalStorageRpc@JvmOverloadsconstructor(root: Path, moshi: Moshi = defaultKotlinMoshi) : BaseCustomStorageRpcImplementation of StorageRpc that is backed by local disk storage. Useful for running in development mode on local machines, since there is no GCS emulator available. Files are stored with the generation version appended as an extension suffix, with a symlink existing for the latest generation. To preserve GCS atomicity semantics, progressive uploads are handled by storing the interim uploaded data in a temporary file based off the latest generation, then doing a rename to the new generation once the upload is complete. StorageConfig [jvm]data class StorageConfig@JvmOverloadsconstructor(val use_local_storage: Boolean = false, val local_storage: LocalStorageConfig? = null, val transport: TransportConfig = TransportConfig()) : ConfigConfiguration for talking to Google Cloud Storage"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#properties","title":"Properties","text":"Name Summary blobIds [jvm]val Page<Blob>.blobIds: List<BlobId>"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#functions","title":"Functions","text":"Name Summary compareTo [jvm]fun BlobId.compareTo(other: BlobId): Int forEachChunk [jvm]fun ReadChannel.forEachChunk(buffer: ByteBuffer, action: (ByteBuffer, Int) -> Unit)Runs the given block for each chunk on a given channel[jvm]fun ReadChannel.forEachChunk(chunkSize: Int, action: (ByteBuffer, Int) -> Unit) toList [jvm]fun <T> Page<T>.toList(): List<T> withLock [jvm]fun <T> FileChannel.withLock(shared: Boolean, action: () -> T): T"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/blob-ids/","title":"blobIds - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/blobIds
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/blob-ids/#blobids","title":"blobIds","text":"[jvm]\\ val Page<Blob>.blobIds: List<BlobId>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/blob-ids/#return","title":"Return","text":"a list containing just the ids of the blobs in the page
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/compare-to/","title":"compareTo - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/compareTo
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ fun BlobId.compareTo(other: BlobId): Int
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/compare-to/#return","title":"Return","text":"compares one blob id to another; orders by bucket, then name, then generation
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/for-each-chunk/","title":"forEachChunk - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/forEachChunk
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/for-each-chunk/#foreachchunk","title":"forEachChunk","text":"[jvm]\\ fun ReadChannel.forEachChunk(buffer: ByteBuffer, action: (ByteBuffer, Int) -> Unit)
Runs the given block for each chunk on a given channel
[jvm]\\ fun ReadChannel.forEachChunk(chunkSize: Int, action: (ByteBuffer, Int) -> Unit)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/to-list/","title":"toList - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/toList
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/to-list/#tolist","title":"toList","text":"[jvm]\\ fun <T> Page<T>.toList(): List<T>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/to-list/#return","title":"Return","text":"a list containing all of the elements in this page
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/with-lock/","title":"withLock - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/withLock
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/with-lock/#withlock","title":"withLock","text":"[jvm]\\ fun <T> FileChannel.withLock(shared: Boolean, action: () -> T): T
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/","title":"BaseCustomStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#basecustomstoragerpc","title":"BaseCustomStorageRpc","text":"abstract class BaseCustomStorageRpc : StorageRpc
Base for custom storage implementations. Most operations on custom storage are unsupported; only those minimal methods requiring implementation are left abstract.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#inheritors","title":"Inheritors","text":"LocalStorageRpc"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#constructors","title":"Constructors","text":"BaseCustomStorageRpc [jvm]constructor()"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#functions","title":"Functions","text":"Name Summary compose [jvm]open override fun compose(sources: Iterable<StorageObject>?, target: StorageObject?, targetOptions: Map<StorageRpc.Option, *>?): StorageObject continueRewrite [jvm]open override fun continueRewrite(previousResponse: StorageRpc.RewriteResponse): StorageRpc.RewriteResponse create [jvm]abstract fun create(p0: StorageObject, p1: InputStream, p2: MutableMap<StorageRpc.Option, *>): StorageObjectopen override fun create(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket createAcl [jvm]open override fun createAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun createAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl createBatch [jvm]open override fun createBatch(): RpcBatch createDefaultAcl [jvm]open override fun createDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl createHmacKey [jvm]open override fun createHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKey createNotification [jvm]open override fun createNotification(bucket: String?, notification: Notification?): Notification delete [jvm]abstract fun delete(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): Booleanopen override fun delete(bucket: Bucket, options: Map<StorageRpc.Option, *>): Boolean deleteAcl [jvm]open override fun deleteAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): Booleanopen override fun deleteAcl(bucket: String?, object: String?, generation: Long?, entity: String?): Boolean deleteDefaultAcl [jvm]open override fun deleteDefaultAcl(bucket: String?, entity: String?): Boolean deleteHmacKey [jvm]open override fun deleteHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?) deleteNotification [jvm]open override fun deleteNotification(bucket: String?, notification: String?): Boolean get [jvm]abstract operator fun get(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): StorageObjectopen operator override fun get(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket? getAcl [jvm]open override fun getAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): BucketAccessControlopen override fun getAcl(bucket: String?, obj: String?, generation: Long?, entity: String?): ObjectAccessControl getCurrentUploadOffset [jvm]open override fun getCurrentUploadOffset(p0: String?): Long getDefaultAcl [jvm]open override fun getDefaultAcl(bucket: String?, entity: String?): ObjectAccessControl getHmacKey [jvm]open override fun getHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata getIamPolicy [jvm]open override fun getIamPolicy(bucket: String?, options: Map<StorageRpc.Option, *>?): Policy getServiceAccount [jvm]open override fun getServiceAccount(projectId: String?): ServiceAccount list [jvm]abstract fun list(p0: String, p1: MutableMap<StorageRpc.Option, *>): Tuple<String, MutableIterable<StorageObject>>open override fun list(options: Map<StorageRpc.Option, *>?): Tuple<String, Iterable<Bucket>> listAcls [jvm]open override fun listAcls(bucket: String?, options: Map<StorageRpc.Option, *>?): List<BucketAccessControl>open override fun listAcls(bucket: String?, obj: String?, generation: Long?): List<ObjectAccessControl> listDefaultAcls [jvm]open override fun listDefaultAcls(bucket: String?): MutableList<ObjectAccessControl> listHmacKeys [jvm]open override fun listHmacKeys(p0: MutableMap<StorageRpc.Option, *>?): Tuple<String, MutableIterable<HmacKeyMetadata>> listNotifications [jvm]open override fun listNotifications(bucket: String?): List<Notification> load [jvm]abstract fun load(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): ByteArray lockRetentionPolicy [jvm]open override fun lockRetentionPolicy(bucket: Bucket?, options: Map<StorageRpc.Option, *>?): Bucket open [jvm]abstract fun open(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): Stringopen override fun open(signedURL: String?): String openRewrite [jvm]abstract fun openRewrite(p0: StorageRpc.RewriteRequest): StorageRpc.RewriteResponse patch [jvm]open override fun patch(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?open override fun patch(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject? patchAcl [jvm]open override fun patchAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun patchAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl patchDefaultAcl [jvm]open override fun patchDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl read [jvm]abstract fun read(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>, p2: Long, p3: OutputStream): Longopen override fun read(from: StorageObject?, options: Map<StorageRpc.Option, *>?, position: Long, bytes: Int): Tuple<String, ByteArray> setIamPolicy [jvm]open override fun setIamPolicy(bucket: String?, policy: Policy?, options: Map<StorageRpc.Option, *>?): Policy testIamPermissions [jvm]open override fun testIamPermissions(bucket: String, permissions: List<String>, options: Map<StorageRpc.Option, *>): TestIamPermissionsResponse updateHmacKey [jvm]open override fun updateHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata write [jvm]abstract fun write(p0: String, p1: ByteArray, p2: Int, p3: Long, p4: Int, p5: Boolean) writeWithResponse [jvm]open override fun writeWithResponse(p0: String?, p1: ByteArray?, p2: Int, p3: Long, p4: Int, p5: Boolean): StorageObject"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/-base-custom-storage-rpc/","title":"BaseCustomStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/BaseCustomStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/-base-custom-storage-rpc/#basecustomstoragerpc","title":"BaseCustomStorageRpc","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/compose/","title":"compose - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/compose
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/compose/#compose","title":"compose","text":"[jvm]\\ open override fun compose(sources: Iterable<StorageObject>?, target: StorageObject?, targetOptions: Map<StorageRpc.Option, *>?): StorageObject
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/continue-rewrite/","title":"continueRewrite - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/continueRewrite
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/continue-rewrite/#continuerewrite","title":"continueRewrite","text":"[jvm]\\ open override fun continueRewrite(previousResponse: StorageRpc.RewriteResponse): StorageRpc.RewriteResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-acl/","title":"createAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-acl/#createacl","title":"createAcl","text":"[jvm]\\ open override fun createAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl
open override fun createAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-batch/","title":"createBatch - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createBatch
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-batch/#createbatch","title":"createBatch","text":"[jvm]\\ open override fun createBatch(): RpcBatch
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-default-acl/","title":"createDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-default-acl/#createdefaultacl","title":"createDefaultAcl","text":"[jvm]\\ open override fun createDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-hmac-key/","title":"createHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-hmac-key/#createhmackey","title":"createHmacKey","text":"[jvm]\\ open override fun createHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-notification/","title":"createNotification - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createNotification
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-notification/#createnotification","title":"createNotification","text":"[jvm]\\ open override fun createNotification(bucket: String?, notification: Notification?): Notification
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create/","title":"create - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/create
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create/#create","title":"create","text":"[jvm]\\ open override fun create(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-acl/","title":"deleteAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-acl/#deleteacl","title":"deleteAcl","text":"[jvm]\\ open override fun deleteAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): Boolean
open override fun deleteAcl(bucket: String?, object: String?, generation: Long?, entity: String?): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-default-acl/","title":"deleteDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-default-acl/#deletedefaultacl","title":"deleteDefaultAcl","text":"[jvm]\\ open override fun deleteDefaultAcl(bucket: String?, entity: String?): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-hmac-key/","title":"deleteHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-hmac-key/#deletehmackey","title":"deleteHmacKey","text":"[jvm]\\ open override fun deleteHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-notification/","title":"deleteNotification - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteNotification
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-notification/#deletenotification","title":"deleteNotification","text":"[jvm]\\ open override fun deleteNotification(bucket: String?, notification: String?): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete/","title":"delete - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/delete
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete/#delete","title":"delete","text":"[jvm]\\ open override fun delete(bucket: Bucket, options: Map<StorageRpc.Option, *>): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-acl/","title":"getAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-acl/#getacl","title":"getAcl","text":"[jvm]\\ open override fun getAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): BucketAccessControl
open override fun getAcl(bucket: String?, obj: String?, generation: Long?, entity: String?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-current-upload-offset/","title":"getCurrentUploadOffset - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getCurrentUploadOffset
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-current-upload-offset/#getcurrentuploadoffset","title":"getCurrentUploadOffset","text":"[jvm]\\ open override fun getCurrentUploadOffset(p0: String?): Long
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-default-acl/","title":"getDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-default-acl/#getdefaultacl","title":"getDefaultAcl","text":"[jvm]\\ open override fun getDefaultAcl(bucket: String?, entity: String?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-hmac-key/","title":"getHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-hmac-key/#gethmackey","title":"getHmacKey","text":"[jvm]\\ open override fun getHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-iam-policy/","title":"getIamPolicy - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getIamPolicy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-iam-policy/#getiampolicy","title":"getIamPolicy","text":"[jvm]\\ open override fun getIamPolicy(bucket: String?, options: Map<StorageRpc.Option, *>?): Policy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-service-account/","title":"getServiceAccount - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getServiceAccount
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-service-account/#getserviceaccount","title":"getServiceAccount","text":"[jvm]\\ open override fun getServiceAccount(projectId: String?): ServiceAccount
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get/","title":"get - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/get
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-acls/","title":"listAcls - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listAcls
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-acls/#listacls","title":"listAcls","text":"[jvm]\\ open override fun listAcls(bucket: String?, options: Map<StorageRpc.Option, *>?): List<BucketAccessControl>
open override fun listAcls(bucket: String?, obj: String?, generation: Long?): List<ObjectAccessControl>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-default-acls/","title":"listDefaultAcls - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listDefaultAcls
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-default-acls/#listdefaultacls","title":"listDefaultAcls","text":"[jvm]\\ open override fun listDefaultAcls(bucket: String?): MutableList<ObjectAccessControl>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-hmac-keys/","title":"listHmacKeys - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listHmacKeys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-hmac-keys/#listhmackeys","title":"listHmacKeys","text":"[jvm]\\ open override fun listHmacKeys(p0: MutableMap<StorageRpc.Option, *>?): Tuple<String, MutableIterable<HmacKeyMetadata>>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-notifications/","title":"listNotifications - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listNotifications
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-notifications/#listnotifications","title":"listNotifications","text":"[jvm]\\ open override fun listNotifications(bucket: String?): List<Notification>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list/","title":"list - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/list
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list/#list","title":"list","text":"[jvm]\\ open override fun list(options: Map<StorageRpc.Option, *>?): Tuple<String, Iterable<Bucket>>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/lock-retention-policy/","title":"lockRetentionPolicy - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/lockRetentionPolicy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/lock-retention-policy/#lockretentionpolicy","title":"lockRetentionPolicy","text":"[jvm]\\ open override fun lockRetentionPolicy(bucket: Bucket?, options: Map<StorageRpc.Option, *>?): Bucket
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/open/","title":"open - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/open
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/open/#open","title":"open","text":"[jvm]\\ open override fun open(signedURL: String?): String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-acl/","title":"patchAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/patchAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-acl/#patchacl","title":"patchAcl","text":"[jvm]\\ open override fun patchAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl
open override fun patchAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-default-acl/","title":"patchDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/patchDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-default-acl/#patchdefaultacl","title":"patchDefaultAcl","text":"[jvm]\\ open override fun patchDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch/","title":"patch - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/patch
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch/#patch","title":"patch","text":"[jvm]\\ open override fun patch(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?
open override fun patch(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/read/","title":"read - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/read
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/read/#read","title":"read","text":"[jvm]\\ open override fun read(from: StorageObject?, options: Map<StorageRpc.Option, *>?, position: Long, bytes: Int): Tuple<String, ByteArray>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/set-iam-policy/","title":"setIamPolicy - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/setIamPolicy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/set-iam-policy/#setiampolicy","title":"setIamPolicy","text":"[jvm]\\ open override fun setIamPolicy(bucket: String?, policy: Policy?, options: Map<StorageRpc.Option, *>?): Policy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/test-iam-permissions/","title":"testIamPermissions - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/testIamPermissions
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/test-iam-permissions/#testiampermissions","title":"testIamPermissions","text":"[jvm]\\ open override fun testIamPermissions(bucket: String, permissions: List<String>, options: Map<StorageRpc.Option, *>): TestIamPermissionsResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/update-hmac-key/","title":"updateHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/updateHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/update-hmac-key/#updatehmackey","title":"updateHmacKey","text":"[jvm]\\ open override fun updateHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/write-with-response/","title":"writeWithResponse - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/writeWithResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/write-with-response/#writewithresponse","title":"writeWithResponse","text":"[jvm]\\ open override fun writeWithResponse(p0: String?, p1: ByteArray?, p2: Int, p3: Long, p4: Int, p5: Boolean): StorageObject
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/","title":"LocalStorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/#localstorageconfig","title":"LocalStorageConfig","text":"[jvm]\\ data class LocalStorageConfig(val data_dir: String)
Configuration for local (emulated) storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/#constructors","title":"Constructors","text":"LocalStorageConfig [jvm]constructor(data_dir: String)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/#properties","title":"Properties","text":"Name Summary data_dir [jvm]val data_dir: String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/-local-storage-config/","title":"LocalStorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageConfig/LocalStorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/-local-storage-config/#localstorageconfig","title":"LocalStorageConfig","text":"[jvm]\\ constructor(data_dir: String)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/data_dir/","title":"data_dir - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageConfig/data_dir
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/data_dir/#data_dir","title":"data_dir","text":"[jvm]\\ val data_dir: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/","title":"LocalStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/#localstoragerpc","title":"LocalStorageRpc","text":"[jvm]\\ class LocalStorageRpc@JvmOverloadsconstructor(root: Path, moshi: Moshi = defaultKotlinMoshi) : BaseCustomStorageRpc
Implementation of StorageRpc that is backed by local disk storage. Useful for running in development mode on local machines, since there is no GCS emulator available. Files are stored with the generation version appended as an extension suffix, with a symlink existing for the latest generation. To preserve GCS atomicity semantics, progressive uploads are handled by storing the interim uploaded data in a temporary file based off the latest generation, then doing a rename to the new generation once the upload is complete.
The implementation uses file locks to support multiple local processes accessing the same storage directory. Whenever a blob is updated, the local store will acquire an exclusive lock on a corresponding lock file, releasing that lock when the update is complete (or when the process dies). It\u2019s slightly more complicated since we need to deal with the possibility that writer stops partway through without the process failing; in those cases we don\u2019t want to prevent subsequent updates from other processes.
Write process:
acquire a read lock
read metadata constraints, and create a new target metadata object for the next generation
release read lock
create a new temp file for receiving the update
generate an upload id, save the temp file location + target metadata + constraints in-memory associated with the upload id
write to the temp file for that upload id
acquire a write lock, read the latest metadata for the blob and re-check constraints to make sure nothing changed underneath (e.g. a concurrent upload for that blob did not complete)
copy from the temp file to a new file in the content directory, appending the new generation number. This is done as an atomic move + overwrite
write updated metadata to the metadata file. This is done as an atomic move + overwrite. Until this is complete, the new version of the content is not accessible to readers.
release the write lock
remove the content file for the prior generation
If a writer fails between open and finish, all that happens is we have abandoned temp files If a writer fails after moving the temp file to the contents directory but before updating the metadata, then we have a bad content file for that generation sitting in the content directory. Since the metadata hasn\u2019t been updated with the new generation, this content is not readable, and a subsequent write will overwrite it. If a writer fails after updating the metadata but before removing the prior generation content file, we\u2019ll have left an abandoned content file. A garbage collection process can be run to clean these up eventually
Read process
Clients use etags to detect when a blob is updated while a progressive download is in place; the etag returned from a prior read is sent in subsequent reads. We simply use the generation number as the etag value.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/#constructors","title":"Constructors","text":"LocalStorageRpc [jvm]@JvmOverloadsconstructor(root: Path, moshi: Moshi = defaultKotlinMoshi)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/#functions","title":"Functions","text":"Name Summary compose [jvm]open override fun compose(sources: Iterable<StorageObject>?, target: StorageObject?, targetOptions: Map<StorageRpc.Option, *>?): StorageObject continueRewrite [jvm]open override fun continueRewrite(previousResponse: StorageRpc.RewriteResponse): StorageRpc.RewriteResponse create [jvm]open override fun create(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucketopen override fun create(obj: StorageObject, content: InputStream, options: Map<StorageRpc.Option, *>): StorageObject? createAcl [jvm]open override fun createAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun createAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl createBatch [jvm]open override fun createBatch(): RpcBatch createDefaultAcl [jvm]open override fun createDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl createHmacKey [jvm]open override fun createHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKey createNotification [jvm]open override fun createNotification(bucket: String?, notification: Notification?): Notification delete [jvm]open override fun delete(bucket: Bucket, options: Map<StorageRpc.Option, *>): Booleanopen override fun delete(obj: StorageObject, options: Map<StorageRpc.Option, *>): Boolean deleteAcl [jvm]open override fun deleteAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): Booleanopen override fun deleteAcl(bucket: String?, object: String?, generation: Long?, entity: String?): Boolean deleteDefaultAcl [jvm]open override fun deleteDefaultAcl(bucket: String?, entity: String?): Boolean deleteHmacKey [jvm]open override fun deleteHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?) deleteNotification [jvm]open override fun deleteNotification(bucket: String?, notification: String?): Boolean get [jvm]open operator override fun get(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?open operator override fun get(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject? getAcl [jvm]open override fun getAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): BucketAccessControlopen override fun getAcl(bucket: String?, obj: String?, generation: Long?, entity: String?): ObjectAccessControl getCurrentUploadOffset [jvm]open override fun getCurrentUploadOffset(p0: String?): Long getDefaultAcl [jvm]open override fun getDefaultAcl(bucket: String?, entity: String?): ObjectAccessControl getHmacKey [jvm]open override fun getHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata getIamPolicy [jvm]open override fun getIamPolicy(bucket: String?, options: Map<StorageRpc.Option, *>?): Policy getServiceAccount [jvm]open override fun getServiceAccount(projectId: String?): ServiceAccount list [jvm]open override fun list(options: Map<StorageRpc.Option, *>?): Tuple<String, Iterable<Bucket>>open override fun list(bucket: String, options: Map<StorageRpc.Option, *>): Tuple<String, Iterable<StorageObject>> listAcls [jvm]open override fun listAcls(bucket: String?, options: Map<StorageRpc.Option, *>?): List<BucketAccessControl>open override fun listAcls(bucket: String?, obj: String?, generation: Long?): List<ObjectAccessControl> listDefaultAcls [jvm]open override fun listDefaultAcls(bucket: String?): MutableList<ObjectAccessControl> listHmacKeys [jvm]open override fun listHmacKeys(p0: MutableMap<StorageRpc.Option, *>?): Tuple<String, MutableIterable<HmacKeyMetadata>> listNotifications [jvm]open override fun listNotifications(bucket: String?): List<Notification> load [jvm]open override fun load(obj: StorageObject, options: Map<StorageRpc.Option, *>): ByteArray lockRetentionPolicy [jvm]open override fun lockRetentionPolicy(bucket: Bucket?, options: Map<StorageRpc.Option, *>?): Bucket open [jvm]open override fun open(signedURL: String?): Stringopen override fun open(obj: StorageObject, options: Map<StorageRpc.Option, *>): String openRewrite [jvm]open override fun openRewrite(request: StorageRpc.RewriteRequest): StorageRpc.RewriteResponse patch [jvm]open override fun patch(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?open override fun patch(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject? patchAcl [jvm]open override fun patchAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun patchAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl patchDefaultAcl [jvm]open override fun patchDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl read [jvm]open override fun read(from: StorageObject?, options: Map<StorageRpc.Option, *>?, position: Long, bytes: Int): Tuple<String, ByteArray>open override fun read(from: StorageObject, options: Map<StorageRpc.Option, *>, zposition: Long, outputStream: OutputStream): Long setIamPolicy [jvm]open override fun setIamPolicy(bucket: String?, policy: Policy?, options: Map<StorageRpc.Option, *>?): Policy testIamPermissions [jvm]open override fun testIamPermissions(bucket: String, permissions: List<String>, options: Map<StorageRpc.Option, *>): TestIamPermissionsResponse updateHmacKey [jvm]open override fun updateHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata write [jvm]open override fun write(uploadId: String, toWrite: ByteArray, toWriteOffset: Int, destOffset: Long, length: Int, last: Boolean) writeWithResponse [jvm]open override fun writeWithResponse(p0: String?, p1: ByteArray?, p2: Int, p3: Long, p4: Int, p5: Boolean): StorageObject"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/-local-storage-rpc/","title":"LocalStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/LocalStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/-local-storage-rpc/#localstoragerpc","title":"LocalStorageRpc","text":"[jvm]\\
@JvmOverloads
constructor(root: Path, moshi: Moshi = defaultKotlinMoshi)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/create/","title":"create - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/create
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/create/#create","title":"create","text":"[jvm]\\ open override fun create(obj: StorageObject, content: InputStream, options: Map<StorageRpc.Option, *>): StorageObject?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/delete/","title":"delete - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/delete
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/delete/#delete","title":"delete","text":"[jvm]\\ open override fun delete(obj: StorageObject, options: Map<StorageRpc.Option, *>): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/get/","title":"get - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/get
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/list/","title":"list - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/list
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/list/#list","title":"list","text":"[jvm]\\ open override fun list(bucket: String, options: Map<StorageRpc.Option, *>): Tuple<String, Iterable<StorageObject>>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/load/","title":"load - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/load
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/load/#load","title":"load","text":"[jvm]\\ open override fun load(obj: StorageObject, options: Map<StorageRpc.Option, *>): ByteArray
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open-rewrite/","title":"openRewrite - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/openRewrite
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open-rewrite/#openrewrite","title":"openRewrite","text":"[jvm]\\ open override fun openRewrite(request: StorageRpc.RewriteRequest): StorageRpc.RewriteResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open/","title":"open - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/open
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open/#open","title":"open","text":"[jvm]\\ open override fun open(obj: StorageObject, options: Map<StorageRpc.Option, *>): String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/read/","title":"read - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/read
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/read/#read","title":"read","text":"[jvm]\\ open override fun read(from: StorageObject, options: Map<StorageRpc.Option, *>, zposition: Long, outputStream: OutputStream): Long
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/write/","title":"write - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/write
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/write/#write","title":"write","text":"[jvm]\\ open override fun write(uploadId: String, toWrite: ByteArray, toWriteOffset: Int, destOffset: Long, length: Int, last: Boolean)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/","title":"StorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/#storageconfig","title":"StorageConfig","text":"[jvm]\\ data class StorageConfig@JvmOverloadsconstructor(val use_local_storage: Boolean = false, val local_storage: LocalStorageConfig? = null, val transport: TransportConfig = TransportConfig()) : Config
Configuration for talking to Google Cloud Storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/#constructors","title":"Constructors","text":"StorageConfig [jvm]@JvmOverloadsconstructor(use_local_storage: Boolean = false, local_storage: LocalStorageConfig? = null, transport: TransportConfig = TransportConfig())"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/#properties","title":"Properties","text":"Name Summary local_storage [jvm]val local_storage: LocalStorageConfig? = null transport [jvm]val transport: TransportConfig use_local_storage [jvm]val use_local_storage: Boolean = false"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/-storage-config/","title":"StorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/StorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/-storage-config/#storageconfig","title":"StorageConfig","text":"[jvm]\\
@JvmOverloads
constructor(use_local_storage: Boolean = false, local_storage: LocalStorageConfig? = null, transport: TransportConfig = TransportConfig())
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/local_storage/","title":"local_storage - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/local_storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/local_storage/#local_storage","title":"local_storage","text":"[jvm]\\ val local_storage: LocalStorageConfig? = null
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/transport/","title":"transport - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/transport
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/transport/#transport","title":"transport","text":"[jvm]\\ val transport: TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/use_local_storage/","title":"use_local_storage - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/use_local_storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/use_local_storage/#use_local_storage","title":"use_local_storage","text":"[jvm]\\ val use_local_storage: Boolean = false
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/#types","title":"Types","text":"Name Summary TracingLoggingEnhancer [jvm]class TracingLoggingEnhancer : LoggingEnhancerAdd this enhancer to your project\u2019s Logback configuration to add trace ids to logs generated by GCP\u2019s LoggingAppender"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/","title":"TracingLoggingEnhancer - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing/TracingLoggingEnhancer
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/#tracingloggingenhancer","title":"TracingLoggingEnhancer","text":"[jvm]\\ class TracingLoggingEnhancer : LoggingEnhancer
Add this enhancer to your project\u2019s Logback configuration to add trace ids to logs generated by GCP\u2019s LoggingAppender
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/#constructors","title":"Constructors","text":"TracingLoggingEnhancer [jvm]constructor()"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/#functions","title":"Functions","text":"Name Summary enhanceLogEntry [jvm]open override fun enhanceLogEntry(builder: LogEntry.Builder)fun enhanceLogEntry(tracer: Tracer, builder: LogEntry.Builder)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/-tracing-logging-enhancer/","title":"TracingLoggingEnhancer - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing/TracingLoggingEnhancer/TracingLoggingEnhancer
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/-tracing-logging-enhancer/#tracingloggingenhancer","title":"TracingLoggingEnhancer","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/enhance-log-entry/","title":"enhanceLogEntry - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing/TracingLoggingEnhancer/enhanceLogEntry
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/enhance-log-entry/#enhancelogentry","title":"enhanceLogEntry","text":"[jvm]\\ open override fun enhanceLogEntry(builder: LogEntry.Builder)
fun enhanceLogEntry(tracer: Tracer, builder: LogEntry.Builder)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.logging
"},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/#functions","title":"Functions","text":"Name Summary enableStackDriverLogging [jvm]fun enableStackDriverLogging(config: StackDriverLoggingConfig)Configures Misk to send application logs to StackDriver. If credentials are required to send logging, set the GOOGLE_APPLICATION_CREDENTIALS environment variable with the path to the JSON credentials."},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/enable-stack-driver-logging/","title":"enableStackDriverLogging - Misk","text":"//misk-gcp/misk.logging/enableStackDriverLogging
"},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/enable-stack-driver-logging/#enablestackdriverlogging","title":"enableStackDriverLogging","text":"[jvm]\\ fun enableStackDriverLogging(config: StackDriverLoggingConfig)
Configures Misk to send application logs to StackDriver. If credentials are required to send logging, set the GOOGLE_APPLICATION_CREDENTIALS environment variable with the path to the JSON credentials.
"},{"location":"0.x/misk-grpc-reflect/","title":"misk-grpc-reflect - Misk","text":"//misk-grpc-reflect
"},{"location":"0.x/misk-grpc-reflect/#misk-grpc-reflect","title":"misk-grpc-reflect","text":""},{"location":"0.x/misk-grpc-reflect/#packages","title":"Packages","text":"Name misk.grpc.reflect"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/","title":"Package-level declarations - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/#types","title":"Types","text":"Name Summary GrpcReflectModule [jvm]class GrpcReflectModule : KAbstractModuleImplements gRPC reflect for all gRPC actions installed in this Misk application. ServerReflectionApi [jvm]class ServerReflectionApi@Injectconstructor(reflector: SchemaReflector) : ServerReflectionServerReflectionInfoBlockingServer, WebAction"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/","title":"GrpcReflectModule - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/#grpcreflectmodule","title":"GrpcReflectModule","text":"[jvm]\\ class GrpcReflectModule : KAbstractModule
Implements gRPC reflect for all gRPC actions installed in this Misk application.
This relies on .proto files being included in the .jar file. If they\u2019re missing, reflection won\u2019t work for them.
//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/GrpcReflectModule
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/-grpc-reflect-module/#grpcreflectmodule","title":"GrpcReflectModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-schema/","title":"provideSchema - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/provideSchema
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-schema/#provideschema","title":"provideSchema","text":"[jvm]\\
@Provides
@Singleton
fun provideSchema(webActions: List<WebActionEntry>): Schema
Interrogate the installed gRPC actions and create a Wire schema from that.
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-service-reflector/","title":"provideServiceReflector - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/provideServiceReflector
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-service-reflector/#provideservicereflector","title":"provideServiceReflector","text":"[jvm]\\
@Provides
@Singleton
fun provideServiceReflector(schema: Schema): SchemaReflector
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/-companion/","title":"Companion - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/Companion
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/","title":"ServerReflectionApi - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/ServerReflectionApi
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/#serverreflectionapi","title":"ServerReflectionApi","text":"[jvm]\\ class ServerReflectionApi@Injectconstructor(reflector: SchemaReflector) : ServerReflectionServerReflectionInfoBlockingServer, WebAction
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/#constructors","title":"Constructors","text":"ServerReflectionApi [jvm]@Injectconstructor(reflector: SchemaReflector)"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/#functions","title":"Functions","text":"Name Summary ServerReflectionInfo [jvm]open override fun ServerReflectionInfo(requests: MessageSource<ServerReflectionRequest>, responses: MessageSink<ServerReflectionResponse>)The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server."},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-api/","title":"ServerReflectionApi - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/ServerReflectionApi/ServerReflectionApi
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-api/#serverreflectionapi","title":"ServerReflectionApi","text":"[jvm]\\
@Inject
constructor(reflector: SchemaReflector)
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-info/","title":"ServerReflectionInfo - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/ServerReflectionApi/ServerReflectionInfo
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-info/#serverreflectioninfo","title":"ServerReflectionInfo","text":"[jvm]\\ open override fun ServerReflectionInfo(requests: MessageSource<ServerReflectionRequest>, responses: MessageSink<ServerReflectionResponse>)
The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server.
"},{"location":"0.x/misk-grpc-tests/","title":"misk-grpc-tests - Misk","text":"//misk-grpc-tests
"},{"location":"0.x/misk-grpc-tests/#misk-grpc-tests","title":"misk-grpc-tests","text":""},{"location":"0.x/misk-grpc-tests/#packages","title":"Packages","text":"Name misk.grpc.miskclient misk.grpc.miskserver misk.grpc.protocclient misk.grpc.protocserver"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/#types","title":"Types","text":"Name Summary MiskGrpcClientModule [jvm]class MiskGrpcClientModule(val url: HttpUrl) : KAbstractModule RouteGuideCallCounter [jvm]@Singletonclass RouteGuideCallCounter@Injectconstructor : ClientNetworkInterceptor.FactorySample network interceptor to confirm they\u2019re executed for outbound gRPC calls."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/","title":"MiskGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#miskgrpcclientmodule","title":"MiskGrpcClientModule","text":"[jvm]\\ class MiskGrpcClientModule(val url: HttpUrl) : KAbstractModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#constructors","title":"Constructors","text":"MiskGrpcClientModule [jvm]constructor(url: HttpUrl)"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#properties","title":"Properties","text":"Name Summary url [jvm]val url: HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideHttpClientsConfig [jvm]@Provides@Singletonfun provideHttpClientsConfig(): HttpClientsConfig"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/-misk-grpc-client-module/","title":"MiskGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule/MiskGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/-misk-grpc-client-module/#miskgrpcclientmodule","title":"MiskGrpcClientModule","text":"[jvm]\\ constructor(url: HttpUrl)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/provide-http-clients-config/","title":"provideHttpClientsConfig - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule/provideHttpClientsConfig
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/provide-http-clients-config/#providehttpclientsconfig","title":"provideHttpClientsConfig","text":"[jvm]\\
@Provides
@Singleton
fun provideHttpClientsConfig(): HttpClientsConfig
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/url/","title":"url - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule/url
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/url/#url","title":"url","text":"[jvm]\\ val url: HttpUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/","title":"RouteGuideCallCounter - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#routeguidecallcounter","title":"RouteGuideCallCounter","text":"[jvm]\\ @Singleton
class RouteGuideCallCounter@Injectconstructor : ClientNetworkInterceptor.Factory
Sample network interceptor to confirm they\u2019re executed for outbound gRPC calls.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#constructors","title":"Constructors","text":"RouteGuideCallCounter [jvm]@Injectconstructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#properties","title":"Properties","text":"Name Summary actionNameToCount [jvm]val actionNameToCount: MutableMap<String, AtomicInteger>"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#functions","title":"Functions","text":"Name Summary counter [jvm]fun counter(name: String): AtomicInteger create [jvm]open override fun create(action: ClientAction): ClientNetworkInterceptor?"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/-route-guide-call-counter/","title":"RouteGuideCallCounter - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/RouteGuideCallCounter
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/-route-guide-call-counter/#routeguidecallcounter","title":"RouteGuideCallCounter","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/action-name-to-count/","title":"actionNameToCount - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/actionNameToCount
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/action-name-to-count/#actionnametocount","title":"actionNameToCount","text":"[jvm]\\ val actionNameToCount: MutableMap<String, AtomicInteger>
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/counter/","title":"counter - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/counter
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/counter/#counter","title":"counter","text":"[jvm]\\ fun counter(name: String): AtomicInteger
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/create/","title":"create - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/create
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: ClientAction): ClientNetworkInterceptor?
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/#types","title":"Types","text":"Name Summary GetFeatureGrpcAction [jvm]class GetFeatureGrpcAction@Injectconstructor : WebAction, RouteGuideGetFeatureBlockingServer RouteChatGrpcAction [jvm]@Singletonclass RouteChatGrpcAction@Injectconstructor : WebAction, RouteGuideRouteChatBlockingServer RouteGuideMiskServiceModule [jvm]class RouteGuideMiskServiceModule : KAbstractModuleA module that runs a Misk gRPC server: Wire protos and a Jetty backend."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/","title":"GetFeatureGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/GetFeatureGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/#getfeaturegrpcaction","title":"GetFeatureGrpcAction","text":"[jvm]\\ class GetFeatureGrpcAction@Injectconstructor : WebAction, RouteGuideGetFeatureBlockingServer
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/#constructors","title":"Constructors","text":"GetFeatureGrpcAction [jvm]@Injectconstructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/#functions","title":"Functions","text":"Name Summary GetFeature [jvm]open override fun GetFeature(request: Point): FeatureA simple RPC."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature-grpc-action/","title":"GetFeatureGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/GetFeatureGrpcAction/GetFeatureGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature-grpc-action/#getfeaturegrpcaction","title":"GetFeatureGrpcAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature/","title":"GetFeature - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/GetFeatureGrpcAction/GetFeature
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature/#getfeature","title":"GetFeature","text":"[jvm]\\ open override fun GetFeature(request: Point): Feature
A simple RPC.
Obtains the feature at a given position.
A feature with an empty name is returned if there\u2019s no feature at the given position.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/","title":"RouteChatGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#routechatgrpcaction","title":"RouteChatGrpcAction","text":"[jvm]\\ @Singleton
class RouteChatGrpcAction@Injectconstructor : WebAction, RouteGuideRouteChatBlockingServer
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#constructors","title":"Constructors","text":"RouteChatGrpcAction [jvm]@Injectconstructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#properties","title":"Properties","text":"Name Summary welcomeMessage [jvm]var welcomeMessage: String?"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#functions","title":"Functions","text":"Name Summary RouteChat [jvm]open override fun RouteChat(request: MessageSource<RouteNote>, response: MessageSink<RouteNote>)A Bidirectional streaming RPC."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat-grpc-action/","title":"RouteChatGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction/RouteChatGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat-grpc-action/#routechatgrpcaction","title":"RouteChatGrpcAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat/","title":"RouteChat - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction/RouteChat
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat/#routechat","title":"RouteChat","text":"[jvm]\\ open override fun RouteChat(request: MessageSource<RouteNote>, response: MessageSink<RouteNote>)
A Bidirectional streaming RPC.
Accepts a stream of RouteNotes sent while a route is being traversed, while receiving other RouteNotes (e.g. from other users).
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/welcome-message/","title":"welcomeMessage - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction/welcomeMessage
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/welcome-message/#welcomemessage","title":"welcomeMessage","text":"[jvm]\\ var welcomeMessage: String?
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/","title":"RouteGuideMiskServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteGuideMiskServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/#routeguidemiskservicemodule","title":"RouteGuideMiskServiceModule","text":"[jvm]\\ class RouteGuideMiskServiceModule : KAbstractModule
A module that runs a Misk gRPC server: Wire protos and a Jetty backend.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/#constructors","title":"Constructors","text":"RouteGuideMiskServiceModule [jvm]constructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideServerUrl [jvm]@Provides@Named(value = \"grpc server\")fun provideServerUrl(jetty: JettyService): HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/-route-guide-misk-service-module/","title":"RouteGuideMiskServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteGuideMiskServiceModule/RouteGuideMiskServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/-route-guide-misk-service-module/#routeguidemiskservicemodule","title":"RouteGuideMiskServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/provide-server-url/","title":"provideServerUrl - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteGuideMiskServiceModule/provideServerUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/provide-server-url/#provideserverurl","title":"provideServerUrl","text":"[jvm]\\
@Provides
@Named(value = \"grpc server\")
fun provideServerUrl(jetty: JettyService): HttpUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/#types","title":"Types","text":"Name Summary GrpcChannelFactory [jvm]@Singletonclass GrpcChannelFactory@Injectconstructor(val resourceLoader: ResourceLoader) ProtocGrpcClientModule [jvm]class ProtocGrpcClientModule : KAbstractModule"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/","title":"GrpcChannelFactory - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#grpcchannelfactory","title":"GrpcChannelFactory","text":"[jvm]\\ @Singleton
class GrpcChannelFactory@Injectconstructor(val resourceLoader: ResourceLoader)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#constructors","title":"Constructors","text":"GrpcChannelFactory [jvm]@Injectconstructor(resourceLoader: ResourceLoader)"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#properties","title":"Properties","text":"Name Summary resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#functions","title":"Functions","text":"Name Summary createClientChannel [jvm]@JvmOverloadsfun createClientChannel(serverAddress: SocketAddress, serverCertResource: String = \"classpath:/ssl/server_cert.pem\"): ManagedChannel"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/-grpc-channel-factory/","title":"GrpcChannelFactory - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory/GrpcChannelFactory
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/-grpc-channel-factory/#grpcchannelfactory","title":"GrpcChannelFactory","text":"[jvm]\\
@Inject
constructor(resourceLoader: ResourceLoader)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/create-client-channel/","title":"createClientChannel - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory/createClientChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/create-client-channel/#createclientchannel","title":"createClientChannel","text":"[jvm]\\
@JvmOverloads
fun createClientChannel(serverAddress: SocketAddress, serverCertResource: String = \"classpath:/ssl/server_cert.pem\"): ManagedChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/resource-loader/","title":"resourceLoader - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory/resourceLoader
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/","title":"ProtocGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/ProtocGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/#protocgrpcclientmodule","title":"ProtocGrpcClientModule","text":"[jvm]\\ class ProtocGrpcClientModule : KAbstractModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/#constructors","title":"Constructors","text":"ProtocGrpcClientModule [jvm]constructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideChannel [jvm]@Provides@Singletonfun provideChannel(@Named(value = \"grpc server\")url: HttpUrl, grpcChannelFactory: GrpcChannelFactory): ManagedChannel"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/-protoc-grpc-client-module/","title":"ProtocGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/ProtocGrpcClientModule/ProtocGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/-protoc-grpc-client-module/#protocgrpcclientmodule","title":"ProtocGrpcClientModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/provide-channel/","title":"provideChannel - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/ProtocGrpcClientModule/provideChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/provide-channel/#providechannel","title":"provideChannel","text":"[jvm]\\
@Provides
@Singleton
fun provideChannel(@Named(value = \"grpc server\")url: HttpUrl, grpcChannelFactory: GrpcChannelFactory): ManagedChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/#types","title":"Types","text":"Name Summary ProtocGrpcService [jvm]@Singletonclass ProtocGrpcService@Injectconstructor(services: List<BindableService>, resourceLoader: ResourceLoader) : AbstractIdleServiceRuns a standard gRPC server: generated protoc protos and a Netty backend. This isn\u2019t how Misk does gRPC, but it should be useful to confirm interoperability. RouteGuideProtocServiceModule [jvm]class RouteGuideProtocServiceModule : KAbstractModuleA module that runs a standard gRPC server: generated protoc protos and a Netty backend."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/","title":"ProtocGrpcService - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#protocgrpcservice","title":"ProtocGrpcService","text":"[jvm]\\ @Singleton
class ProtocGrpcService@Injectconstructor(services: List<BindableService>, resourceLoader: ResourceLoader) : AbstractIdleService
Runs a standard gRPC server: generated protoc protos and a Netty backend. This isn\u2019t how Misk does gRPC, but it should be useful to confirm interoperability.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#constructors","title":"Constructors","text":"ProtocGrpcService [jvm]@Injectconstructor(services: List<BindableService>, resourceLoader: ResourceLoader)"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#properties","title":"Properties","text":"Name Summary server [jvm]lateinit var server: Server url [jvm]val url: HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/-protoc-grpc-service/","title":"ProtocGrpcService - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService/ProtocGrpcService
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/-protoc-grpc-service/#protocgrpcservice","title":"ProtocGrpcService","text":"[jvm]\\
@Inject
constructor(services: List<BindableService>, resourceLoader: ResourceLoader)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/server/","title":"server - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService/server
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/server/#server","title":"server","text":"[jvm]\\ lateinit var server: Server
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/url/","title":"url - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService/url
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/url/#url","title":"url","text":"[jvm]\\ val url: HttpUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/","title":"RouteGuideProtocServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/RouteGuideProtocServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/#routeguideprotocservicemodule","title":"RouteGuideProtocServiceModule","text":"[jvm]\\ class RouteGuideProtocServiceModule : KAbstractModule
A module that runs a standard gRPC server: generated protoc protos and a Netty backend.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/#constructors","title":"Constructors","text":"RouteGuideProtocServiceModule [jvm]constructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideServerUrl [jvm]@Provides@Named(value = \"grpc server\")fun provideServerUrl(protocGrpcService: ProtocGrpcService): HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/-route-guide-protoc-service-module/","title":"RouteGuideProtocServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/RouteGuideProtocServiceModule/RouteGuideProtocServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/-route-guide-protoc-service-module/#routeguideprotocservicemodule","title":"RouteGuideProtocServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/provide-server-url/","title":"provideServerUrl - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/RouteGuideProtocServiceModule/provideServerUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/provide-server-url/#provideserverurl","title":"provideServerUrl","text":"[jvm]\\
@Provides
@Named(value = \"grpc server\")
fun provideServerUrl(protocGrpcService: ProtocGrpcService): HttpUrl
"},{"location":"0.x/misk-hibernate/","title":"misk-hibernate - Misk","text":"//misk-hibernate
"},{"location":"0.x/misk-hibernate/#misk-hibernate","title":"misk-hibernate","text":""},{"location":"0.x/misk-hibernate/#packages","title":"Packages","text":"Name misk.hibernate misk.hibernate.annotation misk.hibernate.migrate misk.hibernate.pagination"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/#types","title":"Types","text":"Name Summary AggregationType [jvm]enum AggregationType : Enum<AggregationType> Available aggregations which can be applied to a single value Select query, or a Property of a projection. BindPolicy [jvm]enum BindPolicy : Enum<BindPolicy> Control how we register listeners. Check [jvm]typealias Check = misk.jdbc.Check Constraint [jvm]annotation class Constraint(val path: String, val operator: Operator = Operator.EQ)Annotates a function on a Query interface to indicate which column (or path of columns) it constrains and using which Operator. DbChild [jvm]interface DbChild<R : DbRoot<R>, T : DbChild<R, T>> : DbSharded<R, T> Marker interface for sharded entities that stay with their root inside an entity group. Entity group children will always stay inside the same shard regardless of shard splits and so on. That means transactions inside an entity group is always safe. A typical sharding strategy has aDbCustomer as a root and all of the entities that belong to that customer as children. DbEntity [jvm]interface DbEntity<T : DbEntity<T>>Marker interface for persistent entities. Ensures that only persistent entities can be passed into Session methods. DbRoot [jvm]interface DbRoot<T : DbRoot<T>> : DbSharded<T, T> Marker interface for sharded entity group roots. Entity group roots are spread out across shards they can also have children in the form of DbChild subclasses that always stay in the same shard as their roots. A typical root is for example DbCustomer. DbSharded [jvm]interface DbSharded<R : DbRoot<R>, T : DbSharded<R, T>> : DbEntity<T> Marker interface for sharded persistent entities. Do not subclass directly, instead subclass either DbRoot for entity group roots or DbChild for entity group children. DbTimestampedEntity [jvm]interface DbTimestampedEntityThis complements DbEntity for entities that keep updated_at and created_at timestamps. DbUnsharded [jvm]interface DbUnsharded<T : DbUnsharded<T>> : DbEntity<T> Marker interface for persistent entities that have a bounded growth and do not require sharding. Fetch [jvm]annotation class Fetch(val path: String = \"\", val joinType: JoinType = LEFT, val forProjection: Boolean = false)Annotates a function on a Query interface to specify that the association at the given path should be fetched in a single query. The type of join used will be specified by joinType, and defaults to a LEFT JOIN. Gid [jvm]@Embeddabledata class Gid<R : DbRoot<R>, T : DbSharded<R, T>>(val rootId: Id<R>, val id: Id<T>) : SerializableEntity group id, maps to two long columns one for the root id and one for the row GidGenerator [jvm]class GidGenerator : AbstractPostInsertGenerator, Configurable Group [jvm]annotation class Group(val paths: Array<String> = [])Annotates a function on a Query interface to indicate that the results should be grouped by the given paths. This is most useful with Projections and aggregations. HibernateEntityModule [jvm]abstract class HibernateEntityModule(qualifier: KClass<out Annotation>) : KAbstractModuleBinds hibernate entities and event listeners intended for the Transacter annotated by qualifier. HibernateExceptionLogLevelConfig [jvm]data class HibernateExceptionLogLevelConfig@JvmOverloadsconstructor(val log_level: Level = Level.WARN) : ConfigConfigures the log Level for a HibernateException. HibernateModule [jvm]class HibernateModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig()) : KAbstractModule Id [jvm]data class Id<T : DbEntity<T>>(val id: Long) : Serializable, Comparable<Id<T>> Type-safe persistent identifier, mapped to a long column. IdType [jvm]class IdType : UserType, ResultSetIdentifierConsumerBinds Id<*> in the DB to a bigint in MySQL. JsonColumn [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class JsonColumnPut this on a column field to get Hibernate to persist it as JSON using Moshi. It will use the injector\u2019s configured Moshi instance. Use misk.moshi.MoshiModule to customize. Operator [jvm]enum Operator : Enum<Operator> OrBuilder [jvm]interface OrBuilder<Q : Query<*>>This functional interface accepts a set of options. Each option lambda is executed within the scope of a query. It is inappropriate to call methods like list() and uniqueResult() on this query. Order [jvm]annotation class Order(val path: String, val asc: Boolean = true)Annotates a function on a Query interface to indicate by which columns to order the results. Defaults to ascending order. Path [jvm]data class Path(val schema: String?, val table: String?, val column: String?) PostCommitHookFailedException [jvm]class PostCommitHookFailedException(cause: Throwable) : ExceptionPostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook Projection [jvm]interface ProjectionMarker interface for query projections. Property [jvm]annotation class Property(val path: String, val aggregation: AggregationType = AggregationType.NONE)Annotates a parameter of a Projection data class to indicate which column (or path of columns) to populate the parameter with. ProtoColumn [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class ProtoColumnPut this on a column field for a class generated by Wire to get Hibernate to persist with protobuf serialization. Query [jvm]interface Query<T>Base class for SQL queries. RetryTransactionException [jvm]class RetryTransactionException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : ExceptionThrown to explicitly trigger a retry, subject to retry limits and config such as noRetries(). SecretColumn [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class SecretColumn(val keyName: String, val indexable: Boolean = true)SecretColumn is an annotation used to get Hibernate to encrypt a field before writing it to the database. Select [jvm]annotation class Select(val path: String = \"\", val aggregation: AggregationType = AggregationType.NONE)Annotates a function on a Query interface to execute a SELECT query. Functions with this annotation must return a List to fetch multiple rows results, or a regular type to fetch a unique result. Session [jvm]interface Session : Session Transacter [jvm]interface TransacterProvides explicit block-based transaction demarcation. TransacterService [jvm]interface TransacterService : ServiceMarker interface for services that provide database transactors. TransformedType [jvm]@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])annotation class TransformedType(val transformer: KClass<out Transformer>, val targetType: KClass<*>)TransformedType is a meta-annotation for assigning arbitrary transformers to entity fields. Use it to annotate attributes that will mark a field to be transformed. Transformer [jvm]abstract class Transformer(val context: TransformerContext) TransformerContext [jvm]data class TransformerContext(val tableName: String, val columnName: String, var arguments: Map<String, >, var field: KClass<>) ValidationReport [jvm]data class ValidationReport(val schemas: Set<String>, val tables: Set<String>, val columns: Set<String>) VitessDialect [jvm]class VitessDialect : MySQL57Dialect"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/#functions","title":"Functions","text":"Name Summary allowFullScatter [jvm]inline fun <T, Q : Query<T>> Q.allowFullScatter(): Q allowTableScan [jvm]inline fun <T, Q : Query<T>> Q.allowTableScan(): Q constraint [jvm]fun <T, Q : Query<T>> Q.constraint(block: CriteriaBuilder.(root: Root<*>) -> Predicate): QEquivalent to Query.addConstraint, but takes the CriteriaBuilder as a receiver and returns this. This may be easier to use with method chaining. failSafeRead [jvm]fun <T> Transacter.failSafeRead(block: (session: Session) -> T): TRuns a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.[jvm]fun <T> Transacter.failSafeRead(shard: Shard, block: (session: Session) -> T): T getByType [jvm]fun ResultSet.getByType(klass: KClass<*>?, columnLabel: String): Serializable? load [jvm]inline fun <T : DbEntity<T>> Session.load(id: Id<T>): T loadOrNull [jvm]inline fun <T : DbEntity<T>> Session.loadOrNull(id: Id<T>): T? loadSharded [jvm]inline fun <R : DbRoot<R>, S : DbSharded<R, S>> Session.loadSharded(gid: Gid<R, S>): S newQuery [jvm]inline fun <T : Query<*>> Query.Factory.newQuery(): T or [jvm]inline fun <T, Q : Query<T>> Q.or(lambda: OrBuilder<Q>.() -> Unit): QCollects options that are all OR\u2019d together. If any are true the predicate matches. queryHint [jvm]fun <T, Q : Query<T>> Q.queryHint(hint: String): QAdds query hint to the query. (Chainable version of Query.addQueryHint.) setByType [jvm]fun PreparedStatement.setByType(klass: KClass<*>?, index: Int, value: Any) shards [jvm]fun Transacter.shards(): Set<Shard>fun Transacter.shards(keyspace: Keyspace): Collection<Shard> transaction [jvm]fun <T> Transacter.transaction(shard: Shard, block: (session: Session) -> T): TCommits a transaction with operations of block."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-full-scatter/","title":"allowFullScatter - Misk","text":"//misk-hibernate/misk.hibernate/allowFullScatter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-full-scatter/#allowfullscatter","title":"allowFullScatter","text":"[jvm]\\ inline fun <T, Q : Query<T>> Q.allowFullScatter(): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-table-scan/","title":"allowTableScan - Misk","text":"//misk-hibernate/misk.hibernate/allowTableScan
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-table-scan/#allowtablescan","title":"allowTableScan","text":"[jvm]\\ inline fun <T, Q : Query<T>> Q.allowTableScan(): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/constraint/","title":"constraint - Misk","text":"//misk-hibernate/misk.hibernate/constraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/constraint/#constraint","title":"constraint","text":"[jvm]\\ fun <T, Q : Query<T>> Q.constraint(block: CriteriaBuilder.(root: Root<*>) -> Predicate): Q
Equivalent to Query.addConstraint, but takes the CriteriaBuilder as a receiver and returns this. This may be easier to use with method chaining.
The root parameter should be used to select which property of the target entity to match against.
queryFactory.newQuery<OperatorsMovieQuery>()\n .constraint { root -> like(root.get(\"name\"), \"Jurassic%\") }\n .count(session)\n//misk-hibernate/misk.hibernate/failSafeRead
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/fail-safe-read/#failsaferead","title":"failSafeRead","text":"[jvm]\\ fun <T> Transacter.failSafeRead(block: (session: Session) -> T): T
Runs a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.
[jvm]\\ fun <T> Transacter.failSafeRead(shard: Shard, block: (session: Session) -> T): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/get-by-type/","title":"getByType - Misk","text":"//misk-hibernate/misk.hibernate/getByType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/get-by-type/#getbytype","title":"getByType","text":"[jvm]\\ fun ResultSet.getByType(klass: KClass<*>?, columnLabel: String): Serializable?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-or-null/","title":"loadOrNull - Misk","text":"//misk-hibernate/misk.hibernate/loadOrNull
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-or-null/#loadornull","title":"loadOrNull","text":"[jvm]\\ inline fun <T : DbEntity<T>> Session.loadOrNull(id: Id<T>): T?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-sharded/","title":"loadSharded - Misk","text":"//misk-hibernate/misk.hibernate/loadSharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-sharded/#loadsharded","title":"loadSharded","text":"[jvm]\\ inline fun <R : DbRoot<R>, S : DbSharded<R, S>> Session.loadSharded(gid: Gid<R, S>): S
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load/","title":"load - Misk","text":"//misk-hibernate/misk.hibernate/load
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load/#load","title":"load","text":"[jvm]\\ inline fun <T : DbEntity<T>> Session.load(id: Id<T>): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/new-query/","title":"newQuery - Misk","text":"//misk-hibernate/misk.hibernate/newQuery
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/new-query/#newquery","title":"newQuery","text":"[jvm]\\ inline fun <T : Query<*>> Query.Factory.newQuery(): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/or/","title":"or - Misk","text":"//misk-hibernate/misk.hibernate/or
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/or/#or","title":"or","text":"[jvm]\\ inline fun <T, Q : Query<T>> Q.or(lambda: OrBuilder<Q>.() -> Unit): Q
Collects options that are all OR\u2019d together. If any are true the predicate matches.
queryFactory.newQuery<OperatorsMovieQuery>()\n .or {\n option { name(\"Rocky 1\") }\n option { name(\"Rocky 3\") }\n }\n .list()\nEach option has a list of constraints that are themselves AND\u2019d together.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/query-hint/","title":"queryHint - Misk","text":"//misk-hibernate/misk.hibernate/queryHint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/query-hint/#queryhint","title":"queryHint","text":"[jvm]\\ fun <T, Q : Query<T>> Q.queryHint(hint: String): Q
Adds query hint to the query. (Chainable version of Query.addQueryHint.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/set-by-type/","title":"setByType - Misk","text":"//misk-hibernate/misk.hibernate/setByType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/set-by-type/#setbytype","title":"setByType","text":"[jvm]\\ fun PreparedStatement.setByType(klass: KClass<*>?, index: Int, value: Any)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/shards/","title":"shards - Misk","text":"//misk-hibernate/misk.hibernate/shards
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/shards/#shards","title":"shards","text":"[jvm]\\ fun Transacter.shards(): Set<Shard>
fun Transacter.shards(keyspace: Keyspace): Collection<Shard>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/transaction/","title":"transaction - Misk","text":"//misk-hibernate/misk.hibernate/transaction
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/transaction/#transaction","title":"transaction","text":"[jvm]\\ fun <T> Transacter.transaction(shard: Shard, block: (session: Session) -> T): T
Commits a transaction with operations of block.
New objects must be persisted with an explicit call to Session.save. Updates are performed implicitly by modifying objects returned from a query.
For example if we were to save a new movie to a movie database, and update the revenue of an existing movie:
transacter.transaction { session ->\n // Saving a new entity to the database needs an explicit call.\n val starWars = DbMovie(name = \"Star Wars\", year = \"1977\", revenue = 775_400_000)\n session.save(starWars)\n\n // Updating a movie from the database is done by modifying the object.\n // Changes are saved implicitly.\n val movie: DbMovie = queryFactory.newQuery<MovieQuery>().id(id).uniqueResult(session)!!\n movie.revenue = 100_000_000\n}\n//misk-hibernate/misk.hibernate/AggregationType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#aggregationtype","title":"AggregationType","text":"[jvm]\\ enum AggregationType : Enum<AggregationType>
Available aggregations which can be applied to a single value Select query, or a Property of a projection.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#entries","title":"Entries","text":"NONE [jvm]NONENo aggregation is applied. Likeselect column. AVG [jvm]AVGLike select avg(column). COUNT [jvm]COUNTLike select count(column). COUNT_DISTINCT [jvm]COUNT_DISTINCTLike select count(distinct column). MAX [jvm]MAXLike select max(column). MIN [jvm]MINLike select min(column). SUM [jvm]SUMLike select sum(column)."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AggregationType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AggregationTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AggregationType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/entries/","title":"entries - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/entries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AggregationType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/value-of/","title":"valueOf - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/valueOf
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AggregationType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/values/","title":"values - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/values
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AggregationType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-a-v-g/","title":"AVG - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/AVG
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-a-v-g/#avg","title":"AVG","text":"[jvm]\\ AVG
Like select avg(column).
//misk-hibernate/misk.hibernate/AggregationType/COUNT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-c-o-u-n-t/#count","title":"COUNT","text":"[jvm]\\ COUNT
Like select count(column).
//misk-hibernate/misk.hibernate/AggregationType/COUNT_DISTINCT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-c-o-u-n-t_-d-i-s-t-i-n-c-t/#count_distinct","title":"COUNT_DISTINCT","text":"[jvm]\\ COUNT_DISTINCT
Like select count(distinct column).
//misk-hibernate/misk.hibernate/AggregationType/MAX
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-m-a-x/#max","title":"MAX","text":"[jvm]\\ MAX
Like select max(column).
//misk-hibernate/misk.hibernate/AggregationType/MIN
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-m-i-n/#min","title":"MIN","text":"[jvm]\\ MIN
Like select min(column).
//misk-hibernate/misk.hibernate/AggregationType/NONE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-n-o-n-e/#none","title":"NONE","text":"[jvm]\\ NONE
No aggregation is applied. Like select column.
//misk-hibernate/misk.hibernate/AggregationType/SUM
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-s-u-m/#sum","title":"SUM","text":"[jvm]\\ SUM
Like select sum(column).
//misk-hibernate/misk.hibernate/BindPolicy
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#bindpolicy","title":"BindPolicy","text":"[jvm]\\ enum BindPolicy : Enum<BindPolicy>
Control how we register listeners.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#entries","title":"Entries","text":"PREPEND [jvm]PREPEND REPLACE [jvm]REPLACE APPEND [jvm]APPEND"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<BindPolicy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): BindPolicyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<BindPolicy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/entries/","title":"entries - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/entries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<BindPolicy>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/value-of/","title":"valueOf - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/valueOf
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): BindPolicy
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/values/","title":"values - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/values
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<BindPolicy>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-a-p-p-e-n-d/","title":"APPEND - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/APPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-a-p-p-e-n-d/#append","title":"APPEND","text":"[jvm]\\ APPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-a-p-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-p-r-e-p-e-n-d/","title":"PREPEND - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/PREPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-p-r-e-p-e-n-d/#prepend","title":"PREPEND","text":"[jvm]\\ PREPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-p-r-e-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-r-e-p-l-a-c-e/","title":"REPLACE - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/REPLACE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-r-e-p-l-a-c-e/#replace","title":"REPLACE","text":"[jvm]\\ REPLACE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-r-e-p-l-a-c-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-check/","title":"Check - Misk","text":"//misk-hibernate/misk.hibernate/Check
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-check/#check","title":"Check","text":"[jvm]\\ typealias Check = misk.jdbc.Check
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/","title":"Index","text":"//misk-hibernate/misk.hibernate/Constraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/#constraint","title":"Constraint","text":"[jvm]\\ annotation class Constraint(val path: String, val operator: Operator = Operator.EQ)
Annotates a function on a Query interface to indicate which column (or path of columns) it constrains and using which Operator.
You can think of Constraints as the rules used to build the where clause of a SQL query.
For example, you can query movies by title with a method like this:
@Constraint(path = \"name\") // Uses EQ as the default operator.\nfun matchesTitle(title: String): MovieQuery\nOr query for movies released after a certain date with a method like this:
@Constraint(path = \"release_date\", operator = Operator.GT)\nfun releasedAfter(date: LocalDate): MovieQuery\n//misk-hibernate/misk.hibernate/Constraint/operator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/operator/#operator","title":"operator","text":"[jvm]\\ val operator: Operator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Constraint/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-child/","title":"DbChild - Misk","text":"//misk-hibernate/misk.hibernate/DbChild
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-child/#dbchild","title":"DbChild","text":"[jvm]\\ interface DbChild<R : DbRoot<R>, T : DbChild<R, T>> : DbSharded<R, T>
Marker interface for sharded entities that stay with their root inside an entity group. Entity group children will always stay inside the same shard regardless of shard splits and so on. That means transactions inside an entity group is always safe. A typical sharding strategy has a DbCustomer as a root and all of the entities that belong to that customer as children.
//misk-hibernate/misk.hibernate/DbChild/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-child/id/#id","title":"id","text":"[jvm]\\ open override val id: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/","title":"DbEntity - Misk","text":"//misk-hibernate/misk.hibernate/DbEntity
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/#dbentity","title":"DbEntity","text":"interface DbEntity<T : DbEntity<T>>
Marker interface for persistent entities. Ensures that only persistent entities can be passed into Session methods.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/#inheritors","title":"Inheritors","text":"DbSharded DbUnsharded"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: Id<T>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/id/","title":"id - Misk","text":"//misk-hibernate/misk.hibernate/DbEntity/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/id/#id","title":"id","text":"[jvm]\\ abstract val id: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/","title":"DbRoot - Misk","text":"//misk-hibernate/misk.hibernate/DbRoot
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/#dbroot","title":"DbRoot","text":"[jvm]\\ interface DbRoot<T : DbRoot<T>> : DbSharded<T, T>
Marker interface for sharded entity group roots. Entity group roots are spread out across shards they can also have children in the form of DbChild subclasses that always stay in the same shard as their roots. A typical root is for example DbCustomer.
//misk-hibernate/misk.hibernate/DbRoot/gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/gid/#gid","title":"gid","text":"[jvm]\\ open override val gid: Gid<T, T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/root-id/","title":"rootId - Misk","text":"//misk-hibernate/misk.hibernate/DbRoot/rootId
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/root-id/#rootid","title":"rootId","text":"[jvm]\\ open override val rootId: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/","title":"DbSharded - Misk","text":"//misk-hibernate/misk.hibernate/DbSharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/#dbsharded","title":"DbSharded","text":"interface DbSharded<R : DbRoot<R>, T : DbSharded<R, T>> : DbEntity<T>
Marker interface for sharded persistent entities. Do not subclass directly, instead subclass either DbRoot for entity group roots or DbChild for entity group children.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/#inheritors","title":"Inheritors","text":"DbChild DbRoot"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/#properties","title":"Properties","text":"Name Summary gid [jvm]abstract val gid: Gid<R, T> id [jvm]abstract val id: Id<T> rootId [jvm]abstract val rootId: Id<R>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/gid/","title":"gid - Misk","text":"//misk-hibernate/misk.hibernate/DbSharded/gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/gid/#gid","title":"gid","text":"[jvm]\\ abstract val gid: Gid<R, T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/root-id/","title":"rootId - Misk","text":"//misk-hibernate/misk.hibernate/DbSharded/rootId
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/root-id/#rootid","title":"rootId","text":"[jvm]\\ abstract val rootId: Id<R>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/","title":"DbTimestampedEntity - Misk","text":"//misk-hibernate/misk.hibernate/DbTimestampedEntity
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/#dbtimestampedentity","title":"DbTimestampedEntity","text":"[jvm]\\ interface DbTimestampedEntity
This complements DbEntity for entities that keep updated_at and created_at timestamps.
Misk uses the application\u2019s clock time to set created_at and updated_at. We prefer the application\u2019s (ie. JVM\u2019s) clock over the database\u2019s clock because only the application\u2019s clock can be faked in tests.
To use timestamped entities first add two columns in your CREATE TABLE statement. You may also add an optional index on updated_at:
CREATE TABLE movies(\n id bigint NOT NULL PRIMARY KEY AUTO_INCREMENT,\n created_at timestamp(3) NOT NULL DEFAULT NOW(3),\n updated_at timestamp(3) NOT NULL DEFAULT NOW(3) ON UPDATE NOW(3),\n ...\n KEY `idx_updated_at` (`updated_at`)\n);\nThe above SQL uses timestamp(3) and NOW(3) to get millisecond precision which interoperates nicely with Java. Although we declare DEFAULT NOW(3) and ON UPDATE NOW(3), these don\u2019t apply to writes from Hibernate because it always provides a value explicitly.
Next implement this interface and add the following declarations to your entity class:
@Entity\n@Table(name = \"movies\")\nclass DbMovie() : DbEntity<DbMovie>, DbTimestampedEntity {\n\n ...\n\n @Column\n override lateinit var updated_at: Instant\n\n @Column\n override lateinit var created_at: Instant\n\n ...\n\n}\nThe timestamp listener will automatically populate these values on save and update. (Incidentally, the @Columns are not marked nullable = false because the timestamp listener is triggered after the nullability check.)
//misk-hibernate/misk.hibernate/DbTimestampedEntity/created_at
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/created_at/#created_at","title":"created_at","text":"[jvm]\\ abstract var created_at: Instant
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/updated_at/","title":"updated_at - Misk","text":"//misk-hibernate/misk.hibernate/DbTimestampedEntity/updated_at
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/updated_at/#updated_at","title":"updated_at","text":"[jvm]\\ abstract var updated_at: Instant
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-unsharded/","title":"DbUnsharded - Misk","text":"//misk-hibernate/misk.hibernate/DbUnsharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-unsharded/#dbunsharded","title":"DbUnsharded","text":"[jvm]\\ interface DbUnsharded<T : DbUnsharded<T>> : DbEntity<T>
Marker interface for persistent entities that have a bounded growth and do not require sharding.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-unsharded/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: Id<T>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/","title":"Fetch - Misk","text":"//misk-hibernate/misk.hibernate/Fetch
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/#fetch","title":"Fetch","text":"[jvm]\\ annotation class Fetch(val path: String = \"\", val joinType: JoinType = LEFT, val forProjection: Boolean = false)
Annotates a function on a Query interface to specify that the association at the given path should be fetched in a single query. The type of join used will be specified by joinType, and defaults to a LEFT JOIN.
If the query will result in a Projection, and does not need to get the entire entity graph, set forProjection to true. This will make the query operate as a regular JOIN query, instead of a JOIN FETCH query.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/#properties","title":"Properties","text":"Name Summary forProjection [jvm]val forProjection: Boolean = false joinType [jvm]val joinType: JoinType path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/for-projection/","title":"forProjection - Misk","text":"//misk-hibernate/misk.hibernate/Fetch/forProjection
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/for-projection/#forprojection","title":"forProjection","text":"[jvm]\\ val forProjection: Boolean = false
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/join-type/","title":"joinType - Misk","text":"//misk-hibernate/misk.hibernate/Fetch/joinType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/join-type/#jointype","title":"joinType","text":"[jvm]\\ val joinType: JoinType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Fetch/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/","title":"Gid - Misk","text":"//misk-hibernate/misk.hibernate/Gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#gid","title":"Gid","text":"[jvm]\\ @Embeddable
data class Gid<R : DbRoot<R>, T : DbSharded<R, T>>(val rootId: Id<R>, val id: Id<T>) : Serializable
Entity group id, maps to two long columns one for the root id and one for the row
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#constructors","title":"Constructors","text":"Gid [jvm]constructor(rootId: Id<R>, id: Id<T>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#properties","title":"Properties","text":"Name Summary id [jvm]val id: Id<T> rootId [jvm]val rootId: Id<R>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#functions","title":"Functions","text":"Name Summary shardKey [jvm]fun shardKey(): Shard.Key toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/-gid/","title":"Gid - Misk","text":"//misk-hibernate/misk.hibernate/Gid/Gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/-gid/#gid","title":"Gid","text":"[jvm]\\ constructor(rootId: Id<R>, id: Id<T>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/id/","title":"id - Misk","text":"//misk-hibernate/misk.hibernate/Gid/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/id/#id","title":"id","text":"[jvm]\\ val id: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/root-id/","title":"rootId - Misk","text":"//misk-hibernate/misk.hibernate/Gid/rootId
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/root-id/#rootid","title":"rootId","text":"[jvm]\\ val rootId: Id<R>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/shard-key/","title":"shardKey - Misk","text":"//misk-hibernate/misk.hibernate/Gid/shardKey
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/shard-key/#shardkey","title":"shardKey","text":"[jvm]\\ fun shardKey(): Shard.Key
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/to-string/","title":"toString - Misk","text":"//misk-hibernate/misk.hibernate/Gid/toString
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/","title":"GidGenerator - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/#gidgenerator","title":"GidGenerator","text":"[jvm]\\ class GidGenerator : AbstractPostInsertGenerator, Configurable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/#constructors","title":"Constructors","text":"GidGenerator [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/#functions","title":"Functions","text":"Name Summary configure [jvm]open override fun configure(type: Type, params: Properties, serviceRegistry: ServiceRegistry) determineBulkInsertionIdentifierGenerationSelectFragment [jvm]open override fun determineBulkInsertionIdentifierGenerationSelectFragment(p0: SqlStringGenerationContext): Stringopen fun determineBulkInsertionIdentifierGenerationSelectFragment(p0: Dialect): String generate [jvm]open override fun generate(p0: SharedSessionContractImplementor, p1: Any): Serializable getInsertGeneratedIdentifierDelegate [jvm]open override fun getInsertGeneratedIdentifierDelegate(persister: PostInsertIdentityPersister, dialect: Dialect, isGetGeneratedKeysEnabled: Boolean): InsertGeneratedIdentifierDelegate initialize [jvm]open fun initialize(p0: SqlStringGenerationContext) registerExportables [jvm]open override fun registerExportables(p0: Database) supportsBulkInsertionIdentifierGeneration [jvm]open override fun supportsBulkInsertionIdentifierGeneration(): Boolean supportsJdbcBatchInserts [jvm]open override fun supportsJdbcBatchInserts(): Boolean"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/-gid-generator/","title":"GidGenerator - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator/GidGenerator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/-gid-generator/#gidgenerator","title":"GidGenerator","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/configure/","title":"configure - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator/configure
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/configure/#configure","title":"configure","text":"[jvm]\\ open override fun configure(type: Type, params: Properties, serviceRegistry: ServiceRegistry)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/get-insert-generated-identifier-delegate/","title":"getInsertGeneratedIdentifierDelegate - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator/getInsertGeneratedIdentifierDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/get-insert-generated-identifier-delegate/#getinsertgeneratedidentifierdelegate","title":"getInsertGeneratedIdentifierDelegate","text":"[jvm]\\ open override fun getInsertGeneratedIdentifierDelegate(persister: PostInsertIdentityPersister, dialect: Dialect, isGetGeneratedKeysEnabled: Boolean): InsertGeneratedIdentifierDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/","title":"Group - Misk","text":"//misk-hibernate/misk.hibernate/Group
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/#group","title":"Group","text":"[jvm]\\ annotation class Group(val paths: Array<String> = [])
Annotates a function on a Query interface to indicate that the results should be grouped by the given paths. This is most useful with Projections and aggregations.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/#properties","title":"Properties","text":"Name Summary paths [jvm]val paths: Array<String>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/paths/","title":"paths - Misk","text":"//misk-hibernate/misk.hibernate/Group/paths
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/paths/#paths","title":"paths","text":"[jvm]\\ val paths: Array<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/","title":"HibernateEntityModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateEntityModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/#hibernateentitymodule","title":"HibernateEntityModule","text":"[jvm]\\ abstract class HibernateEntityModule(qualifier: KClass<out Annotation>) : KAbstractModule
Binds hibernate entities and event listeners intended for the Transacter annotated by qualifier.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/#constructors","title":"Constructors","text":"HibernateEntityModule [jvm]constructor(qualifier: KClass<out Annotation>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureHibernate [jvm]abstract fun configureHibernate()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/-hibernate-entity-module/","title":"HibernateEntityModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateEntityModule/HibernateEntityModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/-hibernate-entity-module/#hibernateentitymodule","title":"HibernateEntityModule","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/configure-hibernate/","title":"configureHibernate - Misk","text":"//misk-hibernate/misk.hibernate/HibernateEntityModule/configureHibernate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/configure-hibernate/#configurehibernate","title":"configureHibernate","text":"[jvm]\\ abstract fun configureHibernate()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/","title":"HibernateExceptionLogLevelConfig - Misk","text":"//misk-hibernate/misk.hibernate/HibernateExceptionLogLevelConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/#hibernateexceptionloglevelconfig","title":"HibernateExceptionLogLevelConfig","text":"[jvm]\\ data class HibernateExceptionLogLevelConfig@JvmOverloadsconstructor(val log_level: Level = Level.WARN) : Config
Configures the log Level for a HibernateException.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/#constructors","title":"Constructors","text":"HibernateExceptionLogLevelConfig [jvm]@JvmOverloadsconstructor(log_level: Level = Level.WARN)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/#properties","title":"Properties","text":"Name Summary log_level [jvm]val log_level: Level"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/-hibernate-exception-log-level-config/","title":"HibernateExceptionLogLevelConfig - Misk","text":"//misk-hibernate/misk.hibernate/HibernateExceptionLogLevelConfig/HibernateExceptionLogLevelConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/-hibernate-exception-log-level-config/#hibernateexceptionloglevelconfig","title":"HibernateExceptionLogLevelConfig","text":"[jvm]\\
@JvmOverloads
constructor(log_level: Level = Level.WARN)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/log_level/","title":"log_level - Misk","text":"//misk-hibernate/misk.hibernate/HibernateExceptionLogLevelConfig/log_level
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/log_level/#log_level","title":"log_level","text":"[jvm]\\ val log_level: Level
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/","title":"HibernateModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#hibernatemodule","title":"HibernateModule","text":"[jvm]\\ class HibernateModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig()) : KAbstractModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#constructors","title":"Constructors","text":"HibernateModule [jvm]constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig)constructor(qualifier: KClass<out Annotation>, readerQualifier: KClass<out Annotation>, cluster: DataSourceClusterConfig, databasePool: DatabasePool = RealDatabasePool)@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig())"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig databasePool [jvm]val databasePool: DatabasePool readerConfig [jvm]val readerConfig: DataSourceConfig?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/-hibernate-module/","title":"HibernateModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/HibernateModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/-hibernate-module/#hibernatemodule","title":"HibernateModule","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)
constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig)
constructor(qualifier: KClass<out Annotation>, readerQualifier: KClass<out Annotation>, cluster: DataSourceClusterConfig, databasePool: DatabasePool = RealDatabasePool)
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig())
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/config/","title":"config - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/config
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/database-pool/","title":"databasePool - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/databasePool
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/database-pool/#databasepool","title":"databasePool","text":"[jvm]\\ val databasePool: DatabasePool
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/reader-config/","title":"readerConfig - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/readerConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/reader-config/#readerconfig","title":"readerConfig","text":"[jvm]\\ val readerConfig: DataSourceConfig?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/","title":"Id - Misk","text":"//misk-hibernate/misk.hibernate/Id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#id","title":"Id","text":"[jvm]\\ data class Id<T : DbEntity<T>>(val id: Long) : Serializable, Comparable<Id<T>>
Type-safe persistent identifier, mapped to a long column.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#constructors","title":"Constructors","text":"Id [jvm]constructor(id: Long)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#properties","title":"Properties","text":"Name Summary id [jvm]val id: Long"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Id<T>): Int shardKey [jvm]fun shardKey(): Shard.Key toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/-id/","title":"Id - Misk","text":"//misk-hibernate/misk.hibernate/Id/Id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/-id/#id","title":"Id","text":"[jvm]\\ constructor(id: Long)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/compare-to/","title":"compareTo - Misk","text":"//misk-hibernate/misk.hibernate/Id/compareTo
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Id<T>): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/id/","title":"id - Misk","text":"//misk-hibernate/misk.hibernate/Id/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/id/#id","title":"id","text":"[jvm]\\ val id: Long
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/shard-key/","title":"shardKey - Misk","text":"//misk-hibernate/misk.hibernate/Id/shardKey
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/shard-key/#shardkey","title":"shardKey","text":"[jvm]\\ fun shardKey(): Shard.Key
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/to-string/","title":"toString - Misk","text":"//misk-hibernate/misk.hibernate/Id/toString
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/","title":"IdType - Misk","text":"//misk-hibernate/misk.hibernate/IdType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/#idtype","title":"IdType","text":"[jvm]\\ class IdType : UserType, ResultSetIdentifierConsumer
Binds Id<*> in the DB to a bigint in MySQL.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/#constructors","title":"Constructors","text":"IdType [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/#functions","title":"Functions","text":"Name Summary assemble [jvm]open override fun assemble(cached: Serializable, owner: Any?): Any consumeIdentifier [jvm]open override fun consumeIdentifier(resultSet: ResultSet): Serializable deepCopy [jvm]open override fun deepCopy(value: Any?): Any? disassemble [jvm]open override fun disassemble(value: Any?): Long equals [jvm]open override fun equals(x: Any?, y: Any?): Boolean hashCode [jvm]open override fun hashCode(x: Any?): Int isMutable [jvm]open override fun isMutable(): Boolean nullSafeGet [jvm]open override fun nullSafeGet(rs: ResultSet, names: Array<out String>, session: SharedSessionContractImplementor?, owner: Any?): Any? nullSafeSet [jvm]open override fun nullSafeSet(st: PreparedStatement, value: Any?, index: Int, session: SharedSessionContractImplementor?) replace [jvm]open override fun replace(original: Any, target: Any, owner: Any?): Any returnedClass [jvm]open override fun returnedClass(): Class<Id<*>> sqlTypes [jvm]open override fun sqlTypes(): IntArray"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/-id-type/","title":"IdType - Misk","text":"//misk-hibernate/misk.hibernate/IdType/IdType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/-id-type/#idtype","title":"IdType","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/assemble/","title":"assemble - Misk","text":"//misk-hibernate/misk.hibernate/IdType/assemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/assemble/#assemble","title":"assemble","text":"[jvm]\\ open override fun assemble(cached: Serializable, owner: Any?): Any
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/consume-identifier/","title":"consumeIdentifier - Misk","text":"//misk-hibernate/misk.hibernate/IdType/consumeIdentifier
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/consume-identifier/#consumeidentifier","title":"consumeIdentifier","text":"[jvm]\\ open override fun consumeIdentifier(resultSet: ResultSet): Serializable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/deep-copy/","title":"deepCopy - Misk","text":"//misk-hibernate/misk.hibernate/IdType/deepCopy
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/deep-copy/#deepcopy","title":"deepCopy","text":"[jvm]\\ open override fun deepCopy(value: Any?): Any?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/disassemble/","title":"disassemble - Misk","text":"//misk-hibernate/misk.hibernate/IdType/disassemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/disassemble/#disassemble","title":"disassemble","text":"[jvm]\\ open override fun disassemble(value: Any?): Long
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/equals/","title":"equals - Misk","text":"//misk-hibernate/misk.hibernate/IdType/equals
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/equals/#equals","title":"equals","text":"[jvm]\\ open override fun equals(x: Any?, y: Any?): Boolean
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/hash-code/","title":"hashCode - Misk","text":"//misk-hibernate/misk.hibernate/IdType/hashCode
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(x: Any?): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/is-mutable/","title":"isMutable - Misk","text":"//misk-hibernate/misk.hibernate/IdType/isMutable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/is-mutable/#ismutable","title":"isMutable","text":"[jvm]\\ open override fun isMutable(): Boolean
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-get/","title":"nullSafeGet - Misk","text":"//misk-hibernate/misk.hibernate/IdType/nullSafeGet
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-get/#nullsafeget","title":"nullSafeGet","text":"[jvm]\\ open override fun nullSafeGet(rs: ResultSet, names: Array<out String>, session: SharedSessionContractImplementor?, owner: Any?): Any?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-set/","title":"nullSafeSet - Misk","text":"//misk-hibernate/misk.hibernate/IdType/nullSafeSet
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-set/#nullsafeset","title":"nullSafeSet","text":"[jvm]\\ open override fun nullSafeSet(st: PreparedStatement, value: Any?, index: Int, session: SharedSessionContractImplementor?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/replace/","title":"replace - Misk","text":"//misk-hibernate/misk.hibernate/IdType/replace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/replace/#replace","title":"replace","text":"[jvm]\\ open override fun replace(original: Any, target: Any, owner: Any?): Any
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/returned-class/","title":"returnedClass - Misk","text":"//misk-hibernate/misk.hibernate/IdType/returnedClass
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/returned-class/#returnedclass","title":"returnedClass","text":"[jvm]\\ open override fun returnedClass(): Class<Id<*>>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/sql-types/","title":"sqlTypes - Misk","text":"//misk-hibernate/misk.hibernate/IdType/sqlTypes
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/sql-types/#sqltypes","title":"sqlTypes","text":"[jvm]\\ open override fun sqlTypes(): IntArray
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-json-column/","title":"JsonColumn - Misk","text":"//misk-hibernate/misk.hibernate/JsonColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-json-column/#jsoncolumn","title":"JsonColumn","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class JsonColumn
Put this on a column field to get Hibernate to persist it as JSON using Moshi. It will use the injector\u2019s configured Moshi instance. Use misk.moshi.MoshiModule to customize.
It is an error to put this annotation on a mutable field. We don\u2019t defensively copy these when we read them out of the database.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/","title":"Operator - Misk","text":"//misk-hibernate/misk.hibernate/Operator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#operator","title":"Operator","text":"[jvm]\\ enum Operator : Enum<Operator>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#entries","title":"Entries","text":"LT [jvm]LTa < b LE [jvm]LEa <= b EQ [jvm]EQa = b EQ_OR_IS_NULL [jvm]EQ_OR_IS_NULLa = b if b is not null, a is null if b is null GE [jvm]GEa >= b GT [jvm]GTa > b NE [jvm]NEa != b IN [jvm]INa IN (b1, b2, b3, ...) NOT_IN [jvm]NOT_INa NOT IN (b1, b2, b3, ...) IS_NOT_NULL [jvm]IS_NOT_NULLa IS NOT NULL IS_NULL [jvm]IS_NULLa IS NULL"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Operator>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): OperatorReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Operator>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/entries/","title":"entries - Misk","text":"//misk-hibernate/misk.hibernate/Operator/entries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Operator>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/value-of/","title":"valueOf - Misk","text":"//misk-hibernate/misk.hibernate/Operator/valueOf
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Operator
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/values/","title":"values - Misk","text":"//misk-hibernate/misk.hibernate/Operator/values
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Operator>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-e-q/","title":"EQ - Misk","text":"//misk-hibernate/misk.hibernate/Operator/EQ
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-e-q/#eq","title":"EQ","text":"[jvm]\\ EQ
a = b
//misk-hibernate/misk.hibernate/Operator/EQ_OR_IS_NULL
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-e-q_-o-r_-i-s_-n-u-l-l/#eq_or_is_null","title":"EQ_OR_IS_NULL","text":"[jvm]\\ EQ_OR_IS_NULL
a = b if b is not null, a is null if b is null
//misk-hibernate/misk.hibernate/Operator/GE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-g-e/#ge","title":"GE","text":"[jvm]\\ GE
a >= b
//misk-hibernate/misk.hibernate/Operator/GT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-g-t/#gt","title":"GT","text":"[jvm]\\ GT
a > b
//misk-hibernate/misk.hibernate/Operator/IN
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-i-n/#in","title":"IN","text":"[jvm]\\ IN
a IN (b1, b2, b3, ...)
//misk-hibernate/misk.hibernate/Operator/IS_NOT_NULL
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-i-s_-n-o-t_-n-u-l-l/#is_not_null","title":"IS_NOT_NULL","text":"[jvm]\\ IS_NOT_NULL
a IS NOT NULL
//misk-hibernate/misk.hibernate/Operator/IS_NULL
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-i-s_-n-u-l-l/#is_null","title":"IS_NULL","text":"[jvm]\\ IS_NULL
a IS NULL
//misk-hibernate/misk.hibernate/Operator/LE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-l-e/#le","title":"LE","text":"[jvm]\\ LE
a <= b
//misk-hibernate/misk.hibernate/Operator/LT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-l-t/#lt","title":"LT","text":"[jvm]\\ LT
a < b
//misk-hibernate/misk.hibernate/Operator/NE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-n-e/#ne","title":"NE","text":"[jvm]\\ NE
a != b
//misk-hibernate/misk.hibernate/Operator/NOT_IN
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-n-o-t_-i-n/#not_in","title":"NOT_IN","text":"[jvm]\\ NOT_IN
a NOT IN (b1, b2, b3, ...)
//misk-hibernate/misk.hibernate/OrBuilder
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/#orbuilder","title":"OrBuilder","text":"[jvm]\\ interface OrBuilder<Q : Query<*>>
This functional interface accepts a set of options. Each option lambda is executed within the scope of a query. It is inappropriate to call methods like list() and uniqueResult() on this query.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/#functions","title":"Functions","text":"Name Summary option [jvm]abstract fun option(lambda: Q.() -> Unit)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/option/","title":"option - Misk","text":"//misk-hibernate/misk.hibernate/OrBuilder/option
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/option/#option","title":"option","text":"[jvm]\\ abstract fun option(lambda: Q.() -> Unit)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/","title":"Order - Misk","text":"//misk-hibernate/misk.hibernate/Order
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/#order","title":"Order","text":"[jvm]\\ annotation class Order(val path: String, val asc: Boolean = true)
Annotates a function on a Query interface to indicate by which columns to order the results. Defaults to ascending order.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/#properties","title":"Properties","text":"Name Summary asc [jvm]val asc: Boolean = true path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/asc/","title":"asc - Misk","text":"//misk-hibernate/misk.hibernate/Order/asc
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/asc/#asc","title":"asc","text":"[jvm]\\ val asc: Boolean = true
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Order/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/","title":"Path - Misk","text":"//misk-hibernate/misk.hibernate/Path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#path","title":"Path","text":"[jvm]\\ data class Path(val schema: String?, val table: String?, val column: String?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#constructors","title":"Constructors","text":"Path [jvm]constructor(schema: String?, table: String?, column: String?)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#properties","title":"Properties","text":"Name Summary column [jvm]val column: String? schema [jvm]val schema: String? table [jvm]val table: String?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/-path/","title":"Path - Misk","text":"//misk-hibernate/misk.hibernate/Path/Path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/-path/#path","title":"Path","text":"[jvm]\\ constructor(schema: String?, table: String?, column: String?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/column/","title":"column - Misk","text":"//misk-hibernate/misk.hibernate/Path/column
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/column/#column","title":"column","text":"[jvm]\\ val column: String?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/schema/","title":"schema - Misk","text":"//misk-hibernate/misk.hibernate/Path/schema
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/schema/#schema","title":"schema","text":"[jvm]\\ val schema: String?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/table/","title":"table - Misk","text":"//misk-hibernate/misk.hibernate/Path/table
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/table/#table","title":"table","text":"[jvm]\\ val table: String?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/to-string/","title":"toString - Misk","text":"//misk-hibernate/misk.hibernate/Path/toString
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-hibernate/misk.hibernate/PostCommitHookFailedException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ class PostCommitHookFailedException(cause: Throwable) : Exception
PostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#constructors","title":"Constructors","text":"PostCommitHookFailedException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-hibernate/misk.hibernate/PostCommitHookFailedException/PostCommitHookFailedException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ constructor(cause: Throwable)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-projection/","title":"Projection - Misk","text":"//misk-hibernate/misk.hibernate/Projection
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-projection/#projection","title":"Projection","text":"[jvm]\\ interface Projection
Marker interface for query projections.
Projections are used to define the shape of the result set of a query, often as a subset of the properties of the entity or entities being queried.
For example, if we have a DbMovie entity with a name, release_date, and other properties we could use a projection to only select the name and release_date properties:
data class NameAndReleaseDate(\n @Property(\"name\") var name: String,\n @Property(\"release_date\") var releaseDate: LocalDate?\n) : Projection\n//misk-hibernate/misk.hibernate/Property
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/#property","title":"Property","text":"[jvm]\\ annotation class Property(val path: String, val aggregation: AggregationType = AggregationType.NONE)
Annotates a parameter of a Projection data class to indicate which column (or path of columns) to populate the parameter with.
Properties may be created from an aggregation function, which will be applied to the column. By default, no aggregation is applied.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/#properties","title":"Properties","text":"Name Summary aggregation [jvm]val aggregation: AggregationType path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/aggregation/","title":"aggregation - Misk","text":"//misk-hibernate/misk.hibernate/Property/aggregation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/aggregation/#aggregation","title":"aggregation","text":"[jvm]\\ val aggregation: AggregationType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Property/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-proto-column/","title":"ProtoColumn - Misk","text":"//misk-hibernate/misk.hibernate/ProtoColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-proto-column/#protocolumn","title":"ProtoColumn","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class ProtoColumn
Put this on a column field for a class generated by Wire to get Hibernate to persist with protobuf serialization.
There is no defensive copy when reading from the database as protobufs are assumed to be immutable.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/","title":"Query - Misk","text":"//misk-hibernate/misk.hibernate/Query
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#query","title":"Query","text":"[jvm]\\ interface Query<T>
Base class for SQL queries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryCreates instances of queries."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#properties","title":"Properties","text":"Name Summary firstResult [jvm]abstract var firstResult: IntSet the first row to retrieve. The default is 0. maxRows [jvm]abstract var maxRows: IntHow many rows to return. Must be -1 or in range 1..10_000."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#functions","title":"Functions","text":"Name Summary addJpaConstraint [jvm]abstract fun addJpaConstraint(block: (root: Root<*>, builder: CriteriaBuilder) -> Predicate)Constrain a query by operating directly on the JPA criteria builder. addQueryHint [jvm]abstract fun addQueryHint(hint: String)Adds a SQL hint to the query. clone [jvm]abstract fun <Q : Query<*>> clone(): Q count [jvm]abstract fun count(session: Session): LongReturns the number of rows that match the query. delete [jvm]abstract fun delete(session: Session): IntReturns the number of entities deleted. disableCheck [jvm]abstract fun disableCheck(check: Check) dynamicAddConstraint [jvm]abstract fun dynamicAddConstraint(path: String, operator: Operator, value: Any? = null)Constrain a query using a path known only at runtime. dynamicAddFetch [jvm]abstract fun dynamicAddFetch(path: String, joinType: JoinType)Fetch the given path as a join, using the given joinType dynamicAddOrder [jvm]abstract fun dynamicAddOrder(path: String, asc: Boolean) dynamicList [jvm]abstract fun dynamicList(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<List<Any?>>Manual projections are returned as a list of rows containing a list of cells.[jvm]abstract fun dynamicList(session: Session, projectedPaths: List<String>): List<List<Any?>> dynamicUniqueResult [jvm]abstract fun dynamicUniqueResult(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<Any?>?Manual projections are returned as a list of cells. Returns null if there were no results.[jvm]abstract fun dynamicUniqueResult(session: Session, projectedPaths: List<String>): List<Any?>? list [jvm]abstract fun list(session: Session): List<T> newOrBuilder [jvm]abstract fun <T : Query<*>> newOrBuilder(): OrBuilder<T> uniqueResult [jvm]abstract fun uniqueResult(session: Session): T?Asserts that there is either zero or one results."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-jpa-constraint/","title":"addJpaConstraint - Misk","text":"//misk-hibernate/misk.hibernate/Query/addJpaConstraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-jpa-constraint/#addjpaconstraint","title":"addJpaConstraint","text":"[jvm]\\ abstract fun addJpaConstraint(block: (root: Root<*>, builder: CriteriaBuilder) -> Predicate)
Constrain a query by operating directly on the JPA criteria builder.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-query-hint/","title":"addQueryHint - Misk","text":"//misk-hibernate/misk.hibernate/Query/addQueryHint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-query-hint/#addqueryhint","title":"addQueryHint","text":"[jvm]\\ abstract fun addQueryHint(hint: String)
Adds a SQL hint to the query.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/clone/","title":"clone - Misk","text":"//misk-hibernate/misk.hibernate/Query/clone
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/clone/#clone","title":"clone","text":"[jvm]\\ abstract fun <Q : Query<*>> clone(): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/count/","title":"count - Misk","text":"//misk-hibernate/misk.hibernate/Query/count
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/count/#count","title":"count","text":"[jvm]\\ abstract fun count(session: Session): Long
Returns the number of rows that match the query.
Warning: The performance of this operation is comparable to a SELECT. MySQL scans all of the counted rows. A query that returns a count of 5000 is typically 10 times slower than a query that returns a count of 500.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/delete/","title":"delete - Misk","text":"//misk-hibernate/misk.hibernate/Query/delete
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/delete/#delete","title":"delete","text":"[jvm]\\ abstract fun delete(session: Session): Int
Returns the number of entities deleted.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/disable-check/","title":"disableCheck - Misk","text":"//misk-hibernate/misk.hibernate/Query/disableCheck
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/disable-check/#disablecheck","title":"disableCheck","text":"[jvm]\\ abstract fun disableCheck(check: Check)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-constraint/","title":"dynamicAddConstraint - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicAddConstraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-constraint/#dynamicaddconstraint","title":"dynamicAddConstraint","text":"[jvm]\\ abstract fun dynamicAddConstraint(path: String, operator: Operator, value: Any? = null)
Constrain a query using a path known only at runtime.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-fetch/","title":"dynamicAddFetch - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicAddFetch
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-fetch/#dynamicaddfetch","title":"dynamicAddFetch","text":"[jvm]\\ abstract fun dynamicAddFetch(path: String, joinType: JoinType)
Fetch the given path as a join, using the given joinType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-order/","title":"dynamicAddOrder - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicAddOrder
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-order/#dynamicaddorder","title":"dynamicAddOrder","text":"[jvm]\\ abstract fun dynamicAddOrder(path: String, asc: Boolean)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-list/","title":"dynamicList - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicList
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-list/#dynamiclist","title":"dynamicList","text":"[jvm]\\ abstract fun dynamicList(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<List<Any?>>
Manual projections are returned as a list of rows containing a list of cells.
[jvm]\\ abstract fun dynamicList(session: Session, projectedPaths: List<String>): List<List<Any?>>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-unique-result/","title":"dynamicUniqueResult - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicUniqueResult
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-unique-result/#dynamicuniqueresult","title":"dynamicUniqueResult","text":"[jvm]\\ abstract fun dynamicUniqueResult(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<Any?>?
Manual projections are returned as a list of cells. Returns null if there were no results.
[jvm]\\ abstract fun dynamicUniqueResult(session: Session, projectedPaths: List<String>): List<Any?>?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/first-result/","title":"firstResult - Misk","text":"//misk-hibernate/misk.hibernate/Query/firstResult
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/first-result/#firstresult","title":"firstResult","text":"[jvm]\\ abstract var firstResult: Int
Set the first row to retrieve. The default is 0.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/list/","title":"list - Misk","text":"//misk-hibernate/misk.hibernate/Query/list
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/list/#list","title":"list","text":"[jvm]\\ abstract fun list(session: Session): List<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/max-rows/","title":"maxRows - Misk","text":"//misk-hibernate/misk.hibernate/Query/maxRows
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/max-rows/#maxrows","title":"maxRows","text":"[jvm]\\ abstract var maxRows: Int
How many rows to return. Must be -1 or in range 1..10_000.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/new-or-builder/","title":"newOrBuilder - Misk","text":"//misk-hibernate/misk.hibernate/Query/newOrBuilder
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/new-or-builder/#neworbuilder","title":"newOrBuilder","text":"[jvm]\\ abstract fun <T : Query<*>> newOrBuilder(): OrBuilder<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/unique-result/","title":"uniqueResult - Misk","text":"//misk-hibernate/misk.hibernate/Query/uniqueResult
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/unique-result/#uniqueresult","title":"uniqueResult","text":"[jvm]\\ abstract fun uniqueResult(session: Session): T?
Asserts that there is either zero or one results.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/","title":"Factory - Misk","text":"//misk-hibernate/misk.hibernate/Query/Factory
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/#factory","title":"Factory","text":"[jvm]\\ interface Factory
Creates instances of queries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/#functions","title":"Functions","text":"Name Summary dynamicQuery [jvm]abstract fun <E : DbEntity<E>> dynamicQuery(entityClass: KClass<E>): Query<E> newQuery [jvm]abstract fun <Q : Query<*>> newQuery(queryClass: KClass<Q>): Q newQuery [jvm]inline fun <T : Query<*>> Query.Factory.newQuery(): T"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/dynamic-query/","title":"dynamicQuery - Misk","text":"//misk-hibernate/misk.hibernate/Query/Factory/dynamicQuery
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/dynamic-query/#dynamicquery","title":"dynamicQuery","text":"[jvm]\\ abstract fun <E : DbEntity<E>> dynamicQuery(entityClass: KClass<E>): Query<E>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/new-query/","title":"newQuery - Misk","text":"//misk-hibernate/misk.hibernate/Query/Factory/newQuery
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/new-query/#newquery","title":"newQuery","text":"[jvm]\\ abstract fun <Q : Query<*>> newQuery(queryClass: KClass<Q>): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/","title":"RetryTransactionException - Misk","text":"//misk-hibernate/misk.hibernate/RetryTransactionException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#retrytransactionexception","title":"RetryTransactionException","text":"[jvm]\\ class RetryTransactionException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : Exception
Thrown to explicitly trigger a retry, subject to retry limits and config such as noRetries().
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#constructors","title":"Constructors","text":"RetryTransactionException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/-retry-transaction-exception/","title":"RetryTransactionException - Misk","text":"//misk-hibernate/misk.hibernate/RetryTransactionException/RetryTransactionException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/-retry-transaction-exception/#retrytransactionexception","title":"RetryTransactionException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/","title":"SecretColumn - Misk","text":"//misk-hibernate/misk.hibernate/SecretColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/#secretcolumn","title":"SecretColumn","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class SecretColumn(val keyName: String, val indexable: Boolean = true)
SecretColumn is an annotation used to get Hibernate to encrypt a field before writing it to the database.
The keyName string is used to specify the name of the key to be used to encrypt and decrypt the value.
The indexable attribute controls whether or not this data will be able to be indexed, defaulted to true. This uses deterministic encryption: encrypting the same plaintext will produce the same ciphertext. This is weaker than non-deterministic encryption, but makes searching for encrypted values possible. If searching for ciphertexts is not something your use case requires, set indexable to false for stronger security.
Install misk.crypto.CryptoModule to configure the keys the app uses. Example: In app-common.yaml:
crypto:\n keys:\n - key_name: \"secretColumnKey\"\nThen, in an entity class:
@Column\n@SecretColumn(keyName = \"secretColumnKey\")\nvar secret: String\nA Column annotated with SecretColumn has the following limitations:
VARBINARY() in its respective MySQL table. For example:CREATE TABLE my_table(\n id BIGINT NOT NULL AUTO_INCREMENT,\n secret VARBINARY(500)\nNote:
The resulting ciphertext that is persisted in the database may be much larger in size than the original plaintext because it also contains some metadata. Please make sure to allocate enough space when defining the column using VARBINARY().
//misk-hibernate/misk.hibernate/SecretColumn/indexable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/indexable/#indexable","title":"indexable","text":"[jvm]\\ val indexable: Boolean = true
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/key-name/","title":"keyName - Misk","text":"//misk-hibernate/misk.hibernate/SecretColumn/keyName
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/key-name/#keyname","title":"keyName","text":"[jvm]\\ val keyName: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/","title":"Select - Misk","text":"//misk-hibernate/misk.hibernate/Select
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/#select","title":"Select","text":"[jvm]\\ annotation class Select(val path: String = \"\", val aggregation: AggregationType = AggregationType.NONE)
Annotates a function on a Query interface to execute a SELECT query. Functions with this annotation must return a List to fetch multiple rows results, or a regular type to fetch a unique result.
Select annotated methods may return single column values, or Projections of multiple columns.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/#properties","title":"Properties","text":"Name Summary aggregation [jvm]val aggregation: AggregationType path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/aggregation/","title":"aggregation - Misk","text":"//misk-hibernate/misk.hibernate/Select/aggregation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/aggregation/#aggregation","title":"aggregation","text":"[jvm]\\ val aggregation: AggregationType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Select/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/","title":"Session - Misk","text":"//misk-hibernate/misk.hibernate/Session
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/#session","title":"Session","text":"[jvm]\\ interface Session : Session
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/#properties","title":"Properties","text":"Name Summary hibernateSession [jvm]abstract val hibernateSession: Session"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/#functions","title":"Functions","text":"Name Summary delete [jvm]abstract fun <T : DbEntity<T>> delete(entity: T) disableChecks [jvm]abstract fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T load [jvm]abstract fun <T : DbEntity<T>> load(id: Id<T>, type: KClass<T>): T load [jvm]inline fun <T : DbEntity<T>> Session.load(id: Id<T>): T loadOrNull [jvm]abstract fun <T : DbEntity<T>> loadOrNull(id: Id<T>, type: KClass<T>): T? loadOrNull [jvm]inline fun <T : DbEntity<T>> Session.loadOrNull(id: Id<T>): T? loadSharded [jvm]abstract fun <R : DbRoot<R>, T : DbSharded<R, T>> loadSharded(gid: Gid<R, T>, type: KClass<T>): T loadSharded [jvm]inline fun <R : DbRoot<R>, S : DbSharded<R, S>> Session.loadSharded(gid: Gid<R, S>): S onPostCommit [jvm]abstract fun onPostCommit(work: () -> Unit) onPreCommit [jvm]abstract fun onPreCommit(work: () -> Unit) onSessionClose [jvm]abstract fun onSessionClose(work: () -> Unit) save [jvm]abstract fun <T : DbEntity<T>> save(entity: T): Id<T> shards [jvm]abstract fun shards(): Set<Shard>abstract fun shards(keyspace: Keyspace): Collection<Shard> target [jvm]abstract fun <T> target(shard: Shard, function: () -> T): T useConnection [jvm]abstract fun <T> useConnection(work: (Connection) -> T): T withoutChecks [jvm]abstract fun <T> withoutChecks(vararg checks: Check, body: () -> T): TDisable one or more checks for the duration of the execution of body. The passed in checks will entirely replace the other ignored checks at this point, they will not be merged with whatever is there currently."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/delete/","title":"delete - Misk","text":"//misk-hibernate/misk.hibernate/Session/delete
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/delete/#delete","title":"delete","text":"[jvm]\\ abstract fun <T : DbEntity<T>> delete(entity: T)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/delete/#throws","title":"Throws","text":"IllegalStateException when delete is called on a read only session."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/disable-checks/","title":"disableChecks - Misk","text":"//misk-hibernate/misk.hibernate/Session/disableChecks
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/disable-checks/#disablechecks","title":"disableChecks","text":"[jvm]\\ abstract fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/hibernate-session/","title":"hibernateSession - Misk","text":"//misk-hibernate/misk.hibernate/Session/hibernateSession
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/hibernate-session/#hibernatesession","title":"hibernateSession","text":"[jvm]\\ abstract val hibernateSession: Session
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-or-null/","title":"loadOrNull - Misk","text":"//misk-hibernate/misk.hibernate/Session/loadOrNull
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-or-null/#loadornull","title":"loadOrNull","text":"[jvm]\\ abstract fun <T : DbEntity<T>> loadOrNull(id: Id<T>, type: KClass<T>): T?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-sharded/","title":"loadSharded - Misk","text":"//misk-hibernate/misk.hibernate/Session/loadSharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-sharded/#loadsharded","title":"loadSharded","text":"[jvm]\\ abstract fun <R : DbRoot<R>, T : DbSharded<R, T>> loadSharded(gid: Gid<R, T>, type: KClass<T>): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load/","title":"load - Misk","text":"//misk-hibernate/misk.hibernate/Session/load
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load/#load","title":"load","text":"[jvm]\\ abstract fun <T : DbEntity<T>> load(id: Id<T>, type: KClass<T>): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/save/","title":"save - Misk","text":"//misk-hibernate/misk.hibernate/Session/save
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/save/#save","title":"save","text":"[jvm]\\ abstract fun <T : DbEntity<T>> save(entity: T): Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/save/#throws","title":"Throws","text":"IllegalStateException when save is called on a read only session."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/shards/","title":"shards - Misk","text":"//misk-hibernate/misk.hibernate/Session/shards
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/shards/#shards","title":"shards","text":"[jvm]\\ abstract fun shards(): Set<Shard>
abstract fun shards(keyspace: Keyspace): Collection<Shard>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/target/","title":"target - Misk","text":"//misk-hibernate/misk.hibernate/Session/target
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/target/#target","title":"target","text":"[jvm]\\ abstract fun <T> target(shard: Shard, function: () -> T): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/without-checks/","title":"withoutChecks - Misk","text":"//misk-hibernate/misk.hibernate/Session/withoutChecks
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/without-checks/#withoutchecks","title":"withoutChecks","text":"[jvm]\\ abstract fun <T> withoutChecks(vararg checks: Check, body: () -> T): T
Disable one or more checks for the duration of the execution of body. The passed in checks will entirely replace the other ignored checks at this point, they will not be merged with whatever is there currently.
TODO: Deprecate. This can enable checks as a side-effect. Prefer disableChecks() which is cumulative
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/","title":"Transacter - Misk","text":"//misk-hibernate/misk.hibernate/Transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/#transacter","title":"Transacter","text":"[jvm]\\ interface Transacter
Provides explicit block-based transaction demarcation.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/#properties","title":"Properties","text":"Name Summary inTransaction [jvm]abstract val inTransaction: BooleanReturns true if the calling thread is currently within a transaction block."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/#functions","title":"Functions","text":"Name Summary allowCowrites [jvm]abstract fun allowCowrites(): TransacterDisable cowrite checks for the duration of the session. Useful for quickly setting up test data in testing. config [jvm]abstract fun config(): DataSourceConfig entities [jvm]abstract fun entities(): Set<KClass<out DbEntity<*>>>Returns KClasses for the bound DbEntities for the transacter failSafeRead [jvm]fun <T> Transacter.failSafeRead(block: (session: Session) -> T): TRuns a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.[jvm]fun <T> Transacter.failSafeRead(shard: Shard, block: (session: Session) -> T): T isCheckEnabled [jvm]abstract fun isCheckEnabled(check: Check): BooleanIs the scalability check currently enabled. Use Session.withoutChecks to disable checks. noRetries [jvm]abstract fun noRetries(): Transacter readOnly [jvm]abstract fun readOnly(): TransacterCreates a new transacter that produces read only sessions. This does not mean the underlying datasource is read only, only that the session produced won\u2019t modify the database. replicaRead [jvm]abstract fun <T> replicaRead(block: (session: Session) -> T): TRuns a non-transactional session against a read replica. retries [jvm]abstract fun retries(maxAttempts: Int = 2): Transacter shards [jvm]fun Transacter.shards(): Set<Shard>fun Transacter.shards(keyspace: Keyspace): Collection<Shard> transaction [jvm]abstract fun <T> transaction(block: (session: Session) -> T): TStarts a transaction on the current thread, executes block, and commits the transaction. If the block raises an exception the transaction will be rolled back instead of committed. transaction [jvm]fun <T> Transacter.transaction(shard: Shard, block: (session: Session) -> T): TCommits a transaction with operations of block."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/allow-cowrites/","title":"allowCowrites - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/allowCowrites
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/allow-cowrites/#allowcowrites","title":"allowCowrites","text":"[jvm]\\ abstract fun allowCowrites(): Transacter
Disable cowrite checks for the duration of the session. Useful for quickly setting up test data in testing.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/config/","title":"config - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/config
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/config/#config","title":"config","text":"[jvm]\\ abstract fun config(): DataSourceConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/entities/","title":"entities - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/entities
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/entities/#entities","title":"entities","text":"[jvm]\\ abstract fun entities(): Set<KClass<out DbEntity<*>>>
Returns KClasses for the bound DbEntities for the transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/in-transaction/","title":"inTransaction - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/inTransaction
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/in-transaction/#intransaction","title":"inTransaction","text":"[jvm]\\ abstract val inTransaction: Boolean
Returns true if the calling thread is currently within a transaction block.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/is-check-enabled/","title":"isCheckEnabled - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/isCheckEnabled
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/is-check-enabled/#ischeckenabled","title":"isCheckEnabled","text":"[jvm]\\ abstract fun isCheckEnabled(check: Check): Boolean
Is the scalability check currently enabled. Use Session.withoutChecks to disable checks.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/no-retries/","title":"noRetries - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/noRetries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/no-retries/#noretries","title":"noRetries","text":"[jvm]\\ abstract fun noRetries(): Transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/read-only/","title":"readOnly - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/readOnly
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/read-only/#readonly","title":"readOnly","text":"[jvm]\\ abstract fun readOnly(): Transacter
Creates a new transacter that produces read only sessions. This does not mean the underlying datasource is read only, only that the session produced won\u2019t modify the database.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/replica-read/","title":"replicaRead - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/replicaRead
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/replica-read/#replicaread","title":"replicaRead","text":"[jvm]\\ abstract fun <T> replicaRead(block: (session: Session) -> T): T
Runs a non-transactional session against a read replica.
A few things that are different with replica reads:
//misk-hibernate/misk.hibernate/Transacter/retries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/retries/#retries","title":"retries","text":"[jvm]\\ abstract fun retries(maxAttempts: Int = 2): Transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/transaction/","title":"transaction - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/transaction
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\ abstract fun <T> transaction(block: (session: Session) -> T): T
Starts a transaction on the current thread, executes block, and commits the transaction. If the block raises an exception the transaction will be rolled back instead of committed.
If retries are permitted (the default), a failed but recoverable transaction will be reattempted after rolling back.
It is an error to start a transaction if another transaction is already in progress.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter-service/","title":"TransacterService - Misk","text":"//misk-hibernate/misk.hibernate/TransacterService
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter-service/#transacterservice","title":"TransacterService","text":"[jvm]\\ interface TransacterService : Service
Marker interface for services that provide database transactors.
Services that require a database connection should depend on this interface when they are installed in a module.
e.g.
install(ServiceModule<MoviesService>()\n .dependsOn<TransacterService>(Movies::class))\n//misk-hibernate/misk.hibernate/TransformedType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/#transformedtype","title":"TransformedType","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])
annotation class TransformedType(val transformer: KClass<out Transformer>, val targetType: KClass<*>)
TransformedType is a meta-annotation for assigning arbitrary transformers to entity fields. Use it to annotate attributes that will mark a field to be transformed.
transformer is a KClass instance of a class that implements assemble and disassemble methods. Assemble is called when a value is read from the table, or from cache. Disassemble is called when a value is about to be written to a table or cache.
targetType specifies a KClass instance of the type that the field should have when disassembled. It is used to determine the backing SQL type.
The methods of Transformer additionally take a field representing the annotated field and a TransformerContext, which contains limited entity state, including the name of the table and the column, the arguments the annotation received.
Note!: Wrapping basic numberic types may not behave as one would expect, especially when querying. This is partly due to Hibernate\u2019s inlining of primitive values.
For example, one can define a transformer that appends a value to a string prior to storage, and removes it after retrieval. First, define the Transformer itself
class AppendTransformer(val context: TransformerContext) { fun assemble(owner: Any?, value: Serializable): Any = (value as String).removeSuffix(context.arguments\"suffix\" as String))
fun disassemble(value: Any): Serializable = \"${value as String}${context.arguments\"suffix\" as String}\" }
Then, create the entity annotation:
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/#properties","title":"Properties","text":"Name Summary targetType [jvm]val targetType: KClass<*> transformer [jvm]val transformer: KClass<out Transformer>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/target-type/","title":"targetType - Misk","text":"//misk-hibernate/misk.hibernate/TransformedType/targetType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/target-type/#targettype","title":"targetType","text":"[jvm]\\ val targetType: KClass<*>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/transformer/","title":"transformer - Misk","text":"//misk-hibernate/misk.hibernate/TransformedType/transformer
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/transformer/#transformer","title":"transformer","text":"[jvm]\\ val transformer: KClass<out Transformer>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/","title":"Transformer - Misk","text":"//misk-hibernate/misk.hibernate/Transformer
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#transformer","title":"Transformer","text":"[jvm]\\ abstract class Transformer(val context: TransformerContext)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#constructors","title":"Constructors","text":"Transformer [jvm]constructor(context: TransformerContext)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#properties","title":"Properties","text":"Name Summary context [jvm]val context: TransformerContext"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#functions","title":"Functions","text":"Name Summary assemble [jvm]abstract fun assemble(owner: Any?, value: Serializable): Any disassemble [jvm]abstract fun disassemble(value: Any): Serializable"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/-transformer/","title":"Transformer - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/Transformer
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/-transformer/#transformer","title":"Transformer","text":"[jvm]\\ constructor(context: TransformerContext)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/assemble/","title":"assemble - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/assemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/assemble/#assemble","title":"assemble","text":"[jvm]\\ abstract fun assemble(owner: Any?, value: Serializable): Any
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/context/","title":"context - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/context
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/context/#context","title":"context","text":"[jvm]\\ val context: TransformerContext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/disassemble/","title":"disassemble - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/disassemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/disassemble/#disassemble","title":"disassemble","text":"[jvm]\\ abstract fun disassemble(value: Any): Serializable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/","title":"TransformerContext - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/#transformercontext","title":"TransformerContext","text":"[jvm]\\ data class TransformerContext(val tableName: String, val columnName: String, var arguments: Map<String, >, var field: KClass<>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/#constructors","title":"Constructors","text":"TransformerContext [jvm]constructor(tableName: String, columnName: String, arguments: Map<String, >, field: KClass<>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/#properties","title":"Properties","text":"Name Summary arguments [jvm]var arguments: Map<String, *> columnName [jvm]val columnName: String field [jvm]var field: KClass<*> tableName [jvm]val tableName: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/-transformer-context/","title":"TransformerContext - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/TransformerContext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/-transformer-context/#transformercontext","title":"TransformerContext","text":"[jvm]\\ constructor(tableName: String, columnName: String, arguments: Map<String, >, field: KClass<>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/arguments/","title":"arguments - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/arguments
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/arguments/#arguments","title":"arguments","text":"[jvm]\\ var arguments: Map<String, *>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/column-name/","title":"columnName - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/columnName
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/column-name/#columnname","title":"columnName","text":"[jvm]\\ val columnName: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/field/","title":"field - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/field
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/field/#field","title":"field","text":"[jvm]\\ var field: KClass<*>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/table-name/","title":"tableName - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/tableName
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/table-name/#tablename","title":"tableName","text":"[jvm]\\ val tableName: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/","title":"ValidationReport - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/#validationreport","title":"ValidationReport","text":"[jvm]\\ data class ValidationReport(val schemas: Set<String>, val tables: Set<String>, val columns: Set<String>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/#constructors","title":"Constructors","text":"ValidationReport [jvm]constructor(schemas: Set<String>, tables: Set<String>, columns: Set<String>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/#properties","title":"Properties","text":"Name Summary columns [jvm]val columns: Set<String> schemas [jvm]val schemas: Set<String> tables [jvm]val tables: Set<String>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/-validation-report/","title":"ValidationReport - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/ValidationReport
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/-validation-report/#validationreport","title":"ValidationReport","text":"[jvm]\\ constructor(schemas: Set<String>, tables: Set<String>, columns: Set<String>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/columns/","title":"columns - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/columns
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/columns/#columns","title":"columns","text":"[jvm]\\ val columns: Set<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/schemas/","title":"schemas - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/schemas
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/schemas/#schemas","title":"schemas","text":"[jvm]\\ val schemas: Set<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/tables/","title":"tables - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/tables
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/tables/#tables","title":"tables","text":"[jvm]\\ val tables: Set<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/","title":"VitessDialect - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#vitessdialect","title":"VitessDialect","text":"[jvm]\\ class VitessDialect : MySQL57Dialect
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#constructors","title":"Constructors","text":"VitessDialect [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#properties","title":"Properties","text":"Name Summary uniqueDelegate [jvm]val uniqueDelegate: UniqueDelegate"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#functions","title":"Functions","text":"Name Summary addSqlHintOrComment [jvm]open fun addSqlHintOrComment(p0: String, p1: QueryParameters, p2: Boolean): String appendLockHint [jvm]open fun appendLockHint(p0: LockOptions, p1: String): String applyLocksToSql [jvm]open fun applyLocksToSql(p0: String, p1: LockOptions, p2: MutableMap<String, Array<String>>): String areStringComparisonsCaseInsensitive [jvm]open override fun areStringComparisonsCaseInsensitive(): Boolean augmentPhysicalTableTypes [jvm]open fun augmentPhysicalTableTypes(p0: MutableList<String>) augmentRecognizedTableTypes [jvm]open fun augmentRecognizedTableTypes(p0: MutableList<String>) buildIdentifierHelper [jvm]open override fun buildIdentifierHelper(p0: IdentifierHelperBuilder, p1: DatabaseMetaData): IdentifierHelper buildSQLExceptionConversionDelegate [jvm]open override fun buildSQLExceptionConversionDelegate(): SQLExceptionConversionDelegate canCreateCatalog [jvm]open override fun canCreateCatalog(): Boolean canCreateSchema [jvm]open override fun canCreateSchema(): Boolean cast [jvm]open fun cast(p0: String, p1: Int, p2: Int): Stringopen fun cast(p0: String, p1: Int, p2: Int, p3: Int): Stringopen fun cast(p0: String, p1: Int, p2: Int, p3: Int, p4: Int): String closeQuote [jvm]open override fun closeQuote(): Char contributeTypes [jvm]open fun contributeTypes(p0: TypeContributions, p1: ServiceRegistry) createCaseFragment [jvm]open fun createCaseFragment(): CaseFragment createOuterJoinFragment [jvm]open fun createOuterJoinFragment(): JoinFragment defaultScrollMode [jvm]open fun defaultScrollMode(): ScrollMode doesReadCommittedCauseWritersToBlockReaders [jvm]open fun doesReadCommittedCauseWritersToBlockReaders(): Boolean doesRepeatableReadCauseReadersToBlockWriters [jvm]open fun doesRepeatableReadCauseReadersToBlockWriters(): Boolean dropConstraints [jvm]open override fun dropConstraints(): Boolean equivalentTypes [jvm]open fun equivalentTypes(p0: Int, p1: Int): Boolean forceLobAsLastValue [jvm]open fun forceLobAsLastValue(): Boolean forUpdateOfColumns [jvm]open fun forUpdateOfColumns(): Boolean getAddColumnString [jvm]open override fun getAddColumnString(): String getAddColumnSuffixString [jvm]open fun getAddColumnSuffixString(): String getAddForeignKeyConstraintString [jvm]open fun getAddForeignKeyConstraintString(p0: String, p1: String): Stringopen override fun getAddForeignKeyConstraintString(p0: String, p1: Array<String>, p2: String, p3: Array<String>, p4: Boolean): String getAddPrimaryKeyConstraintString [jvm]open fun getAddPrimaryKeyConstraintString(p0: String): String getAlterTableString [jvm]open fun getAlterTableString(p0: String): String getAuxiliaryDatabaseObjectExporter [jvm]open fun getAuxiliaryDatabaseObjectExporter(): Exporter<AuxiliaryDatabaseObject> getCallableStatementSupport [jvm]open fun getCallableStatementSupport(): CallableStatementSupport getCascadeConstraintsString [jvm]open fun getCascadeConstraintsString(): String getCaseInsensitiveLike [jvm]open fun getCaseInsensitiveLike(): String getCastTypeName [jvm]open override fun getCastTypeName(p0: Int): String getColumnAliasExtractor [jvm]open fun getColumnAliasExtractor(): ColumnAliasExtractor getColumnComment [jvm]open override fun getColumnComment(p0: String): String getCreateCatalogCommand [jvm]open override fun getCreateCatalogCommand(p0: String): Array<String> getCreateMultisetTableString [jvm]open fun getCreateMultisetTableString(): String getCreateSchemaCommand [jvm]open override fun getCreateSchemaCommand(p0: String): Array<String> getCreateSequenceStrings [jvm]open fun getCreateSequenceStrings(p0: String, p1: Int, p2: Int): Array<String> getCreateTableString [jvm]open fun getCreateTableString(): String getCreateTemporaryTableColumnAnnotation [jvm]open fun getCreateTemporaryTableColumnAnnotation(p0: Int): String getCrossJoinSeparator [jvm]open fun getCrossJoinSeparator(): String getCurrentSchemaCommand [jvm]open fun getCurrentSchemaCommand(): String getCurrentTimestampSelectString [jvm]open override fun getCurrentTimestampSelectString(): String getCurrentTimestampSQLFunctionName [jvm]open fun getCurrentTimestampSQLFunctionName(): String getDefaultBatchLoadSizingStrategy [jvm]open fun getDefaultBatchLoadSizingStrategy(): BatchLoadSizingStrategy getDefaultMultiTableBulkIdStrategy [jvm]open override fun getDefaultMultiTableBulkIdStrategy(): MultiTableBulkIdStrategy getDefaultProperties [jvm]fun getDefaultProperties(): Properties getDropCatalogCommand [jvm]open override fun getDropCatalogCommand(p0: String): Array<String> getDropForeignKeyString [jvm]open override fun getDropForeignKeyString(): String getDropSchemaCommand [jvm]open override fun getDropSchemaCommand(p0: String): Array<String> getDropSequenceStrings [jvm]open fun getDropSequenceStrings(p0: String): Array<String> getDropTableString [jvm]open fun getDropTableString(p0: String): String getForeignKeyExporter [jvm]open fun getForeignKeyExporter(): Exporter<ForeignKey> getForUpdateNowaitString [jvm]open fun getForUpdateNowaitString(): Stringopen fun getForUpdateNowaitString(p0: String): String getForUpdateSkipLockedString [jvm]open fun getForUpdateSkipLockedString(): Stringopen fun getForUpdateSkipLockedString(p0: String): String getForUpdateString [jvm]open fun getForUpdateString(p0: String): Stringopen fun getForUpdateString(p0: LockMode): Stringopen fun getForUpdateString(p0: LockOptions): Stringopen fun getForUpdateString(p0: String, p1: LockOptions): Stringopen override fun getForUpdateString(): String getFunctions [jvm]fun getFunctions(): MutableMap<String, SQLFunction> getHibernateTypeName [jvm]open fun getHibernateTypeName(p0: Int): Stringopen fun getHibernateTypeName(p0: Int, p1: Int, p2: Int, p3: Int): String getIdentityColumnSupport [jvm]open override fun getIdentityColumnSupport(): IdentityColumnSupport getIndexExporter [jvm]open fun getIndexExporter(): Exporter<Index> getInExpressionCountLimit [jvm]open fun getInExpressionCountLimit(): Int getLimitHandler [jvm]open override fun getLimitHandler(): LimitHandler getLimitString [jvm]open override fun getLimitString(p0: String, p1: Boolean): String getLobMergeStrategy [jvm]open fun getLobMergeStrategy(): LobMergeStrategy getLockingStrategy [jvm]open fun getLockingStrategy(p0: Lockable, p1: LockMode): LockingStrategy getLowercaseFunction [jvm]open fun getLowercaseFunction(): String getMaxAliasLength [jvm]open fun getMaxAliasLength(): Int getNameQualifierSupport [jvm]open override fun getNameQualifierSupport(): NameQualifierSupport getNativeIdentifierGeneratorStrategy [jvm]open fun getNativeIdentifierGeneratorStrategy(): String getNoColumnsInsertString [jvm]open fun getNoColumnsInsertString(): String getNotExpression [jvm]open override fun getNotExpression(p0: String): String getNullColumnString [jvm]open fun getNullColumnString(): String getQueryHintString [jvm]open fun getQueryHintString(p0: String, p1: MutableList<String>): Stringopen override fun getQueryHintString(p0: String, p1: String): String getQuerySequencesString [jvm]open fun getQuerySequencesString(): String getReadLockString [jvm]open fun getReadLockString(p0: String, p1: Int): Stringopen override fun getReadLockString(p0: Int): String getResultSet [jvm]open fun getResultSet(p0: CallableStatement, p1: Int): ResultSetopen fun getResultSet(p0: CallableStatement, p1: String): ResultSetopen override fun getResultSet(p0: CallableStatement): ResultSet getSchemaNameResolver [jvm]open fun getSchemaNameResolver(): SchemaNameResolver getSelectClauseNullString [jvm]open fun getSelectClauseNullString(p0: Int): String getSelectGUIDString [jvm]open override fun getSelectGUIDString(): String getSelectSequenceNextValString [jvm]open fun getSelectSequenceNextValString(p0: String): String getSequenceExporter [jvm]open fun getSequenceExporter(): Exporter<Sequence> getSequenceInformationExtractor [jvm]open fun getSequenceInformationExtractor(): SequenceInformationExtractor getSequenceNextValString [jvm]open fun getSequenceNextValString(p0: String): String getTableComment [jvm]open override fun getTableComment(p0: String): String getTableExporter [jvm]open fun getTableExporter(): Exporter<Table> getTableTypeString [jvm]open override fun getTableTypeString(): String getTypeName [jvm]open fun getTypeName(p0: Int): Stringopen fun getTypeName(p0: Int, p1: Long, p2: Int, p3: Int): String getUniqueKeyExporter [jvm]open fun getUniqueKeyExporter(): Exporter<Constraint> getViolatedConstraintNameExtracter [jvm]open override fun getViolatedConstraintNameExtracter(): ViolatedConstraintNameExtracter getWriteLockString [jvm]open fun getWriteLockString(p0: String, p1: Int): Stringopen override fun getWriteLockString(p0: Int): String hasAlterTable [jvm]open fun hasAlterTable(): Boolean hasSelfReferentialForeignKeyBug [jvm]open override fun hasSelfReferentialForeignKeyBug(): Boolean inlineLiteral [jvm]open fun inlineLiteral(p0: String): String isCurrentTimestampSelectStringCallable [jvm]open override fun isCurrentTimestampSelectStringCallable(): Boolean isJdbcLogWarningsEnabledByDefault [jvm]open override fun isJdbcLogWarningsEnabledByDefault(): Boolean isLegacyLimitHandlerBehaviorEnabled [jvm]open fun isLegacyLimitHandlerBehaviorEnabled(): Boolean isLockTimeoutParameterized [jvm]open fun isLockTimeoutParameterized(): Boolean isTypeNameRegistered [jvm]open fun isTypeNameRegistered(p0: String): Boolean openQuote [jvm]open override fun openQuote(): Char qualifyIndexName [jvm]open override fun qualifyIndexName(): Boolean quote [jvm]fun quote(p0: String): String registerResultSetOutParameter [jvm]open fun registerResultSetOutParameter(p0: CallableStatement, p1: String): Intopen override fun registerResultSetOutParameter(p0: CallableStatement, p1: Int): Int remapSqlTypeDescriptor [jvm]open fun remapSqlTypeDescriptor(p0: SqlTypeDescriptor): SqlTypeDescriptor renderOrderByElement [jvm]open override fun renderOrderByElement(p0: String, p1: String, p2: String, p3: NullPrecedence): String replaceResultVariableInOrderByClauseWithPosition [jvm]open fun replaceResultVariableInOrderByClauseWithPosition(): Boolean requiresCastingOfParametersInSelectClause [jvm]open fun requiresCastingOfParametersInSelectClause(): Boolean requiresParensForTupleDistinctCounts [jvm]open fun requiresParensForTupleDistinctCounts(): Boolean supportsBindAsCallableArgument [jvm]open fun supportsBindAsCallableArgument(): Boolean supportsCascadeDelete [jvm]open override fun supportsCascadeDelete(): Boolean supportsCaseInsensitiveLike [jvm]open fun supportsCaseInsensitiveLike(): Boolean supportsCircularCascadeDeleteConstraints [jvm]open fun supportsCircularCascadeDeleteConstraints(): Boolean supportsColumnCheck [jvm]open override fun supportsColumnCheck(): Boolean supportsCommentOn [jvm]open fun supportsCommentOn(): Boolean supportsCurrentTimestampSelection [jvm]open override fun supportsCurrentTimestampSelection(): Boolean supportsEmptyInList [jvm]open override fun supportsEmptyInList(): Boolean supportsExistsInSelect [jvm]open fun supportsExistsInSelect(): Boolean supportsExpectedLobUsagePattern [jvm]open fun supportsExpectedLobUsagePattern(): Boolean supportsIfExistsAfterAlterTable [jvm]open fun supportsIfExistsAfterAlterTable(): Boolean supportsIfExistsAfterConstraintName [jvm]open fun supportsIfExistsAfterConstraintName(): Boolean supportsIfExistsAfterTableName [jvm]open fun supportsIfExistsAfterTableName(): Boolean supportsIfExistsBeforeConstraintName [jvm]open fun supportsIfExistsBeforeConstraintName(): Boolean supportsIfExistsBeforeTableName [jvm]open override fun supportsIfExistsBeforeTableName(): Boolean supportsJdbcConnectionLobCreation [jvm]open fun supportsJdbcConnectionLobCreation(p0: DatabaseMetaData): Boolean supportsLimit [jvm]open override fun supportsLimit(): Boolean supportsLobValueChangePropogation [jvm]open override fun supportsLobValueChangePropogation(): Boolean supportsLockTimeouts [jvm]open override fun supportsLockTimeouts(): Boolean supportsNamedParameters [jvm]open fun supportsNamedParameters(p0: DatabaseMetaData): Boolean supportsNationalizedTypes [jvm]open fun supportsNationalizedTypes(): Boolean supportsNoColumnsInsert [jvm]open fun supportsNoColumnsInsert(): Boolean supportsNonQueryWithCTE [jvm]open fun supportsNonQueryWithCTE(): Boolean supportsNoWait [jvm]open fun supportsNoWait(): Boolean supportsOuterJoinForUpdate [jvm]open fun supportsOuterJoinForUpdate(): Boolean supportsParametersInInsertSelect [jvm]open fun supportsParametersInInsertSelect(): Boolean supportsPartitionBy [jvm]open fun supportsPartitionBy(): Boolean supportsPooledSequences [jvm]open fun supportsPooledSequences(): Boolean supportsResultSetPositionQueryMethodsOnForwardOnlyCursor [jvm]open fun supportsResultSetPositionQueryMethodsOnForwardOnlyCursor(): Boolean supportsRowValueConstructorSyntax [jvm]open override fun supportsRowValueConstructorSyntax(): Boolean supportsRowValueConstructorSyntaxInInList [jvm]open override fun supportsRowValueConstructorSyntaxInInList(): Boolean supportsRowValueConstructorSyntaxInSet [jvm]open override fun supportsRowValueConstructorSyntaxInSet(): Boolean supportsSelectAliasInGroupByClause [jvm]open override fun supportsSelectAliasInGroupByClause(): Boolean supportsSequences [jvm]open fun supportsSequences(): Boolean supportsSkipLocked [jvm]open fun supportsSkipLocked(): Boolean supportsSubqueryOnMutatingTable [jvm]open override fun supportsSubqueryOnMutatingTable(): Boolean supportsSubselectAsInPredicateLHS [jvm]open fun supportsSubselectAsInPredicateLHS(): Boolean supportsTableCheck [jvm]open fun supportsTableCheck(): Boolean supportsTupleCounts [jvm]open fun supportsTupleCounts(): Boolean supportsTupleDistinctCounts [jvm]open fun supportsTupleDistinctCounts(): Boolean supportsTuplesInSubqueries [jvm]open fun supportsTuplesInSubqueries(): Boolean supportsUnboundedLobLocatorMaterialization [jvm]open fun supportsUnboundedLobLocatorMaterialization(): Boolean supportsUnionAll [jvm]open override fun supportsUnionAll(): Boolean supportsValuesList [jvm]open fun supportsValuesList(): Boolean toBooleanValueString [jvm]open fun toBooleanValueString(p0: Boolean): String toString [jvm]open override fun toString(): String transformSelectString [jvm]open fun transformSelectString(p0: String): String useFollowOnLocking [jvm]open fun useFollowOnLocking(p0: QueryParameters): Boolean useInputStreamToInsertBlob [jvm]open override fun useInputStreamToInsertBlob(): Boolean"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/-vitess-dialect/","title":"VitessDialect - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect/VitessDialect
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/-vitess-dialect/#vitessdialect","title":"VitessDialect","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/build-s-q-l-exception-conversion-delegate/","title":"buildSQLExceptionConversionDelegate - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect/buildSQLExceptionConversionDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/build-s-q-l-exception-conversion-delegate/#buildsqlexceptionconversiondelegate","title":"buildSQLExceptionConversionDelegate","text":"[jvm]\\ open override fun buildSQLExceptionConversionDelegate(): SQLExceptionConversionDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/use-input-stream-to-insert-blob/","title":"useInputStreamToInsertBlob - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect/useInputStreamToInsertBlob
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/use-input-stream-to-insert-blob/#useinputstreamtoinsertblob","title":"useInputStreamToInsertBlob","text":"[jvm]\\ open override fun useInputStreamToInsertBlob(): Boolean
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate.annotation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/#types","title":"Types","text":"Name Summary Keyspace [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])annotation class Keyspace(val value: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/#functions","title":"Functions","text":"Name Summary keyspace [jvm]fun Keyspace.keyspace(): Keyspace"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/keyspace/","title":"keyspace - Misk","text":"//misk-hibernate/misk.hibernate.annotation/keyspace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/keyspace/#keyspace","title":"keyspace","text":"[jvm]\\ fun Keyspace.keyspace(): Keyspace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/","title":"Keyspace - Misk","text":"//misk-hibernate/misk.hibernate.annotation/Keyspace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class Keyspace(val value: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/#functions","title":"Functions","text":"Name Summary keyspace [jvm]fun Keyspace.keyspace(): Keyspace"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/value/","title":"value - Misk","text":"//misk-hibernate/misk.hibernate.annotation/Keyspace/value
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate.migrate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/#types","title":"Types","text":"Name Summary BulkShardMigrator [jvm]class BulkShardMigrator<R : DbRoot<R>, C : DbChild<R, C>>BulkShardMigrator facilitates moving of child entities belonging to a source root entity to target root entity in bulk. Source or target entity can either live on the same or different shards."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/","title":"BulkShardMigrator - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/#bulkshardmigrator","title":"BulkShardMigrator","text":"[jvm]\\ class BulkShardMigrator<R : DbRoot<R>, C : DbChild<R, C>>
BulkShardMigrator facilitates moving of child entities belonging to a source root entity to target root entity in bulk. Source or target entity can either live on the same or different shards.
If moving between shards it will copy the rows between shards using a SELECT and a batched INSERT statements. The mutations are applied to the result set in memory between the SELECT and the batch INSERT.
An example of moving rows from characters table that is sharded by movie_id from source_id to target_id:
bulkShardMigratorFactory.create(transacter, sessionFactory, DbMovie::class, DbCharacter::class) .rootColumn(\"movie_id\") .source(sourceId) .target(targetId) .execute()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Factory [jvm]@Singletonclass Factory@Injectconstructor IncMutation [jvm]class IncMutation(column: String) : BulkShardMigrator.Mutation Mutation [jvm]abstract class Mutation NowMutation [jvm]class NowMutation(column: String) : BulkShardMigrator.Mutation SetMappingMutation [jvm]class SetMappingMutation(column: String, valueMapper: Function<Any, Any>) : BulkShardMigrator.Mutation SetMutation [jvm]class SetMutation(column: String, value: Any) : BulkShardMigrator.Mutation"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/#functions","title":"Functions","text":"Name Summary batched [jvm]fun batched(): BulkShardMigrator<R, C> batchSize [jvm]fun batchSize(batchSize: Int): BulkShardMigrator<R, C> execute [jvm]@JvmOverloadsfun execute(insertIgnore: Boolean = false) inc [jvm]operator fun inc(column: String): BulkShardMigrator<R, C> latestBatchOnly [jvm]fun latestBatchOnly(latestBatchOnly: Boolean): BulkShardMigrator<R, C> now [jvm]fun now(column: String): BulkShardMigrator<R, C> rootColumn [jvm]fun rootColumn(columnName: String): BulkShardMigrator<R, C> set [jvm]operator fun set(column: String, valueMapper: Function<Any, Any>): BulkShardMigrator<R, C>operator fun set(column: String, value: Any): BulkShardMigrator<R, C> source [jvm]fun source(sourceRoot: Id<R>): BulkShardMigrator<R, C> target [jvm]fun target(targetRoot: Id<R>): BulkShardMigrator<R, C> where [jvm]fun where(where: String, vararg parameters: Any): BulkShardMigrator<R, C>fun where(where: String, parameters: List<*>): BulkShardMigrator<R, C>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batch-size/","title":"batchSize - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/batchSize
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batch-size/#batchsize","title":"batchSize","text":"[jvm]\\ fun batchSize(batchSize: Int): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batched/","title":"batched - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/batched
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batched/#batched","title":"batched","text":"[jvm]\\ fun batched(): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/execute/","title":"execute - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/execute
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/execute/#execute","title":"execute","text":"[jvm]\\
@JvmOverloads
fun execute(insertIgnore: Boolean = false)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/inc/","title":"inc - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/inc
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/inc/#inc","title":"inc","text":"[jvm]\\ operator fun inc(column: String): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/latest-batch-only/","title":"latestBatchOnly - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/latestBatchOnly
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/latest-batch-only/#latestbatchonly","title":"latestBatchOnly","text":"[jvm]\\ fun latestBatchOnly(latestBatchOnly: Boolean): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/now/","title":"now - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/now
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/now/#now","title":"now","text":"[jvm]\\ fun now(column: String): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/root-column/","title":"rootColumn - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/rootColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/root-column/#rootcolumn","title":"rootColumn","text":"[jvm]\\ fun rootColumn(columnName: String): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/set/","title":"set - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/set
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/set/#set","title":"set","text":"[jvm]\\ operator fun set(column: String, value: Any): BulkShardMigrator<R, C>
operator fun set(column: String, valueMapper: Function<Any, Any>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/source/","title":"source - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/source
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/source/#source","title":"source","text":"[jvm]\\ fun source(sourceRoot: Id<R>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/target/","title":"target - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/target
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/target/#target","title":"target","text":"[jvm]\\ fun target(targetRoot: Id<R>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/where/","title":"where - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/where
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/where/#where","title":"where","text":"[jvm]\\ fun where(where: String, vararg parameters: Any): BulkShardMigrator<R, C>
fun where(where: String, parameters: List<*>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-companion/","title":"Companion - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/","title":"Factory - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Factory
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun <R : DbRoot<R>, C : DbChild<R, C>> create(transacter: Transacter, sessionFactory: SessionFactory, rootClass: KClass<R>, childClass: KClass<C>): BulkShardMigrator<R, C>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/-factory/","title":"Factory - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Factory/Factory
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/create/","title":"create - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Factory/create
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/create/#create","title":"create","text":"[jvm]\\ fun <R : DbRoot<R>, C : DbChild<R, C>> create(transacter: Transacter, sessionFactory: SessionFactory, rootClass: KClass<R>, childClass: KClass<C>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/","title":"IncMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/#incmutation","title":"IncMutation","text":"[jvm]\\ class IncMutation(column: String) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/#constructors","title":"Constructors","text":"IncMutation [jvm]constructor(column: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open override fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/-inc-mutation/","title":"IncMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/IncMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/-inc-mutation/#incmutation","title":"IncMutation","text":"[jvm]\\ constructor(column: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/update-sql/","title":"updateSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/updateSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/update-sql/#updatesql","title":"updateSql","text":"[jvm]\\ open override fun updateSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/","title":"Mutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#mutation","title":"Mutation","text":"abstract class Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#inheritors","title":"Inheritors","text":"SetMutation SetMappingMutation NowMutation IncMutation"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#constructors","title":"Constructors","text":"Mutation [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]abstract fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/-mutation/","title":"Mutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/-mutation/#mutation","title":"Mutation","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ abstract fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/insert-sql/","title":"insertSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/insertSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/insert-sql/#insertsql","title":"insertSql","text":"[jvm]\\ open fun insertSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/update-sql/","title":"updateSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/updateSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/update-sql/#updatesql","title":"updateSql","text":"[jvm]\\ open fun updateSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/","title":"NowMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/#nowmutation","title":"NowMutation","text":"[jvm]\\ class NowMutation(column: String) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/#constructors","title":"Constructors","text":"NowMutation [jvm]constructor(column: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open override fun insertSql(): String updateSql [jvm]open override fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/-now-mutation/","title":"NowMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/NowMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/-now-mutation/#nowmutation","title":"NowMutation","text":"[jvm]\\ constructor(column: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/insert-sql/","title":"insertSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/insertSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/insert-sql/#insertsql","title":"insertSql","text":"[jvm]\\ open override fun insertSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/update-sql/","title":"updateSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/updateSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/update-sql/#updatesql","title":"updateSql","text":"[jvm]\\ open override fun updateSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/","title":"SetMappingMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/#setmappingmutation","title":"SetMappingMutation","text":"[jvm]\\ class SetMappingMutation(column: String, valueMapper: Function<Any, Any>) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/#constructors","title":"Constructors","text":"SetMappingMutation [jvm]constructor(column: String, valueMapper: Function<Any, Any>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/-set-mapping-mutation/","title":"SetMappingMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation/SetMappingMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/-set-mapping-mutation/#setmappingmutation","title":"SetMappingMutation","text":"[jvm]\\ constructor(column: String, valueMapper: Function<Any, Any>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/","title":"SetMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/#setmutation","title":"SetMutation","text":"[jvm]\\ class SetMutation(column: String, value: Any) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/#constructors","title":"Constructors","text":"SetMutation [jvm]constructor(column: String, value: Any)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/-set-mutation/","title":"SetMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation/SetMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/-set-mutation/#setmutation","title":"SetMutation","text":"[jvm]\\ constructor(column: String, value: Any)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate.pagination
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/#types","title":"Types","text":"Name Summary Offset [jvm]data class Offset(val offset: String)Offset into a query. Typically this is a string-encoded ID like 5, or a composite containing a date followed by an ID, like \"2019-08-16T:10:26:51Z/5\". Page [jvm]data class Page<T>(val contents: List<T>, val nextOffset: Offset?) Pager [jvm]interface Pager<T> Paginator [jvm]interface Paginator<T, in Q : Query<T>>Breaks a query into pages. Each page break is delimited by a string that is the offset of the last row of the preceding page."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/#functions","title":"Functions","text":"Name Summary idAscPaginator [jvm]fun <T : DbEntity<T>> idAscPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>Pages through entities by ascending ID. idDescPaginator [jvm]fun <T : DbEntity<T>> idDescPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>Pages through entities by descending ID. listAll [jvm]fun <T : DbEntity<T>, R> Pager<T>.listAll(transacter: Transacter, transform: (T) -> R): List<R> newPager [jvm]fun <T : DbEntity<T>, Q : Query<T>> Q.newPager(paginator: Paginator<T, Q>, initialOffset: Offset? = null, pageSize: Int = 100): Pager<T>Use a null initialOffset to start at the beginning."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-asc-paginator/","title":"idAscPaginator - Misk","text":"//misk-hibernate/misk.hibernate.pagination/idAscPaginator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-asc-paginator/#idascpaginator","title":"idAscPaginator","text":"[jvm]\\ fun <T : DbEntity<T>> idAscPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>
Pages through entities by ascending ID.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-desc-paginator/","title":"idDescPaginator - Misk","text":"//misk-hibernate/misk.hibernate.pagination/idDescPaginator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-desc-paginator/#iddescpaginator","title":"idDescPaginator","text":"[jvm]\\ fun <T : DbEntity<T>> idDescPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>
Pages through entities by descending ID.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/list-all/","title":"listAll - Misk","text":"//misk-hibernate/misk.hibernate.pagination/listAll
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/list-all/#listall","title":"listAll","text":"[jvm]\\ fun <T : DbEntity<T>, R> Pager<T>.listAll(transacter: Transacter, transform: (T) -> R): List<R>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/new-pager/","title":"newPager - Misk","text":"//misk-hibernate/misk.hibernate.pagination/newPager
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/new-pager/#newpager","title":"newPager","text":"[jvm]\\ fun <T : DbEntity<T>, Q : Query<T>> Q.newPager(paginator: Paginator<T, Q>, initialOffset: Offset? = null, pageSize: Int = 100): Pager<T>
Use a null initialOffset to start at the beginning.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/","title":"Offset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Offset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/#offset","title":"Offset","text":"[jvm]\\ data class Offset(val offset: String)
Offset into a query. Typically this is a string-encoded ID like 5, or a composite containing a date followed by an ID, like \"2019-08-16T:10:26:51Z/5\".
Don\u2019t put PII in here. Clients see these in URLs and API calls, and can manipulate them. This could also potentially leak database growth information!
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/#constructors","title":"Constructors","text":"Offset [jvm]constructor(offset: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/#properties","title":"Properties","text":"Name Summary offset [jvm]val offset: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/-offset/","title":"Offset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Offset/Offset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/-offset/#offset","title":"Offset","text":"[jvm]\\ constructor(offset: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/offset/","title":"offset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Offset/offset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/offset/#offset","title":"offset","text":"[jvm]\\ val offset: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/","title":"Page - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#page","title":"Page","text":"[jvm]\\ data class Page<T>(val contents: List<T>, val nextOffset: Offset?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#constructors","title":"Constructors","text":"Page [jvm]constructor(contents: List<T>, nextOffset: Offset?)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#properties","title":"Properties","text":"Name Summary contents [jvm]val contents: List<T> nextOffset [jvm]val nextOffset: Offset?Null if there are no more results. Pass this in a subsequent call to Query.newPager."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-page/","title":"Page - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/Page
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-page/#page","title":"Page","text":"[jvm]\\ constructor(contents: List<T>, nextOffset: Offset?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/contents/","title":"contents - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/contents
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/contents/#contents","title":"contents","text":"[jvm]\\ val contents: List<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/next-offset/","title":"nextOffset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/nextOffset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/next-offset/#nextoffset","title":"nextOffset","text":"[jvm]\\ val nextOffset: Offset?
Null if there are no more results. Pass this in a subsequent call to Query.newPager.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/","title":"Companion - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/#functions","title":"Functions","text":"Name Summary empty [jvm]fun <T> empty(): Page<T>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/empty/","title":"empty - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/Companion/empty
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/empty/#empty","title":"empty","text":"[jvm]\\ fun <T> empty(): Page<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/","title":"Pager - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Pager
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/#pager","title":"Pager","text":"[jvm]\\ interface Pager<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/#functions","title":"Functions","text":"Name Summary hasNext [jvm]abstract fun hasNext(): BooleanReturns true when there are more pages to load. listAll [jvm]fun <T : DbEntity<T>, R> Pager<T>.listAll(transacter: Transacter, transform: (T) -> R): List<R> nextPage [jvm]abstract fun nextPage(session: Session): Page<T>?Returns null when there are no more pages."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/has-next/","title":"hasNext - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Pager/hasNext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/has-next/#hasnext","title":"hasNext","text":"[jvm]\\ abstract fun hasNext(): Boolean
Returns true when there are more pages to load.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/next-page/","title":"nextPage - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Pager/nextPage
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/next-page/#nextpage","title":"nextPage","text":"[jvm]\\ abstract fun nextPage(session: Session): Page<T>?
Returns null when there are no more pages.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/","title":"Paginator - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Paginator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/#paginator","title":"Paginator","text":"[jvm]\\ interface Paginator<T, in Q : Query<T>>
Breaks a query into pages. Each page break is delimited by a string that is the offset of the last row of the preceding page.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/#functions","title":"Functions","text":"Name Summary applyOffset [jvm]abstract fun applyOffset(query: Q, offset: Offset?)Adjust query so that is in paging order and offset by offset (if non-null). Most implementations will add anORDER BY clause. They should also add a WHERE column > offset constraint if the offset is non-null. getOffset [jvm]abstract fun getOffset(row: T): OffsetFigure out what the offset of row is, and encode that as a string."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/apply-offset/","title":"applyOffset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Paginator/applyOffset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/apply-offset/#applyoffset","title":"applyOffset","text":"[jvm]\\ abstract fun applyOffset(query: Q, offset: Offset?)
Adjust query so that is in paging order and offset by offset (if non-null). Most implementations will add an ORDER BY clause. They should also add a WHERE column > offset constraint if the offset is non-null.
//misk-hibernate/misk.hibernate.pagination/Paginator/getOffset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/get-offset/#getoffset","title":"getOffset","text":"[jvm]\\ abstract fun getOffset(row: T): Offset
Figure out what the offset of row is, and encode that as a string.
"},{"location":"0.x/misk-hotwire/","title":"misk-hotwire - Misk","text":"//misk-hotwire
"},{"location":"0.x/misk-hotwire/#misk-hotwire","title":"misk-hotwire","text":""},{"location":"0.x/misk-hotwire/#packages","title":"Packages","text":"Name misk.hotwire misk.turbo"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/","title":"Package-level declarations - Misk","text":"//misk-hotwire/misk.hotwire
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/#functions","title":"Functions","text":"Name Summary buildHtml [jvm]fun buildHtml(renderer: TagConsumer<*>.() -> Unit): String buildHtmlResponseBody [jvm]fun buildHtmlResponseBody(renderer: TagConsumer<*>.() -> Unit): ResponseBody"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html-response-body/","title":"buildHtmlResponseBody - Misk","text":"//misk-hotwire/misk.hotwire/buildHtmlResponseBody
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html-response-body/#buildhtmlresponsebody","title":"buildHtmlResponseBody","text":"[jvm]\\ fun buildHtmlResponseBody(renderer: TagConsumer<*>.() -> Unit): ResponseBody
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html/","title":"buildHtml - Misk","text":"//misk-hotwire/misk.hotwire/buildHtml
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html/#buildhtml","title":"buildHtml","text":"[jvm]\\ fun buildHtml(renderer: TagConsumer<*>.() -> Unit): String
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/","title":"Package-level declarations - Misk","text":"//misk-hotwire/misk.turbo
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/#types","title":"Types","text":"Name Summary Template [jvm]class Template(consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTagProduces HTML tag as required to define Hotwire Turbo using kotlinx.html. TurboFrame [jvm]class TurboFrame@JvmOverloadsconstructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTagProduces HTML tag as required to define Hotwire Turbo using kotlinx.html. TurboStream [jvm]class TurboStream(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTagProduces HTML tag as required to define Hotwire Turbo using kotlinx.html. TurboStreamAction [jvm]enum TurboStreamAction : Enum<TurboStreamAction> Different modes for TurboStream to be handled and result in DOM changes when it arrives via WebSocket or in HTTP response."},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/#functions","title":"Functions","text":"Name Summary addHotwireHeadImports [jvm]fun TagConsumer<*>.addHotwireHeadImports(appRoot: String)HTML tags to add to Head to configure Hotwire (Turbo, Stimulus) dependencies and default controllers template [jvm]fun TagConsumer<*>.template(block: Template.() -> Unit = {}) turbo_frame [jvm]fun TagConsumer<*>.turbo_frame(id: String, src: String? = null, lazy: Boolean = false, block: TurboFrame.() -> Unit = {}) turbo_stream [jvm]fun TagConsumer<*>.turbo_stream(action: TurboStreamAction, targetId: String, block: TurboStream.() -> Unit = {})"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/add-hotwire-head-imports/","title":"addHotwireHeadImports - Misk","text":"//misk-hotwire/misk.turbo/addHotwireHeadImports
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/add-hotwire-head-imports/#addhotwireheadimports","title":"addHotwireHeadImports","text":"[jvm]\\ fun TagConsumer<*>.addHotwireHeadImports(appRoot: String)
HTML tags to add to Head to configure Hotwire (Turbo, Stimulus) dependencies and default controllers
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/template/","title":"template - Misk","text":"//misk-hotwire/misk.turbo/template
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/template/#template","title":"template","text":"[jvm]\\ fun TagConsumer<*>.template(block: Template.() -> Unit = {})
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_frame/","title":"turbo_frame - Misk","text":"//misk-hotwire/misk.turbo/turbo_frame
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_frame/#turbo_frame","title":"turbo_frame","text":"[jvm]\\ fun TagConsumer<*>.turbo_frame(id: String, src: String? = null, lazy: Boolean = false, block: TurboFrame.() -> Unit = {})
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_stream/","title":"turbo_stream - Misk","text":"//misk-hotwire/misk.turbo/turbo_stream
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_stream/#turbo_stream","title":"turbo_stream","text":"[jvm]\\ fun TagConsumer<*>.turbo_stream(action: TurboStreamAction, targetId: String, block: TurboStream.() -> Unit = {})
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/","title":"Template - Misk","text":"//misk-hotwire/misk.turbo/Template
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#template","title":"Template","text":"[jvm]\\ class Template(consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTag
Produces HTML tag as required to define Hotwire Turbo using kotlinx.html.
Follows the spec from Hotwire docs: https://turbo.hotwired.dev/handbook/streams
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#constructors","title":"Constructors","text":"Template [jvm]constructor(consumer: TagConsumer<*>)"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#properties","title":"Properties","text":"Name Summary attributes [jvm]open override val attributes: DelegatingMap attributesEntries [jvm]open override val attributesEntries: Collection<Map.Entry<String, String>> consumer [jvm]open override val consumer: TagConsumer<*> emptyTag [jvm]open override val emptyTag: Boolean inlineTag [jvm]open override val inlineTag: Boolean namespace [jvm]open override val namespace: String? tagName [jvm]open override val tagName: String"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#functions","title":"Functions","text":"Name Summary comment [jvm]open fun comment(s: String) entity [jvm]open fun entity(e: Entities) text [jvm]open fun text(n: Number)open fun text(s: String) unaryPlus [jvm]open operator fun String.unaryPlus()open operator fun Entities.unaryPlus()"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/-template/","title":"Template - Misk","text":"//misk-hotwire/misk.turbo/Template/Template
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/-template/#template","title":"Template","text":"[jvm]\\ constructor(consumer: TagConsumer<*>)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/","title":"TurboFrame - Misk","text":"//misk-hotwire/misk.turbo/TurboFrame
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#turboframe","title":"TurboFrame","text":"[jvm]\\ class TurboFrame@JvmOverloadsconstructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTag
Produces HTML tag as required to define Hotwire Turbo using kotlinx.html.
Follows the spec from Hotwire docs: https://turbo.hotwired.dev/handbook/frames
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#constructors","title":"Constructors","text":"TurboFrame [jvm]@JvmOverloadsconstructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>)"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#properties","title":"Properties","text":"Name Summary attributes [jvm]open override val attributes: DelegatingMap attributesEntries [jvm]open override val attributesEntries: Collection<Map.Entry<String, String>> consumer [jvm]open override val consumer: TagConsumer<*> emptyTag [jvm]open override val emptyTag: Boolean inlineTag [jvm]open override val inlineTag: Boolean namespace [jvm]open override val namespace: String? tagName [jvm]open override val tagName: String"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#functions","title":"Functions","text":"Name Summary comment [jvm]open fun comment(s: String) entity [jvm]open fun entity(e: Entities) text [jvm]open fun text(n: Number)open fun text(s: String) unaryPlus [jvm]open operator fun String.unaryPlus()open operator fun Entities.unaryPlus()"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/-turbo-frame/","title":"TurboFrame - Misk","text":"//misk-hotwire/misk.turbo/TurboFrame/TurboFrame
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/-turbo-frame/#turboframe","title":"TurboFrame","text":"[jvm]\\
@JvmOverloads
constructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/","title":"TurboStream - Misk","text":"//misk-hotwire/misk.turbo/TurboStream
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#turbostream","title":"TurboStream","text":"[jvm]\\ class TurboStream(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTag
Produces HTML tag as required to define Hotwire Turbo using kotlinx.html.
Example Produced HTML"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#constructors","title":"Constructors","text":"TurboStream [jvm]constructor(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>)"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#properties","title":"Properties","text":"Name Summary attributes [jvm]open override val attributes: DelegatingMap attributesEntries [jvm]open override val attributesEntries: Collection<Map.Entry<String, String>> consumer [jvm]open override val consumer: TagConsumer<*> emptyTag [jvm]open override val emptyTag: Boolean inlineTag [jvm]open override val inlineTag: Boolean namespace [jvm]open override val namespace: String? tagName [jvm]open override val tagName: String"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#functions","title":"Functions","text":"Name Summary comment [jvm]open fun comment(s: String) entity [jvm]open fun entity(e: Entities) text [jvm]open fun text(n: Number)open fun text(s: String) unaryPlus [jvm]open operator fun String.unaryPlus()open operator fun Entities.unaryPlus()"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/-turbo-stream/","title":"TurboStream - Misk","text":"
//misk-hotwire/misk.turbo/TurboStream/TurboStream
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/-turbo-stream/#turbostream","title":"TurboStream","text":"[jvm]\\ constructor(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/","title":"TurboStreamAction - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#turbostreamaction","title":"TurboStreamAction","text":"[jvm]\\ enum TurboStreamAction : Enum<TurboStreamAction>
Different modes for TurboStream to be handled and result in DOM changes when it arrives via WebSocket or in HTTP response.
https://turbo.hotwired.dev/handbook/streams
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#entries","title":"Entries","text":"APPEND [jvm]APPEND PREPEND [jvm]PREPEND REPLACE [jvm]REPLACE UPDATE [jvm]UPDATE REMOVE [jvm]REMOVE BEFORE [jvm]BEFORE AFTER [jvm]AFTER"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<TurboStreamAction>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): TurboStreamActionReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<TurboStreamAction>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/entries/","title":"entries - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/entries
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<TurboStreamAction>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/value-of/","title":"valueOf - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/valueOf
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): TurboStreamAction
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/values/","title":"values - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/values
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<TurboStreamAction>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-f-t-e-r/","title":"AFTER - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/AFTER
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-f-t-e-r/#after","title":"AFTER","text":"[jvm]\\ AFTER
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-f-t-e-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-p-p-e-n-d/","title":"APPEND - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/APPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-p-p-e-n-d/#append","title":"APPEND","text":"[jvm]\\ APPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-p-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-b-e-f-o-r-e/","title":"BEFORE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/BEFORE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-b-e-f-o-r-e/#before","title":"BEFORE","text":"[jvm]\\ BEFORE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-b-e-f-o-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-p-r-e-p-e-n-d/","title":"PREPEND - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/PREPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-p-r-e-p-e-n-d/#prepend","title":"PREPEND","text":"[jvm]\\ PREPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-p-r-e-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-m-o-v-e/","title":"REMOVE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/REMOVE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-m-o-v-e/#remove","title":"REMOVE","text":"[jvm]\\ REMOVE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-m-o-v-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-p-l-a-c-e/","title":"REPLACE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/REPLACE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-p-l-a-c-e/#replace","title":"REPLACE","text":"[jvm]\\ REPLACE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-p-l-a-c-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-u-p-d-a-t-e/","title":"UPDATE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/UPDATE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-u-p-d-a-t-e/#update","title":"UPDATE","text":"[jvm]\\ UPDATE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-u-p-d-a-t-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-inject/","title":"misk-inject - Misk","text":"//misk-inject
"},{"location":"0.x/misk-inject/#misk-inject","title":"misk-inject","text":""},{"location":"0.x/misk-inject/#packages","title":"Packages","text":"Name misk.inject"},{"location":"0.x/misk-inject/misk-inject/misk.inject/","title":"Package-level declarations - Misk","text":"//misk-inject/misk.inject
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-inject/misk-inject/misk.inject/#types","title":"Types","text":"Name Summary KAbstractModule [jvm]abstract class KAbstractModule : AbstractModuleA class that provides helper methods for working with Kotlin and Guice, allowing implementing classes to operate in the Kotlin type system rather than converting to Java. KInstallOnceModule [jvm]abstract class KInstallOnceModule : KAbstractModuleMake it safe to install multiple instances of this module. Guice will only install it once. ReusableTestModule [jvm]@ExperimentalMiskApiabstract class ReusableTestModule : KInstallOnceModuleThis class should be extended by test modules used in tests, for misk to reuse the guice injector across tests for significantly faster test suite performance."},{"location":"0.x/misk-inject/misk-inject/misk.inject/#functions","title":"Functions","text":"Name Summary asSingleton [jvm]fun ScopedBindingBuilder.asSingleton() getInstance [jvm]inline fun <T : Any> Injector.getInstance(annotation: Annotation? = null): T getSetOf [jvm]fun <T : Any> Injector.getSetOf(type: KClass<T>, annotation: KClass<out Annotation>? = null): Set<T> keyOf [jvm]inline fun <T : Any> keyOf(): Key<T>inline fun <T : Any> keyOf(a: Annotation): Key<T>[jvm]inline fun <T : Any> keyOf(a: KClass<out Annotation>?): Key<T>If annotation is not null, returns a key for @Annotation T, otherwise a key for T. listOfType [jvm]inline fun <T : Any> listOfType(): TypeLiteral<List<T>>fun <T> listOfType(elementType: TypeLiteral<T>): TypeLiteral<List<T>>fun <T : Any> listOfType(elementType: KClass<T>): TypeLiteral<List<T>> mapOfType [jvm]inline fun <K : Any, V : Any> mapOfType(): TypeLiteral<Map<K, V>>fun <K, V> mapOfType(keyType: TypeLiteral<K>, valueType: TypeLiteral<V>): TypeLiteral<Map<K, V>>fun <K : Any, V : Any> mapOfType(keyType: KClass<K>, valueType: KClass<V>): TypeLiteral<Map<K, V>> parameterizedType [jvm]inline fun <T : Any> parameterizedType(vararg typeParameters: Type): ParameterizedType setOfType [jvm]inline fun <T : Any> setOfType(): TypeLiteral<Set<T>>fun <T> setOfType(elementType: TypeLiteral<T>): TypeLiteral<Set<T>>fun <T : Any> setOfType(elementType: KClass<T>): TypeLiteral<Set<T>> subtypeOf [jvm]inline fun <T : Any> subtypeOf(): WildcardType toKey [jvm]fun <T : Any> TypeLiteral<T>.toKey(annotation: KClass<out Annotation>? = null): Key<T>fun <T : Any> KClass<T>.toKey(qualifier: KClass<out Annotation>? = null): Key<T> typeLiteral [jvm]fun Type.typeLiteral(): TypeLiteral<>fun <T : Any> KClass<T>.typeLiteral(): TypeLiteral<T>fun KType.typeLiteral(): TypeLiteral<> uninject [jvm]fun uninject(target: Any)"},{"location":"0.x/misk-inject/misk-inject/misk.inject/as-singleton/","title":"asSingleton - Misk","text":"//misk-inject/misk.inject/asSingleton
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/as-singleton/#assingleton","title":"asSingleton","text":"[jvm]\\ fun ScopedBindingBuilder.asSingleton()
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-instance/","title":"getInstance - Misk","text":"//misk-inject/misk.inject/getInstance
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-instance/#getinstance","title":"getInstance","text":"[jvm]\\ inline fun <T : Any> Injector.getInstance(annotation: Annotation? = null): T
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-set-of/","title":"getSetOf - Misk","text":"//misk-inject/misk.inject/getSetOf
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-set-of/#getsetof","title":"getSetOf","text":"[jvm]\\ fun <T : Any> Injector.getSetOf(type: KClass<T>, annotation: KClass<out Annotation>? = null): Set<T>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/key-of/","title":"keyOf - Misk","text":"//misk-inject/misk.inject/keyOf
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/key-of/#keyof","title":"keyOf","text":"[jvm]\\ inline fun <T : Any> keyOf(): Key<T>
inline fun <T : Any> keyOf(a: Annotation): Key<T>
[jvm]\\ inline fun <T : Any> keyOf(a: KClass<out Annotation>?): Key<T>
If annotation is not null, returns a key for @Annotation T, otherwise a key for T.
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/list-of-type/","title":"listOfType - Misk","text":"//misk-inject/misk.inject/listOfType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/list-of-type/#listoftype","title":"listOfType","text":"[jvm]\\ fun <T> listOfType(elementType: TypeLiteral<T>): TypeLiteral<List<T>>
fun <T : Any> listOfType(elementType: KClass<T>): TypeLiteral<List<T>>
inline fun <T : Any> listOfType(): TypeLiteral<List<T>>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/map-of-type/","title":"mapOfType - Misk","text":"//misk-inject/misk.inject/mapOfType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/map-of-type/#mapoftype","title":"mapOfType","text":"[jvm]\\ inline fun <K : Any, V : Any> mapOfType(): TypeLiteral<Map<K, V>>
fun <K : Any, V : Any> mapOfType(keyType: KClass<K>, valueType: KClass<V>): TypeLiteral<Map<K, V>>
fun <K, V> mapOfType(keyType: TypeLiteral<K>, valueType: TypeLiteral<V>): TypeLiteral<Map<K, V>>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/parameterized-type/","title":"parameterizedType - Misk","text":"//misk-inject/misk.inject/parameterizedType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/parameterized-type/#parameterizedtype","title":"parameterizedType","text":"[jvm]\\ inline fun <T : Any> parameterizedType(vararg typeParameters: Type): ParameterizedType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/set-of-type/","title":"setOfType - Misk","text":"//misk-inject/misk.inject/setOfType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/set-of-type/#setoftype","title":"setOfType","text":"[jvm]\\ fun <T> setOfType(elementType: TypeLiteral<T>): TypeLiteral<Set<T>>
fun <T : Any> setOfType(elementType: KClass<T>): TypeLiteral<Set<T>>
inline fun <T : Any> setOfType(): TypeLiteral<Set<T>>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/subtype-of/","title":"subtypeOf - Misk","text":"//misk-inject/misk.inject/subtypeOf
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/subtype-of/#subtypeof","title":"subtypeOf","text":"[jvm]\\ inline fun <T : Any> subtypeOf(): WildcardType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/to-key/","title":"toKey - Misk","text":"//misk-inject/misk.inject/toKey
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/to-key/#tokey","title":"toKey","text":"[jvm]\\ fun <T : Any> TypeLiteral<T>.toKey(annotation: KClass<out Annotation>? = null): Key<T>
fun <T : Any> KClass<T>.toKey(qualifier: KClass<out Annotation>? = null): Key<T>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/type-literal/","title":"typeLiteral - Misk","text":"//misk-inject/misk.inject/typeLiteral
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/type-literal/#typeliteral","title":"typeLiteral","text":"[jvm]\\ fun Type.typeLiteral(): TypeLiteral<*>
fun KType.typeLiteral(): TypeLiteral<*>
fun <T : Any> KClass<T>.typeLiteral(): TypeLiteral<T>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/uninject/","title":"uninject - Misk","text":"//misk-inject/misk.inject/uninject
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/uninject/#uninject","title":"uninject","text":"[jvm]\\ fun uninject(target: Any)
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-abstract-module/","title":"KAbstractModule - Misk","text":"//misk-inject/misk.inject/KAbstractModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-abstract-module/#kabstractmodule","title":"KAbstractModule","text":"abstract class KAbstractModule : AbstractModule
A class that provides helper methods for working with Kotlin and Guice, allowing implementing classes to operate in the Kotlin type system rather than converting to Java.
The more Kotlin friendly API allows calls like:
bind(Foo::class.java).to(RealFoo::class.java)\nTo be rewritten as:
bind<Foo>().to<RealFoo>()\n//misk-inject/misk.inject/KAbstractModule/KAbstractModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-abstract-module/-k-abstract-module/#kabstractmodule","title":"KAbstractModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/","title":"KInstallOnceModule - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#kinstalloncemodule","title":"KInstallOnceModule","text":"abstract class KInstallOnceModule : KAbstractModule
Make it safe to install multiple instances of this module. Guice will only install it once.
This eases dependency management of library/core dependencies which benefit from multiple installation sites in varying configurations.
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#inheritors","title":"Inheritors","text":"ReusableTestModule"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#constructors","title":"Constructors","text":"KInstallOnceModule [jvm]constructor()"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/-k-install-once-module/","title":"KInstallOnceModule - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule/KInstallOnceModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/-k-install-once-module/#kinstalloncemodule","title":"KInstallOnceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/equals/","title":"equals - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule/equals
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/equals/#equals","title":"equals","text":"[jvm]\\ operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/hash-code/","title":"hashCode - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule/hashCode
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ override fun hashCode(): Int
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/","title":"ReusableTestModule - Misk","text":"//misk-inject/misk.inject/ReusableTestModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/#reusabletestmodule","title":"ReusableTestModule","text":"[jvm]\\ @ExperimentalMiskApi
abstract class ReusableTestModule : KInstallOnceModule
This class should be extended by test modules used in tests, for misk to reuse the guice injector across tests for significantly faster test suite performance.
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/#constructors","title":"Constructors","text":"ReusableTestModule [jvm]constructor()"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/-reusable-test-module/","title":"ReusableTestModule - Misk","text":"//misk-inject/misk.inject/ReusableTestModule/ReusableTestModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/-reusable-test-module/#reusabletestmodule","title":"ReusableTestModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/","title":"misk-jdbc - Misk","text":"//misk-jdbc
"},{"location":"0.x/misk-jdbc/#misk-jdbc","title":"misk-jdbc","text":""},{"location":"0.x/misk-jdbc/#packages","title":"Packages","text":"Name misk.database misk.jdbc misk.vitess"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/","title":"Package-level declarations - Misk","text":"//misk-jdbc/misk.database
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/#types","title":"Types","text":"Name Summary CockroachCluster [jvm]class CockroachCluster(val name: String, val config: DataSourceConfig) DatabaseServer [jvm]interface DatabaseServerRepresents a database server for development/testing generally running in Docker. DockerCockroachCluster [jvm]class DockerCockroachCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer DockerPostgresServer [jvm]class DockerPostgresServer(val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer DockerTidbCluster [jvm]class DockerTidbCluster(val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer DockerVitessCluster [jvm]class DockerVitessCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer Keyspace [jvm]class Keyspace(val sharded: Boolean, val tables: Map<String, Table>) StartDatabaseService [jvm]class StartDatabaseService(qualifier: KClass<out Annotation>, deployment: Deployment, config: DataSourceConfig) : AbstractIdleServiceAll Vitess clusters used by the app/test are tracked in a global cache as a DockerVitessCluster. StartVitessService [jvm]class StartVitessService Table [jvm]class Table TidbCluster [jvm]class TidbCluster(val resourceLoader: ResourceLoader, val config: DataSourceConfig) VitessCluster [jvm]class VitessCluster@JvmOverloadsconstructor(val name: String, resourceLoader: ResourceLoader, val config: DataSourceConfig, val moshi: Moshi = defaultKotlinMoshi)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/#functions","title":"Functions","text":"Name Summary runCommand [jvm]fun runCommand(command: String): Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/run-command/","title":"runCommand - Misk","text":"//misk-jdbc/misk.database/runCommand
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/run-command/#runcommand","title":"runCommand","text":"[jvm]\\ fun runCommand(command: String): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/","title":"CockroachCluster - Misk","text":"//misk-jdbc/misk.database/CockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#cockroachcluster","title":"CockroachCluster","text":"[jvm]\\ class CockroachCluster(val name: String, val config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#constructors","title":"Constructors","text":"CockroachCluster [jvm]constructor(name: String, config: DataSourceConfig)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig externalHttpPort [jvm]val externalHttpPort: Int = 26258 internalHttpPort [jvm]val internalHttpPort: Int = 8080 name [jvm]val name: String postgresPort [jvm]val postgresPort: Int = 26257"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#functions","title":"Functions","text":"Name Summary openConnection [jvm]fun openConnection(): ConnectionConnect to vtgate."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/-cockroach-cluster/","title":"CockroachCluster - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/CockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/-cockroach-cluster/#cockroachcluster","title":"CockroachCluster","text":"[jvm]\\ constructor(name: String, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/external-http-port/","title":"externalHttpPort - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/externalHttpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/external-http-port/#externalhttpport","title":"externalHttpPort","text":"[jvm]\\ val externalHttpPort: Int = 26258
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/internal-http-port/","title":"internalHttpPort - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/internalHttpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/internal-http-port/#internalhttpport","title":"internalHttpPort","text":"[jvm]\\ val internalHttpPort: Int = 8080
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/open-connection/","title":"openConnection - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/openConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/open-connection/#openconnection","title":"openConnection","text":"[jvm]\\ fun openConnection(): Connection
Connect to vtgate.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/postgres-port/","title":"postgresPort - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/postgresPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/postgres-port/#postgresport","title":"postgresPort","text":"[jvm]\\ val postgresPort: Int = 26257
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/","title":"DatabaseServer - Misk","text":"//misk-jdbc/misk.database/DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/#databaseserver","title":"DatabaseServer","text":"interface DatabaseServer
Represents a database server for development/testing generally running in Docker.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/#inheritors","title":"Inheritors","text":"DockerCockroachCluster DockerPostgresServer DockerTidbCluster DockerVitessCluster"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/#functions","title":"Functions","text":"Name Summary pullImage [jvm]abstract fun pullImage() start [jvm]abstract fun start() stop [jvm]abstract fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DatabaseServer/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ abstract fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DatabaseServer/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/start/#start","title":"start","text":"[jvm]\\ abstract fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DatabaseServer/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/stop/#stop","title":"stop","text":"[jvm]\\ abstract fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/","title":"DockerCockroachCluster - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#dockercockroachcluster","title":"DockerCockroachCluster","text":"[jvm]\\ class DockerCockroachCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#constructors","title":"Constructors","text":"DockerCockroachCluster [jvm]constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerCockroachCluster.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#properties","title":"Properties","text":"Name Summary cluster [jvm]val cluster: CockroachCluster config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient moshi [jvm]val moshi: Moshi name [jvm]val name: String resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-docker-cockroach-cluster/","title":"DockerCockroachCluster - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/DockerCockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-docker-cockroach-cluster/#dockercockroachcluster","title":"DockerCockroachCluster","text":"[jvm]\\ constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/cluster/","title":"cluster - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/cluster/#cluster","title":"cluster","text":"[jvm]\\ val cluster: CockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME [jvm]const val CONTAINER_NAME: String IMAGE [jvm]const val IMAGE: String logger [jvm]val logger: KLogger SHA [jvm]const val SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/","title":"CONTAINER_NAME - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/CONTAINER_NAME
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/#container_name","title":"CONTAINER_NAME","text":"[jvm]\\ const val CONTAINER_NAME: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-i-m-a-g-e/","title":"IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-i-m-a-g-e/#image","title":"IMAGE","text":"[jvm]\\ const val IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-s-h-a/","title":"SHA - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-s-h-a/#sha","title":"SHA","text":"[jvm]\\ const val SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerCockroachCluster.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerCockroachCluster.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerCockroachCluster.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/","title":"DockerPostgresServer - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#dockerpostgresserver","title":"DockerPostgresServer","text":"[jvm]\\ class DockerPostgresServer(val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#constructors","title":"Constructors","text":"DockerPostgresServer [jvm]constructor(config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerPostgresServer.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-docker-postgres-server/","title":"DockerPostgresServer - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/DockerPostgresServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-docker-postgres-server/#dockerpostgresserver","title":"DockerPostgresServer","text":"[jvm]\\ constructor(config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME [jvm]const val CONTAINER_NAME: String IMAGE [jvm]const val IMAGE: String logger [jvm]val logger: KLogger SHA [jvm]const val SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/","title":"CONTAINER_NAME - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/CONTAINER_NAME
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/#container_name","title":"CONTAINER_NAME","text":"[jvm]\\ const val CONTAINER_NAME: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-i-m-a-g-e/","title":"IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-i-m-a-g-e/#image","title":"IMAGE","text":"[jvm]\\ const val IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-s-h-a/","title":"SHA - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-s-h-a/#sha","title":"SHA","text":"[jvm]\\ const val SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerPostgresServer.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerPostgresServer.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerPostgresServer.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/","title":"DockerTidbCluster - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#dockertidbcluster","title":"DockerTidbCluster","text":"[jvm]\\ class DockerTidbCluster(val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#constructors","title":"Constructors","text":"DockerTidbCluster [jvm]constructor(moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerTidbCluster.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#properties","title":"Properties","text":"Name Summary cluster [jvm]val cluster: TidbCluster config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient moshi [jvm]val moshi: Moshi resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-docker-tidb-cluster/","title":"DockerTidbCluster - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/DockerTidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-docker-tidb-cluster/#dockertidbcluster","title":"DockerTidbCluster","text":"[jvm]\\ constructor(moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/cluster/","title":"cluster - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/cluster/#cluster","title":"cluster","text":"[jvm]\\ val cluster: TidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME [jvm]const val CONTAINER_NAME: String IMAGE [jvm]const val IMAGE: String logger [jvm]val logger: KLogger SHA [jvm]const val SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/","title":"CONTAINER_NAME - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/CONTAINER_NAME
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/#container_name","title":"CONTAINER_NAME","text":"[jvm]\\ const val CONTAINER_NAME: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-i-m-a-g-e/","title":"IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-i-m-a-g-e/#image","title":"IMAGE","text":"[jvm]\\ const val IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-s-h-a/","title":"SHA - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-s-h-a/#sha","title":"SHA","text":"[jvm]\\ const val SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerTidbCluster.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerTidbCluster.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerTidbCluster.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/","title":"DockerVitessCluster - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#dockervitesscluster","title":"DockerVitessCluster","text":"[jvm]\\ class DockerVitessCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#constructors","title":"Constructors","text":"DockerVitessCluster [jvm]constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerVitessCluster.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#properties","title":"Properties","text":"Name Summary cluster [jvm]val cluster: VitessCluster config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient moshi [jvm]val moshi: Moshi name [jvm]val name: String resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-docker-vitess-cluster/","title":"DockerVitessCluster - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/DockerVitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-docker-vitess-cluster/#dockervitesscluster","title":"DockerVitessCluster","text":"[jvm]\\ constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/cluster/","title":"cluster - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/cluster/#cluster","title":"cluster","text":"[jvm]\\ val cluster: VitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME_PREFIX [jvm]const val CONTAINER_NAME_PREFIX: String logger [jvm]val logger: KLogger VITESS_IMAGE [jvm]const val VITESS_IMAGE: String VITESS_SHA [jvm]const val VITESS_SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage() startVitessDaemon [jvm]fun startVitessDaemon(qualifier: KClass<out Annotation>, config: DataSourceConfig)A helper method to start the Vitess cluster outside of the dev server or test process, to enable rapid iteration. This should be called directly amain() function, for example:"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e_-p-r-e-f-i-x/","title":"CONTAINER_NAME_PREFIX - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/CONTAINER_NAME_PREFIX
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e_-p-r-e-f-i-x/#container_name_prefix","title":"CONTAINER_NAME_PREFIX","text":"[jvm]\\ const val CONTAINER_NAME_PREFIX: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-i-m-a-g-e/","title":"VITESS_IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/VITESS_IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-i-m-a-g-e/#vitess_image","title":"VITESS_IMAGE","text":"[jvm]\\ const val VITESS_IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-s-h-a/","title":"VITESS_SHA - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/VITESS_SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-s-h-a/#vitess_sha","title":"VITESS_SHA","text":"[jvm]\\ const val VITESS_SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/start-vitess-daemon/","title":"startVitessDaemon - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/startVitessDaemon
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/start-vitess-daemon/#startvitessdaemon","title":"startVitessDaemon","text":"[jvm]\\ fun startVitessDaemon(qualifier: KClass<out Annotation>, config: DataSourceConfig)
A helper method to start the Vitess cluster outside of the dev server or test process, to enable rapid iteration. This should be called directly a main() function, for example:
MyAppVitessDaemon.kt:
fun main() { val config = MiskConfig.load(\"myapp\", Environment.TESTING) startVitessDaemon(MyAppDb::class, config.data_source_clusters.values.first().writer) }"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"
//misk-jdbc/misk.database/DockerVitessCluster/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerVitessCluster.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerVitessCluster.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerVitessCluster.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.database/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ class Keyspace(val sharded: Boolean, val tables: Map<String, Table>)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#constructors","title":"Constructors","text":"Keyspace [jvm]constructor(sharded: Boolean, tables: Map<String, Table>)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#properties","title":"Properties","text":"Name Summary sharded [jvm]val sharded: Boolean tables [jvm]val tables: Map<String, Table>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#functions","title":"Functions","text":"Name Summary shardCount [jvm]fun shardCount(): Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.database/Keyspace/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ constructor(sharded: Boolean, tables: Map<String, Table>)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/shard-count/","title":"shardCount - Misk","text":"//misk-jdbc/misk.database/Keyspace/shardCount
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/shard-count/#shardcount","title":"shardCount","text":"[jvm]\\ fun shardCount(): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/sharded/","title":"sharded - Misk","text":"//misk-jdbc/misk.database/Keyspace/sharded
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/sharded/#sharded","title":"sharded","text":"[jvm]\\ val sharded: Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/tables/","title":"tables - Misk","text":"//misk-jdbc/misk.database/Keyspace/tables
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/tables/#tables","title":"tables","text":"[jvm]\\ val tables: Map<String, Table>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/","title":"StartDatabaseService - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/#startdatabaseservice","title":"StartDatabaseService","text":"[jvm]\\ class StartDatabaseService(qualifier: KClass<out Annotation>, deployment: Deployment, config: DataSourceConfig) : AbstractIdleService
All Vitess clusters used by the app/test are tracked in a global cache as a DockerVitessCluster.
On startup, the service will look for a cluster in the cache, and if not found, look for it in Docker by container name, or as a last resort start the container itself.
On shutdown, the cache is invalidated by a JVM shutdown hook. On invalidation, the cache will call the each entry\u2019s stop() method. If the cluster container was created in this JVM, it will be stopped and removed. Otherwise (if the container was started by a different process), it will be left running.
//misk-jdbc/misk.database/StartDatabaseService/StartDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-start-database-service/#startdatabaseservice","title":"StartDatabaseService","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, deployment: Deployment, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/init/","title":"init - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/init
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/init/#init","title":"init","text":"[jvm]\\ fun init(): StartDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/server/","title":"server - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/server
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/server/#server","title":"server","text":"[jvm]\\ var server: DatabaseServer?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/","title":"CacheKey - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/#cachekey","title":"CacheKey","text":"[jvm]\\ data class CacheKey(val name: String, val config: DataSourceConfig, val deployment: Deployment)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/#constructors","title":"Constructors","text":"CacheKey [jvm]constructor(name: String, config: DataSourceConfig, deployment: Deployment)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig deployment [jvm]val deployment: Deployment name [jvm]val name: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/-cache-key/","title":"CacheKey - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/CacheKey
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/-cache-key/#cachekey","title":"CacheKey","text":"[jvm]\\ constructor(name: String, config: DataSourceConfig, deployment: Deployment)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/deployment/","title":"deployment - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/deployment
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/deployment/#deployment","title":"deployment","text":"[jvm]\\ val deployment: Deployment
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger servers [jvm]lateinit var servers: LoadingCache<StartDatabaseService.CacheKey, Optional<DatabaseServer>>Global cache of running database servers."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/servers/","title":"servers - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/Companion/servers
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/servers/#servers","title":"servers","text":"[jvm]\\ lateinit var servers: LoadingCache<StartDatabaseService.CacheKey, Optional<DatabaseServer>>
Global cache of running database servers.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/","title":"StartVitessService - Misk","text":"//misk-jdbc/misk.database/StartVitessService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/#startvitessservice","title":"StartVitessService","text":"[jvm]\\ class StartVitessService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/#constructors","title":"Constructors","text":"StartVitessService [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-start-vitess-service/","title":"StartVitessService - Misk","text":"//misk-jdbc/misk.database/StartVitessService/StartVitessService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-start-vitess-service/#startvitessservice","title":"StartVitessService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/StartVitessService/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/","title":"Table - Misk","text":"//misk-jdbc/misk.database/Table
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/#table","title":"Table","text":"[jvm]\\ class Table
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/#constructors","title":"Constructors","text":"Table [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/-table/","title":"Table - Misk","text":"//misk-jdbc/misk.database/Table/Table
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/-table/#table","title":"Table","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/","title":"TidbCluster - Misk","text":"//misk-jdbc/misk.database/TidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#tidbcluster","title":"TidbCluster","text":"[jvm]\\ class TidbCluster(val resourceLoader: ResourceLoader, val config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#constructors","title":"Constructors","text":"TidbCluster [jvm]constructor(resourceLoader: ResourceLoader, config: DataSourceConfig)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig configDir [jvm]val configDir: Path httpPort [jvm]val httpPort: Int = 10080 mysqlPort [jvm]val mysqlPort: Int = 4000 resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#functions","title":"Functions","text":"Name Summary openConnection [jvm]fun openConnection(): ConnectionConnect to vtgate."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/-tidb-cluster/","title":"TidbCluster - Misk","text":"//misk-jdbc/misk.database/TidbCluster/TidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/-tidb-cluster/#tidbcluster","title":"TidbCluster","text":"[jvm]\\ constructor(resourceLoader: ResourceLoader, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config-dir/","title":"configDir - Misk","text":"//misk-jdbc/misk.database/TidbCluster/configDir
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config-dir/#configdir","title":"configDir","text":"[jvm]\\ val configDir: Path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/TidbCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/http-port/","title":"httpPort - Misk","text":"//misk-jdbc/misk.database/TidbCluster/httpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/http-port/#httpport","title":"httpPort","text":"[jvm]\\ val httpPort: Int = 10080
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/mysql-port/","title":"mysqlPort - Misk","text":"//misk-jdbc/misk.database/TidbCluster/mysqlPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/mysql-port/#mysqlport","title":"mysqlPort","text":"[jvm]\\ val mysqlPort: Int = 4000
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/open-connection/","title":"openConnection - Misk","text":"//misk-jdbc/misk.database/TidbCluster/openConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/open-connection/#openconnection","title":"openConnection","text":"[jvm]\\ fun openConnection(): Connection
Connect to vtgate.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/TidbCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/","title":"VitessCluster - Misk","text":"//misk-jdbc/misk.database/VitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#vitesscluster","title":"VitessCluster","text":"[jvm]\\ class VitessCluster@JvmOverloadsconstructor(val name: String, resourceLoader: ResourceLoader, val config: DataSourceConfig, val moshi: Moshi = defaultKotlinMoshi)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#constructors","title":"Constructors","text":"VitessCluster [jvm]@JvmOverloadsconstructor(name: String, resourceLoader: ResourceLoader, config: DataSourceConfig, moshi: Moshi = defaultKotlinMoshi)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig configDir [jvm]val configDir: Path grpcPort [jvm]val grpcPort: Int httpPort [jvm]val httpPort: Int = 27000 keyspaceAdapter [jvm]val keyspaceAdapter: JsonAdapter<Keyspace> moshi [jvm]val moshi: Moshi mysqlPort [jvm]val mysqlPort: Int name [jvm]val name: String schemaDir [jvm]val schemaDir: Path vtgateMysqlPort [jvm]val vtgateMysqlPort: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#functions","title":"Functions","text":"Name Summary keyspaces [jvm]fun keyspaces(): Map<String, Keyspace> openMysqlConnection [jvm]fun openMysqlConnection(): ConnectionConnect to the underlying MySQL database, bypassing Vitess entirely. openVtgateConnection [jvm]fun openVtgateConnection(): ConnectionConnect to vtgate."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/-vitess-cluster/","title":"VitessCluster - Misk","text":"//misk-jdbc/misk.database/VitessCluster/VitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/-vitess-cluster/#vitesscluster","title":"VitessCluster","text":"[jvm]\\
@JvmOverloads
constructor(name: String, resourceLoader: ResourceLoader, config: DataSourceConfig, moshi: Moshi = defaultKotlinMoshi)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config-dir/","title":"configDir - Misk","text":"//misk-jdbc/misk.database/VitessCluster/configDir
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config-dir/#configdir","title":"configDir","text":"[jvm]\\ val configDir: Path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/VitessCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/grpc-port/","title":"grpcPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/grpcPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/grpc-port/#grpcport","title":"grpcPort","text":"[jvm]\\ val grpcPort: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/http-port/","title":"httpPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/httpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/http-port/#httpport","title":"httpPort","text":"[jvm]\\ val httpPort: Int = 27000
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspace-adapter/","title":"keyspaceAdapter - Misk","text":"//misk-jdbc/misk.database/VitessCluster/keyspaceAdapter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspace-adapter/#keyspaceadapter","title":"keyspaceAdapter","text":"[jvm]\\ val keyspaceAdapter: JsonAdapter<Keyspace>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspaces/","title":"keyspaces - Misk","text":"//misk-jdbc/misk.database/VitessCluster/keyspaces
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspaces/#keyspaces","title":"keyspaces","text":"[jvm]\\ fun keyspaces(): Map<String, Keyspace>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/VitessCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/mysql-port/","title":"mysqlPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/mysqlPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/mysql-port/#mysqlport","title":"mysqlPort","text":"[jvm]\\ val mysqlPort: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/VitessCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-mysql-connection/","title":"openMysqlConnection - Misk","text":"//misk-jdbc/misk.database/VitessCluster/openMysqlConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-mysql-connection/#openmysqlconnection","title":"openMysqlConnection","text":"[jvm]\\ fun openMysqlConnection(): Connection
Connect to the underlying MySQL database, bypassing Vitess entirely.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-vtgate-connection/","title":"openVtgateConnection - Misk","text":"//misk-jdbc/misk.database/VitessCluster/openVtgateConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-vtgate-connection/#openvtgateconnection","title":"openVtgateConnection","text":"[jvm]\\ fun openVtgateConnection(): Connection
Connect to vtgate.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/schema-dir/","title":"schemaDir - Misk","text":"//misk-jdbc/misk.database/VitessCluster/schemaDir
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/schema-dir/#schemadir","title":"schemaDir","text":"[jvm]\\ val schemaDir: Path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/vtgate-mysql-port/","title":"vtgateMysqlPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/vtgateMysqlPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/vtgate-mysql-port/#vtgatemysqlport","title":"vtgateMysqlPort","text":"[jvm]\\ val vtgateMysqlPort: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/","title":"Package-level declarations - Misk","text":"//misk-jdbc/misk.jdbc
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/#types","title":"Types","text":"Name Summary Check [jvm]enum Check : Enum<Check> CheckDisabler [jvm]object CheckDisabler CheckException [jvm]open class CheckException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : SQLExceptionAn exception that is thrown when a Check fails. Cluster [jvm]interface Cluster<T>Cluster provides a consistent abstraction for interacting with various database-related resources T based on their role in the underlying database topology. DatabasePool [jvm]interface DatabasePoolFigures out what database name to use for a given config. Tests use this to pool many databases for concurrent execution. In development, staging, and production the database never changes. DatabaseReadyService [jvm]interface DatabaseReadyService : ServiceMarker interface for indicating that the database is ready. DataSourceCluster [jvm]class DataSourceCluster(val writer: DataSource, val reader: DataSource) : Cluster<DataSource> DataSourceClusterConfig [jvm]data class DataSourceClusterConfig(val writer: DataSourceConfig, val reader: DataSourceConfig?)Configuration element for a cluster of DataSources DataSourceClustersConfig [jvm]class DataSourceClustersConfig : LinkedHashMap<String, DataSourceClusterConfig> , ConfigTop-level configuration element for all datasource clusters DataSourceConfig [jvm]data class DataSourceConfig@JvmOverloadsconstructor(val type: DataSourceType, val host: String? = null, val port: Int? = null, val database: String? = null, val username: String? = null, val password: String? = null, val fixed_pool_size: Int = 10, val connection_timeout: Duration = Duration.ofSeconds(10), val validation_timeout: Duration = Duration.ofSeconds(3), val connection_idle_timeout: Duration? = null, val connection_max_lifetime: Duration = Duration.ofMinutes(1), val query_timeout: Duration? = Duration.ofMinutes(1), val keepalive_time: Duration = Duration.ofSeconds(0), val migrations_resource: String? = null, val migrations_resources: List<String>? = null, val migrations_resources_exclusion: List<String>? = null, val migrations_resources_regex: String = \"(^ DataSourceConnector [jvm]interface DataSourceConnector DataSourceDecorator [jvm]interface DataSourceDecorator DataSourceService [jvm]@Singletonclass DataSourceService@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null) : AbstractIdleService, DataSourceConnector, Provider<DataSource> Builds a connection pool to a JDBC database. Doesn\u2019t do any schema migration or validation. DataSourceType [jvm]enum DataSourceType : Enum<DataSourceType> Defines a type of datasource JdbcModule [jvm]class JdbcModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true) : KAbstractModuleBinds database connectivity for a qualified data source. This binds the following public types: JDBCSession [jvm]class JDBCSession(val connection: Connection) : Session PingDatabaseService [jvm]@Singletonclass PingDatabaseService@Injectconstructor(config: DataSourceConfig, deployment: Deployment) : AbstractIdleServiceService that waits for the database to become healthy. This is needed if we\u2019re booting up a Vitess cluster as part of the test run. PostCommitHookFailedException [jvm]class PostCommitHookFailedException(cause: Throwable) : ExceptionPostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook RealDatabasePool [jvm]object RealDatabasePool : DatabasePool RealTransacter [jvm]class RealTransacter(dataSourceService: DataSourceService) : Transacter SchemaMigratorService [jvm]class SchemaMigratorService : AbstractIdleService, HealthCheck, DatabaseReadyService Session [jvm]interface Session SpanInjector [jvm]class SpanInjector(val tracer: Tracer?, val config: DataSourceConfig) : QueryTransformer, DataSourceDecoratorOn the fly decorates queries with the span context, so the query call can be traced all the way through Vitess StringBuilderCarrier [jvm]class StringBuilderCarrier : TextMap TableScanException [jvm]class TableScanException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckExceptionException thrown if we execute a query lacking an index. Transacter [jvm]interface Transacter"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/#functions","title":"Functions","text":"Name Summary map [jvm]fun <T> ResultSet.map(function: (ResultSet) -> T): List<T> maybeInt [jvm]fun ResultSet.maybeInt(): Int? maybeLong [jvm]fun ResultSet.maybeLong(): Long? maybeResult [jvm]fun <T> ResultSet.maybeResult(function: (ResultSet) -> T): T? maybeString [jvm]fun ResultSet.maybeString(): String? uniqueInt [jvm]fun ResultSet.uniqueInt(): Int uniqueLong [jvm]fun ResultSet.uniqueLong(): Long uniqueResult [jvm]fun <T> ResultSet.uniqueResult(function: (ResultSet) -> T): T uniqueString [jvm]fun ResultSet.uniqueString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/map/","title":"map - Misk","text":"//misk-jdbc/misk.jdbc/map
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/map/#map","title":"map","text":"[jvm]\\ fun <T> ResultSet.map(function: (ResultSet) -> T): List<T>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-int/","title":"maybeInt - Misk","text":"//misk-jdbc/misk.jdbc/maybeInt
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-int/#maybeint","title":"maybeInt","text":"[jvm]\\ fun ResultSet.maybeInt(): Int?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-long/","title":"maybeLong - Misk","text":"//misk-jdbc/misk.jdbc/maybeLong
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-long/#maybelong","title":"maybeLong","text":"[jvm]\\ fun ResultSet.maybeLong(): Long?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-result/","title":"maybeResult - Misk","text":"//misk-jdbc/misk.jdbc/maybeResult
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-result/#mayberesult","title":"maybeResult","text":"[jvm]\\ fun <T> ResultSet.maybeResult(function: (ResultSet) -> T): T?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-string/","title":"maybeString - Misk","text":"//misk-jdbc/misk.jdbc/maybeString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-string/#maybestring","title":"maybeString","text":"[jvm]\\ fun ResultSet.maybeString(): String?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-int/","title":"uniqueInt - Misk","text":"//misk-jdbc/misk.jdbc/uniqueInt
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-int/#uniqueint","title":"uniqueInt","text":"[jvm]\\ fun ResultSet.uniqueInt(): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-long/","title":"uniqueLong - Misk","text":"//misk-jdbc/misk.jdbc/uniqueLong
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-long/#uniquelong","title":"uniqueLong","text":"[jvm]\\ fun ResultSet.uniqueLong(): Long
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-result/","title":"uniqueResult - Misk","text":"//misk-jdbc/misk.jdbc/uniqueResult
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-result/#uniqueresult","title":"uniqueResult","text":"[jvm]\\ fun <T> ResultSet.uniqueResult(function: (ResultSet) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-string/","title":"uniqueString - Misk","text":"//misk-jdbc/misk.jdbc/uniqueString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-string/#uniquestring","title":"uniqueString","text":"[jvm]\\ fun ResultSet.uniqueString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/","title":"Check - Misk","text":"//misk-jdbc/misk.jdbc/Check
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#check","title":"Check","text":"[jvm]\\ enum Check : Enum<Check>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#entries","title":"Entries","text":"FULL_SCATTER [jvm]FULL_SCATTER TABLE_SCAN [jvm]TABLE_SCAN COWRITE [jvm]COWRITE"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Check>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): CheckReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Check>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.jdbc/Check/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Check>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.jdbc/Check/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Check
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/values/","title":"values - Misk","text":"//misk-jdbc/misk.jdbc/Check/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Check>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-c-o-w-r-i-t-e/","title":"COWRITE - Misk","text":"//misk-jdbc/misk.jdbc/Check/COWRITE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-c-o-w-r-i-t-e/#cowrite","title":"COWRITE","text":"[jvm]\\ COWRITE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-c-o-w-r-i-t-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-f-u-l-l_-s-c-a-t-t-e-r/","title":"FULL_SCATTER - Misk","text":"//misk-jdbc/misk.jdbc/Check/FULL_SCATTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-f-u-l-l_-s-c-a-t-t-e-r/#full_scatter","title":"FULL_SCATTER","text":"[jvm]\\ FULL_SCATTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-f-u-l-l_-s-c-a-t-t-e-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-t-a-b-l-e_-s-c-a-n/","title":"TABLE_SCAN - Misk","text":"//misk-jdbc/misk.jdbc/Check/TABLE_SCAN
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-t-a-b-l-e_-s-c-a-n/#table_scan","title":"TABLE_SCAN","text":"[jvm]\\ TABLE_SCAN
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-t-a-b-l-e_-s-c-a-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/","title":"CheckDisabler - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/#checkdisabler","title":"CheckDisabler","text":"[jvm]\\ object CheckDisabler
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/#properties","title":"Properties","text":"Name Summary disabledChecks [jvm]val disabledChecks: ThreadLocal<Collection<Check>>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/#functions","title":"Functions","text":"Name Summary disableChecks [jvm]fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T isCheckEnabled [jvm]fun isCheckEnabled(check: Check): Boolean withoutChecks [jvm]fun <T> withoutChecks(vararg checks: Check, body: () -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disable-checks/","title":"disableChecks - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/disableChecks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disable-checks/#disablechecks","title":"disableChecks","text":"[jvm]\\ fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disabled-checks/","title":"disabledChecks - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/disabledChecks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disabled-checks/#disabledchecks","title":"disabledChecks","text":"[jvm]\\ val disabledChecks: ThreadLocal<Collection<Check>>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/is-check-enabled/","title":"isCheckEnabled - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/isCheckEnabled
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/is-check-enabled/#ischeckenabled","title":"isCheckEnabled","text":"[jvm]\\ fun isCheckEnabled(check: Check): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/without-checks/","title":"withoutChecks - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/withoutChecks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/without-checks/#withoutchecks","title":"withoutChecks","text":"[jvm]\\ fun <T> withoutChecks(vararg checks: Check, body: () -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/","title":"CheckException - Misk","text":"//misk-jdbc/misk.jdbc/CheckException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#checkexception","title":"CheckException","text":"open class CheckException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : SQLException
An exception that is thrown when a Check fails.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#inheritors","title":"Inheritors","text":"TableScanException CowriteException FullScatterException"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#constructors","title":"Constructors","text":"CheckException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/-check-exception/","title":"CheckException - Misk","text":"//misk-jdbc/misk.jdbc/CheckException/CheckException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/-check-exception/#checkexception","title":"CheckException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/","title":"Cluster - Misk","text":"//misk-jdbc/misk.jdbc/Cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/#cluster","title":"Cluster","text":"interface Cluster<T>
Cluster provides a consistent abstraction for interacting with various database-related resources T based on their role in the underlying database topology.
Database clusters are often composed of a Read/Write master instance and a set of Read-Only replica instances.
Misk defers management of these replicas to the underlying persistence layer and requires a single addressable endpoint.
Examples include a Read-Only DataSource or a Read/Write SessionFactory in Hibernate.
N.B. If a Read-Only resource is not provided Misk will default to the Read/Write resource.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/#inheritors","title":"Inheritors","text":"DataSourceCluster"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/#properties","title":"Properties","text":"Name Summary reader [jvm]abstract val reader: T writer [jvm]abstract val writer: T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/reader/","title":"reader - Misk","text":"//misk-jdbc/misk.jdbc/Cluster/reader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/reader/#reader","title":"reader","text":"[jvm]\\ abstract val reader: T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/writer/","title":"writer - Misk","text":"//misk-jdbc/misk.jdbc/Cluster/writer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/writer/#writer","title":"writer","text":"[jvm]\\ abstract val writer: T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/","title":"DataSourceCluster - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/#datasourcecluster","title":"DataSourceCluster","text":"[jvm]\\ class DataSourceCluster(val writer: DataSource, val reader: DataSource) : Cluster<DataSource>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/#constructors","title":"Constructors","text":"DataSourceCluster [jvm]constructor(writer: DataSource, reader: DataSource)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/#properties","title":"Properties","text":"Name Summary reader [jvm]open override val reader: DataSource writer [jvm]open override val writer: DataSource"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/-data-source-cluster/","title":"DataSourceCluster - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster/DataSourceCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/-data-source-cluster/#datasourcecluster","title":"DataSourceCluster","text":"[jvm]\\ constructor(writer: DataSource, reader: DataSource)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/reader/","title":"reader - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster/reader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/reader/#reader","title":"reader","text":"[jvm]\\ open override val reader: DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/writer/","title":"writer - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster/writer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/writer/#writer","title":"writer","text":"[jvm]\\ open override val writer: DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/","title":"DataSourceClusterConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/#datasourceclusterconfig","title":"DataSourceClusterConfig","text":"[jvm]\\ data class DataSourceClusterConfig(val writer: DataSourceConfig, val reader: DataSourceConfig?)
Configuration element for a cluster of DataSources
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/#constructors","title":"Constructors","text":"DataSourceClusterConfig [jvm]constructor(writer: DataSourceConfig, reader: DataSourceConfig?)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/#properties","title":"Properties","text":"Name Summary reader [jvm]val reader: DataSourceConfig? writer [jvm]val writer: DataSourceConfig"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/-data-source-cluster-config/","title":"DataSourceClusterConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig/DataSourceClusterConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/-data-source-cluster-config/#datasourceclusterconfig","title":"DataSourceClusterConfig","text":"[jvm]\\ constructor(writer: DataSourceConfig, reader: DataSourceConfig?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/reader/","title":"reader - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig/reader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/reader/#reader","title":"reader","text":"[jvm]\\ val reader: DataSourceConfig?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/writer/","title":"writer - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig/writer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/writer/#writer","title":"writer","text":"[jvm]\\ val writer: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/","title":"DataSourceClustersConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClustersConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#datasourceclustersconfig","title":"DataSourceClustersConfig","text":"[jvm]\\ class DataSourceClustersConfig : LinkedHashMap<String, DataSourceClusterConfig> , Config
Top-level configuration element for all datasource clusters
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#constructors","title":"Constructors","text":"DataSourceClustersConfig [jvm]constructor()constructor(m: Map<String, DataSourceClusterConfig>)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#properties","title":"Properties","text":"Name Summary entries [jvm]open override val entries: MutableSet<MutableMap.MutableEntry<String, DataSourceClusterConfig>> keys [jvm]open override val keys: MutableSet<String> size [jvm]open override val size: Int values [jvm]open override val values: MutableCollection<DataSourceClusterConfig>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() clone [jvm]open override fun clone(): Any compute [jvm]open override fun compute(p0: String, p1: BiFunction<in String, in DataSourceClusterConfig?, out DataSourceClusterConfig?>): DataSourceClusterConfig? computeIfAbsent [jvm]open override fun computeIfAbsent(p0: String, p1: Function<in String, out DataSourceClusterConfig>): DataSourceClusterConfig computeIfPresent [jvm]open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in DataSourceClusterConfig, out DataSourceClusterConfig?>): DataSourceClusterConfig? containsKey [jvm]open override fun containsKey(key: String): Boolean containsValue [jvm]open override fun containsValue(value: DataSourceClusterConfig): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean forEach [jvm]open override fun forEach(p0: BiConsumer<in String, in DataSourceClusterConfig>) get [jvm]open operator override fun get(key: String): DataSourceClusterConfig? getOrDefault [jvm]open override fun getOrDefault(key: String, defaultValue: DataSourceClusterConfig): DataSourceClusterConfig hashCode [jvm]open override fun hashCode(): Int isEmpty [jvm]open override fun isEmpty(): Boolean merge [jvm]open override fun merge(p0: String, p1: DataSourceClusterConfig, p2: BiFunction<in DataSourceClusterConfig, in DataSourceClusterConfig, out DataSourceClusterConfig?>): DataSourceClusterConfig? put [jvm]open override fun put(key: String, value: DataSourceClusterConfig): DataSourceClusterConfig? putAll [jvm]open override fun putAll(from: Map<out String, DataSourceClusterConfig>) putIfAbsent [jvm]open override fun putIfAbsent(p0: String, p1: DataSourceClusterConfig): DataSourceClusterConfig? remove [jvm]open override fun remove(key: String): DataSourceClusterConfig?open override fun remove(key: String, value: DataSourceClusterConfig): Boolean replace [jvm]open override fun replace(p0: String, p1: DataSourceClusterConfig): DataSourceClusterConfig?open override fun replace(p0: String, p1: DataSourceClusterConfig, p2: DataSourceClusterConfig): Boolean replaceAll [jvm]open override fun replaceAll(p0: BiFunction<in String, in DataSourceClusterConfig, out DataSourceClusterConfig>) toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/-data-source-clusters-config/","title":"DataSourceClustersConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClustersConfig/DataSourceClustersConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/-data-source-clusters-config/#datasourceclustersconfig","title":"DataSourceClustersConfig","text":"[jvm]\\ constructor()
constructor(m: Map<String, DataSourceClusterConfig>)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/","title":"DataSourceConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#datasourceconfig","title":"DataSourceConfig","text":"[jvm]\\ data class DataSourceConfig@JvmOverloadsconstructor(val type: DataSourceType, val host: String? = null, val port: Int? = null, val database: String? = null, val username: String? = null, val password: String? = null, val fixed_pool_size: Int = 10, val connection_timeout: Duration = Duration.ofSeconds(10), val validation_timeout: Duration = Duration.ofSeconds(3), val connection_idle_timeout: Duration? = null, val connection_max_lifetime: Duration = Duration.ofMinutes(1), val query_timeout: Duration? = Duration.ofMinutes(1), val keepalive_time: Duration = Duration.ofSeconds(0), val migrations_resource: String? = null, val migrations_resources: List<String>? = null, val migrations_resources_exclusion: List<String>? = null, val migrations_resources_regex: String = \"(^|.*/)v(\", val vitess_schema_resource_root: String? = null, val trust_certificate_key_store_url: String? = null, val trust_certificate_key_store_password: String? = null, val client_certificate_key_store_url: String? = null, val client_certificate_key_store_password: String? = null, val trust_certificate_key_store_path: String? = null, val client_certificate_key_store_path: String? = null, val verify_server_identity: Boolean = false, val enabledTlsProtocols: List<String> = listOf(\"TLSv1.2\", \"TLSv1.3\"), val show_sql: String? = \"false\", val generate_hibernate_stats: String? = \"false\", val jdbc_statement_batch_size: Int? = null, val use_fixed_pool_size: Boolean = false, val allow_public_key_retrieval: Boolean = false, val jdbc_url_query_parameters: Map<String, Any> = mapOf(), val mysql_enforce_writable_connections: Boolean = false)
Configuration element for an individual datasource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#constructors","title":"Constructors","text":"DataSourceConfig [jvm]@JvmOverloadsconstructor(type: DataSourceType, host: String? = null, port: Int? = null, database: String? = null, username: String? = null, password: String? = null, fixed_pool_size: Int = 10, connection_timeout: Duration = Duration.ofSeconds(10), validation_timeout: Duration = Duration.ofSeconds(3), connection_idle_timeout: Duration? = null, connection_max_lifetime: Duration = Duration.ofMinutes(1), query_timeout: Duration? = Duration.ofMinutes(1), keepalive_time: Duration = Duration.ofSeconds(0), migrations_resource: String? = null, migrations_resources: List<String>? = null, migrations_resources_exclusion: List<String>? = null, migrations_resources_regex: String = \"(^"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#properties","title":"Properties","text":"Name Summary allow_public_key_retrieval [jvm]val allow_public_key_retrieval: Boolean = false client_certificate_key_store_password [jvm]val client_certificate_key_store_password: String? = null client_certificate_key_store_path [jvm]val client_certificate_key_store_path: String? = null client_certificate_key_store_url [jvm]val client_certificate_key_store_url: String? = null connection_idle_timeout [jvm]val connection_idle_timeout: Duration? = null connection_max_lifetime [jvm]val connection_max_lifetime: Duration connection_timeout [jvm]val connection_timeout: Duration database [jvm]val database: String? = null enabledTlsProtocols [jvm]val enabledTlsProtocols: List<String> fixed_pool_size [jvm]val fixed_pool_size: Int = 10 generate_hibernate_stats [jvm]val generate_hibernate_stats: String? host [jvm]val host: String? = null jdbc_statement_batch_size [jvm]val jdbc_statement_batch_size: Int? = null jdbc_url_query_parameters [jvm]val jdbc_url_query_parameters: Map<String, Any> keepalive_time [jvm]val keepalive_time: Duration migrations_resource [jvm]val migrations_resource: String? = null migrations_resources [jvm]val migrations_resources: List<String>? = null migrations_resources_exclusion [jvm]val migrations_resources_exclusion: List<String>? = nullList of filenames to exclude from being processed in database schema migrations migrations_resources_regex [jvm]val migrations_resources_regex: StringRegular expression migration files names should match. Any migration filename that doesn\u2019t match the given regular expression will cause an exception, unless it was explicitly mentioned in migrations_resources_exclusion. mysql_enforce_writable_connections [jvm]val mysql_enforce_writable_connections: Boolean = false password [jvm]val password: String? = null port [jvm]val port: Int? = null query_timeout [jvm]val query_timeout: Duration? show_sql [jvm]val show_sql: String? trust_certificate_key_store_password [jvm]val trust_certificate_key_store_password: String? = null trust_certificate_key_store_path [jvm]val trust_certificate_key_store_path: String? = null trust_certificate_key_store_url [jvm]val trust_certificate_key_store_url: String? = null type [jvm]val type: DataSourceType use_fixed_pool_size [jvm]val use_fixed_pool_size: Boolean = false username [jvm]val username: String? = null validation_timeout [jvm]val validation_timeout: Duration verify_server_identity [jvm]val verify_server_identity: Boolean = false vitess_schema_resource_root [jvm]val vitess_schema_resource_root: String? = null"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#functions","title":"Functions","text":"Name Summary asReplica [jvm]fun asReplica(): DataSourceConfig buildJdbcUrl [jvm]fun buildJdbcUrl(deployment: Deployment): String canRecoverOnReplica [jvm]fun canRecoverOnReplica(): Boolean withDefaults [jvm]fun withDefaults(): DataSourceConfig"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/-data-source-config/","title":"DataSourceConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/-data-source-config/#datasourceconfig","title":"DataSourceConfig","text":"[jvm]\\
@JvmOverloads
constructor(type: DataSourceType, host: String? = null, port: Int? = null, database: String? = null, username: String? = null, password: String? = null, fixed_pool_size: Int = 10, connection_timeout: Duration = Duration.ofSeconds(10), validation_timeout: Duration = Duration.ofSeconds(3), connection_idle_timeout: Duration? = null, connection_max_lifetime: Duration = Duration.ofMinutes(1), query_timeout: Duration? = Duration.ofMinutes(1), keepalive_time: Duration = Duration.ofSeconds(0), migrations_resource: String? = null, migrations_resources: List<String>? = null, migrations_resources_exclusion: List<String>? = null, migrations_resources_regex: String = \"(^|.*/)v(\", vitess_schema_resource_root: String? = null, trust_certificate_key_store_url: String? = null, trust_certificate_key_store_password: String? = null, client_certificate_key_store_url: String? = null, client_certificate_key_store_password: String? = null, trust_certificate_key_store_path: String? = null, client_certificate_key_store_path: String? = null, verify_server_identity: Boolean = false, enabledTlsProtocols: List<String> = listOf(\"TLSv1.2\", \"TLSv1.3\"), show_sql: String? = \"false\", generate_hibernate_stats: String? = \"false\", jdbc_statement_batch_size: Int? = null, use_fixed_pool_size: Boolean = false, allow_public_key_retrieval: Boolean = false, jdbc_url_query_parameters: Map<String, Any> = mapOf(), mysql_enforce_writable_connections: Boolean = false)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/allow_public_key_retrieval/","title":"allow_public_key_retrieval - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/allow_public_key_retrieval
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/allow_public_key_retrieval/#allow_public_key_retrieval","title":"allow_public_key_retrieval","text":"[jvm]\\ val allow_public_key_retrieval: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/as-replica/","title":"asReplica - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/asReplica
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/as-replica/#asreplica","title":"asReplica","text":"[jvm]\\ fun asReplica(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/build-jdbc-url/","title":"buildJdbcUrl - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/buildJdbcUrl
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/build-jdbc-url/#buildjdbcurl","title":"buildJdbcUrl","text":"[jvm]\\ fun buildJdbcUrl(deployment: Deployment): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/can-recover-on-replica/","title":"canRecoverOnReplica - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/canRecoverOnReplica
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/can-recover-on-replica/#canrecoveronreplica","title":"canRecoverOnReplica","text":"[jvm]\\ fun canRecoverOnReplica(): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_password/","title":"client_certificate_key_store_password - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/client_certificate_key_store_password
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_password/#client_certificate_key_store_password","title":"client_certificate_key_store_password","text":"[jvm]\\ val client_certificate_key_store_password: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_path/","title":"client_certificate_key_store_path - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/client_certificate_key_store_path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_path/#client_certificate_key_store_path","title":"client_certificate_key_store_path","text":"[jvm]\\ val client_certificate_key_store_path: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_url/","title":"client_certificate_key_store_url - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/client_certificate_key_store_url
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_url/#client_certificate_key_store_url","title":"client_certificate_key_store_url","text":"[jvm]\\ val client_certificate_key_store_url: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_idle_timeout/","title":"connection_idle_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/connection_idle_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_idle_timeout/#connection_idle_timeout","title":"connection_idle_timeout","text":"[jvm]\\ val connection_idle_timeout: Duration? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_max_lifetime/","title":"connection_max_lifetime - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/connection_max_lifetime
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_max_lifetime/#connection_max_lifetime","title":"connection_max_lifetime","text":"[jvm]\\ val connection_max_lifetime: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_timeout/","title":"connection_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/connection_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_timeout/#connection_timeout","title":"connection_timeout","text":"[jvm]\\ val connection_timeout: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/database/","title":"database - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/database
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/database/#database","title":"database","text":"[jvm]\\ val database: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/enabled-tls-protocols/","title":"enabledTlsProtocols - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/enabledTlsProtocols
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/enabled-tls-protocols/#enabledtlsprotocols","title":"enabledTlsProtocols","text":"[jvm]\\ val enabledTlsProtocols: List<String>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/fixed_pool_size/","title":"fixed_pool_size - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/fixed_pool_size
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/fixed_pool_size/#fixed_pool_size","title":"fixed_pool_size","text":"[jvm]\\ val fixed_pool_size: Int = 10
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/generate_hibernate_stats/","title":"generate_hibernate_stats - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/generate_hibernate_stats
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/generate_hibernate_stats/#generate_hibernate_stats","title":"generate_hibernate_stats","text":"[jvm]\\ val generate_hibernate_stats: String?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/host/","title":"host - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/host
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/host/#host","title":"host","text":"[jvm]\\ val host: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_statement_batch_size/","title":"jdbc_statement_batch_size - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/jdbc_statement_batch_size
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_statement_batch_size/#jdbc_statement_batch_size","title":"jdbc_statement_batch_size","text":"[jvm]\\ val jdbc_statement_batch_size: Int? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_url_query_parameters/","title":"jdbc_url_query_parameters - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/jdbc_url_query_parameters
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_url_query_parameters/#jdbc_url_query_parameters","title":"jdbc_url_query_parameters","text":"[jvm]\\ val jdbc_url_query_parameters: Map<String, Any>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/keepalive_time/","title":"keepalive_time - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/keepalive_time
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/keepalive_time/#keepalive_time","title":"keepalive_time","text":"[jvm]\\ val keepalive_time: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resource/","title":"migrations_resource - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resource/#migrations_resource","title":"migrations_resource","text":"[jvm]\\ val migrations_resource: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources/","title":"migrations_resources - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resources
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources/#migrations_resources","title":"migrations_resources","text":"[jvm]\\ val migrations_resources: List<String>? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_exclusion/","title":"migrations_resources_exclusion - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resources_exclusion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_exclusion/#migrations_resources_exclusion","title":"migrations_resources_exclusion","text":"[jvm]\\ val migrations_resources_exclusion: List<String>? = null
List of filenames to exclude from being processed in database schema migrations
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_regex/","title":"migrations_resources_regex - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resources_regex
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_regex/#migrations_resources_regex","title":"migrations_resources_regex","text":"[jvm]\\ val migrations_resources_regex: String
Regular expression migration files names should match. Any migration filename that doesn\u2019t match the given regular expression will cause an exception, unless it was explicitly mentioned in migrations_resources_exclusion.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/mysql_enforce_writable_connections/","title":"mysql_enforce_writable_connections - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/mysql_enforce_writable_connections
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/mysql_enforce_writable_connections/#mysql_enforce_writable_connections","title":"mysql_enforce_writable_connections","text":"[jvm]\\ val mysql_enforce_writable_connections: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/password/","title":"password - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/password
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/password/#password","title":"password","text":"[jvm]\\ val password: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/port/","title":"port - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/port
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/port/#port","title":"port","text":"[jvm]\\ val port: Int? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/query_timeout/","title":"query_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/query_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/query_timeout/#query_timeout","title":"query_timeout","text":"[jvm]\\ val query_timeout: Duration?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/show_sql/","title":"show_sql - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/show_sql
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/show_sql/#show_sql","title":"show_sql","text":"[jvm]\\ val show_sql: String?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_password/","title":"trust_certificate_key_store_password - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/trust_certificate_key_store_password
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_password/#trust_certificate_key_store_password","title":"trust_certificate_key_store_password","text":"[jvm]\\ val trust_certificate_key_store_password: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_path/","title":"trust_certificate_key_store_path - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/trust_certificate_key_store_path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_path/#trust_certificate_key_store_path","title":"trust_certificate_key_store_path","text":"[jvm]\\ val trust_certificate_key_store_path: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_url/","title":"trust_certificate_key_store_url - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/trust_certificate_key_store_url
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_url/#trust_certificate_key_store_url","title":"trust_certificate_key_store_url","text":"[jvm]\\ val trust_certificate_key_store_url: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/type/","title":"type - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/type
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/type/#type","title":"type","text":"[jvm]\\ val type: DataSourceType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/use_fixed_pool_size/","title":"use_fixed_pool_size - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/use_fixed_pool_size
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/use_fixed_pool_size/#use_fixed_pool_size","title":"use_fixed_pool_size","text":"[jvm]\\ val use_fixed_pool_size: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/username/","title":"username - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/username
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/username/#username","title":"username","text":"[jvm]\\ val username: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/validation_timeout/","title":"validation_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/validation_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/validation_timeout/#validation_timeout","title":"validation_timeout","text":"[jvm]\\ val validation_timeout: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/verify_server_identity/","title":"verify_server_identity - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/verify_server_identity
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/verify_server_identity/#verify_server_identity","title":"verify_server_identity","text":"[jvm]\\ val verify_server_identity: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/vitess_schema_resource_root/","title":"vitess_schema_resource_root - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/vitess_schema_resource_root
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/vitess_schema_resource_root/#vitess_schema_resource_root","title":"vitess_schema_resource_root","text":"[jvm]\\ val vitess_schema_resource_root: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/with-defaults/","title":"withDefaults - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/withDefaults
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/with-defaults/#withdefaults","title":"withDefaults","text":"[jvm]\\ fun withDefaults(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/","title":"DataSourceConnector - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConnector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/#datasourceconnector","title":"DataSourceConnector","text":"interface DataSourceConnector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/#inheritors","title":"Inheritors","text":"DataSourceService"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/#functions","title":"Functions","text":"Name Summary config [jvm]abstract fun config(): DataSourceConfig"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConnector/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/config/#config","title":"config","text":"[jvm]\\ abstract fun config(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/","title":"DataSourceDecorator - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceDecorator
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/#datasourcedecorator","title":"DataSourceDecorator","text":"interface DataSourceDecorator
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/#inheritors","title":"Inheritors","text":"SpanInjector"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/#functions","title":"Functions","text":"Name Summary decorate [jvm]abstract fun decorate(dataSource: DataSource): DataSource"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/decorate/","title":"decorate - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceDecorator/decorate
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/decorate/#decorate","title":"decorate","text":"[jvm]\\ abstract fun decorate(dataSource: DataSource): DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/","title":"DataSourceService - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#datasourceservice","title":"DataSourceService","text":"@Singleton
class DataSourceService@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null) : AbstractIdleService, DataSourceConnector, Provider<DataSource>
Builds a connection pool to a JDBC database. Doesn\u2019t do any schema migration or validation.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#parameters","title":"Parameters","text":"jvm
baseConfig the configuration to connect to. The actual database name used may vary as the databasePool can pick an alternate database name for testing."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#constructors","title":"Constructors","text":"DataSourceService [jvm]@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#properties","title":"Properties","text":"Name Summary dataSource [jvm]val dataSource: DataSource"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) config [jvm]open override fun config(): DataSourceConfig failureCause [jvm]override fun failureCause(): Throwable get [jvm]open override fun get(): DataSource isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-data-source-service/","title":"DataSourceService - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/DataSourceService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-data-source-service/#datasourceservice","title":"DataSourceService","text":"[jvm]\\
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-data-source-service/#parameters","title":"Parameters","text":"jvm
baseConfig the configuration to connect to. The actual database name used may vary as the databasePool can pick an alternate database name for testing."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/config/#config","title":"config","text":"[jvm]\\ open override fun config(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/data-source/","title":"dataSource - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/dataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/data-source/#datasource","title":"dataSource","text":"[jvm]\\ val dataSource: DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/get/","title":"get - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/get
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/","title":"DataSourceType - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#datasourcetype","title":"DataSourceType","text":"[jvm]\\ enum DataSourceType : Enum<DataSourceType>
Defines a type of datasource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#entries","title":"Entries","text":"MYSQL [jvm]MYSQL HSQLDB [jvm]HSQLDB VITESS_MYSQL [jvm]VITESS_MYSQL COCKROACHDB [jvm]COCKROACHDB POSTGRESQL [jvm]POSTGRESQL TIDB [jvm]TIDB"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String entries [jvm]val entries: EnumEntries<DataSourceType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): DataSourceTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<DataSourceType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/driver-class-name/","title":"driverClassName - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/driverClassName
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/driver-class-name/#driverclassname","title":"driverClassName","text":"[jvm]\\ val driverClassName: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<DataSourceType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/hibernate-dialect/","title":"hibernateDialect - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/hibernateDialect
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/hibernate-dialect/#hibernatedialect","title":"hibernateDialect","text":"[jvm]\\ val hibernateDialect: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/is-vitess/","title":"isVitess - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/isVitess
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/is-vitess/#isvitess","title":"isVitess","text":"[jvm]\\ val isVitess: Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): DataSourceType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/values/","title":"values - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<DataSourceType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-c-o-c-k-r-o-a-c-h-d-b/","title":"COCKROACHDB - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/COCKROACHDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-c-o-c-k-r-o-a-c-h-d-b/#cockroachdb","title":"COCKROACHDB","text":"[jvm]\\ COCKROACHDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-c-o-c-k-r-o-a-c-h-d-b/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-h-s-q-l-d-b/","title":"HSQLDB - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/HSQLDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-h-s-q-l-d-b/#hsqldb","title":"HSQLDB","text":"[jvm]\\ HSQLDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-h-s-q-l-d-b/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-m-y-s-q-l/","title":"MYSQL - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-m-y-s-q-l/#mysql","title":"MYSQL","text":"[jvm]\\ MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-m-y-s-q-l/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-p-o-s-t-g-r-e-s-q-l/","title":"POSTGRESQL - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/POSTGRESQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-p-o-s-t-g-r-e-s-q-l/#postgresql","title":"POSTGRESQL","text":"[jvm]\\ POSTGRESQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-p-o-s-t-g-r-e-s-q-l/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-t-i-d-b/","title":"TIDB - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/TIDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-t-i-d-b/#tidb","title":"TIDB","text":"[jvm]\\ TIDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-t-i-d-b/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-v-i-t-e-s-s_-m-y-s-q-l/","title":"VITESS_MYSQL - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/VITESS_MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-v-i-t-e-s-s_-m-y-s-q-l/#vitess_mysql","title":"VITESS_MYSQL","text":"[jvm]\\ VITESS_MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-v-i-t-e-s-s_-m-y-s-q-l/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/","title":"DatabasePool - Misk","text":"//misk-jdbc/misk.jdbc/DatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/#databasepool","title":"DatabasePool","text":"interface DatabasePool
Figures out what database name to use for a given config. Tests use this to pool many databases for concurrent execution. In development, staging, and production the database never changes.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/#inheritors","title":"Inheritors","text":"RealDatabasePool"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/#functions","title":"Functions","text":"Name Summary releaseDatabase [jvm]abstract fun releaseDatabase(config: DataSourceConfig)Releases a config created by takeDatabase. takeDatabase [jvm]abstract fun takeDatabase(config: DataSourceConfig): DataSourceConfigFinds a database to satisfy config and returns a new config that targets it."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/release-database/","title":"releaseDatabase - Misk","text":"//misk-jdbc/misk.jdbc/DatabasePool/releaseDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/release-database/#releasedatabase","title":"releaseDatabase","text":"[jvm]\\ abstract fun releaseDatabase(config: DataSourceConfig)
Releases a config created by takeDatabase.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/take-database/","title":"takeDatabase - Misk","text":"//misk-jdbc/misk.jdbc/DatabasePool/takeDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/take-database/#takedatabase","title":"takeDatabase","text":"[jvm]\\ abstract fun takeDatabase(config: DataSourceConfig): DataSourceConfig
Finds a database to satisfy config and returns a new config that targets it.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-ready-service/","title":"DatabaseReadyService - Misk","text":"//misk-jdbc/misk.jdbc/DatabaseReadyService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-ready-service/#databasereadyservice","title":"DatabaseReadyService","text":"interface DatabaseReadyService : Service
Marker interface for indicating that the database is ready.
Services that require a database connection should depend on this interface when they are installed in a module.
e.g.
install(ServiceModule<MoviesService>()\n .dependsOn<DatabaseReadyService>(Movies::class))\n//misk-jdbc/misk.jdbc/JDBCSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#jdbcsession","title":"JDBCSession","text":"[jvm]\\ class JDBCSession(val connection: Connection) : Session
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#constructors","title":"Constructors","text":"JDBCSession [jvm]constructor(connection: Connection)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#types","title":"Types","text":"Name Summary HookType [jvm]enum HookType : Enum<JDBCSession.HookType>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#properties","title":"Properties","text":"Name Summary connection [jvm]val connection: Connection"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#functions","title":"Functions","text":"Name Summary add [jvm]fun ConcurrentMap<JDBCSession.HookType, List<() -> Unit>>.add(hookType: JDBCSession.HookType, work: () -> Unit) component1 [jvm]operator fun component1(): ConnectionAllows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (connection) -> \u2026 } executePostCommitHooks [jvm]fun executePostCommitHooks() executePreCommitHooks [jvm]fun executePreCommitHooks() executeSessionCloseHooks [jvm]fun executeSessionCloseHooks() onPostCommit [jvm]open override fun onPostCommit(work: () -> Unit)Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed onPreCommit [jvm]open override fun onPreCommit(work: () -> Unit)Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back. onSessionClose [jvm]open override fun onSessionClose(work: () -> Unit)Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back. useConnection [jvm]open override fun <T> useConnection(work: (Connection) -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-j-d-b-c-session/","title":"JDBCSession - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/JDBCSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-j-d-b-c-session/#jdbcsession","title":"JDBCSession","text":"[jvm]\\ constructor(connection: Connection)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/add/","title":"add - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/add
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/add/#add","title":"add","text":"[jvm]\\ fun ConcurrentMap<JDBCSession.HookType, List<() -> Unit>>.add(hookType: JDBCSession.HookType, work: () -> Unit)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/component1/","title":"component1 - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/component1
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/component1/#component1","title":"component1","text":"[jvm]\\ operator fun component1(): Connection
Allows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (connection) -> \u2026 }
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/connection/","title":"connection - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/connection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/connection/#connection","title":"connection","text":"[jvm]\\ val connection: Connection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-post-commit-hooks/","title":"executePostCommitHooks - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/executePostCommitHooks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-post-commit-hooks/#executepostcommithooks","title":"executePostCommitHooks","text":"[jvm]\\ fun executePostCommitHooks()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-pre-commit-hooks/","title":"executePreCommitHooks - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/executePreCommitHooks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-pre-commit-hooks/#executeprecommithooks","title":"executePreCommitHooks","text":"[jvm]\\ fun executePreCommitHooks()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-session-close-hooks/","title":"executeSessionCloseHooks - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/executeSessionCloseHooks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-session-close-hooks/#executesessionclosehooks","title":"executeSessionCloseHooks","text":"[jvm]\\ fun executeSessionCloseHooks()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-post-commit/","title":"onPostCommit - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/onPostCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-post-commit/#onpostcommit","title":"onPostCommit","text":"[jvm]\\ open override fun onPostCommit(work: () -> Unit)
Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-pre-commit/","title":"onPreCommit - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/onPreCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-pre-commit/#onprecommit","title":"onPreCommit","text":"[jvm]\\ open override fun onPreCommit(work: () -> Unit)
Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-session-close/","title":"onSessionClose - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/onSessionClose
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-session-close/#onsessionclose","title":"onSessionClose","text":"[jvm]\\ open override fun onSessionClose(work: () -> Unit)
Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back.
A new transaction can be initiated as part of this hook.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/use-connection/","title":"useConnection - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/useConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/use-connection/#useconnection","title":"useConnection","text":"[jvm]\\ open override fun <T> useConnection(work: (Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/","title":"HookType - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#hooktype","title":"HookType","text":"[jvm]\\ enum HookType : Enum<JDBCSession.HookType>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#entries","title":"Entries","text":"PRE [jvm]PRE POST [jvm]POST SESSION_CLOSE [jvm]SESSION_CLOSE"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<JDBCSession.HookType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): JDBCSession.HookTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<JDBCSession.HookType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<JDBCSession.HookType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): JDBCSession.HookType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/values/","title":"values - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<JDBCSession.HookType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-o-s-t/","title":"POST - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/POST
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-o-s-t/#post","title":"POST","text":"[jvm]\\ POST
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-o-s-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-r-e/","title":"PRE - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/PRE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-r-e/#pre","title":"PRE","text":"[jvm]\\ PRE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/","title":"SESSION_CLOSE - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/SESSION_CLOSE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#session_close","title":"SESSION_CLOSE","text":"[jvm]\\ SESSION_CLOSE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/","title":"JdbcModule - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#jdbcmodule","title":"JdbcModule","text":"[jvm]\\ class JdbcModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true) : KAbstractModule
Binds database connectivity for a qualified data source. This binds the following public types:
DataSource.getConnection can be used to get JDBC connections to your database.
This also registers services to connect to the database (DataSourceService) and to verify that the schema is up-to-date (SchemaMigratorService).
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#constructors","title":"Constructors","text":"JdbcModule [jvm]constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig databasePool [jvm]val databasePool: DatabasePool readerConfig [jvm]val readerConfig: DataSourceConfig?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/-jdbc-module/","title":"JdbcModule - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/JdbcModule
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/-jdbc-module/#jdbcmodule","title":"JdbcModule","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/database-pool/","title":"databasePool - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/databasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/database-pool/#databasepool","title":"databasePool","text":"[jvm]\\ val databasePool: DatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/reader-config/","title":"readerConfig - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/readerConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/reader-config/#readerconfig","title":"readerConfig","text":"[jvm]\\ val readerConfig: DataSourceConfig?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/","title":"PingDatabaseService - Misk","text":"//misk-jdbc/misk.jdbc/PingDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/#pingdatabaseservice","title":"PingDatabaseService","text":"[jvm]\\ @Singleton
class PingDatabaseService@Injectconstructor(config: DataSourceConfig, deployment: Deployment) : AbstractIdleService
Service that waits for the database to become healthy. This is needed if we\u2019re booting up a Vitess cluster as part of the test run.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/#constructors","title":"Constructors","text":"PingDatabaseService [jvm]@Injectconstructor(config: DataSourceConfig, deployment: Deployment)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/-ping-database-service/","title":"PingDatabaseService - Misk","text":"//misk-jdbc/misk.jdbc/PingDatabaseService/PingDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/-ping-database-service/#pingdatabaseservice","title":"PingDatabaseService","text":"[jvm]\\
@Inject
constructor(config: DataSourceConfig, deployment: Deployment)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-jdbc/misk.jdbc/PostCommitHookFailedException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ class PostCommitHookFailedException(cause: Throwable) : Exception
PostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#constructors","title":"Constructors","text":"PostCommitHookFailedException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-jdbc/misk.jdbc/PostCommitHookFailedException/PostCommitHookFailedException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ constructor(cause: Throwable)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/","title":"RealDatabasePool - Misk","text":"//misk-jdbc/misk.jdbc/RealDatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/#realdatabasepool","title":"RealDatabasePool","text":"[jvm]\\ object RealDatabasePool : DatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/#functions","title":"Functions","text":"Name Summary releaseDatabase [jvm]open override fun releaseDatabase(config: DataSourceConfig)Releases a config created by takeDatabase. takeDatabase [jvm]open override fun takeDatabase(config: DataSourceConfig): DataSourceConfigFinds a database to satisfy config and returns a new config that targets it."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/release-database/","title":"releaseDatabase - Misk","text":"//misk-jdbc/misk.jdbc/RealDatabasePool/releaseDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/release-database/#releasedatabase","title":"releaseDatabase","text":"[jvm]\\ open override fun releaseDatabase(config: DataSourceConfig)
Releases a config created by takeDatabase.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/take-database/","title":"takeDatabase - Misk","text":"//misk-jdbc/misk.jdbc/RealDatabasePool/takeDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/take-database/#takedatabase","title":"takeDatabase","text":"[jvm]\\ open override fun takeDatabase(config: DataSourceConfig): DataSourceConfig
Finds a database to satisfy config and returns a new config that targets it.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/","title":"RealTransacter - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#realtransacter","title":"RealTransacter","text":"[jvm]\\ class RealTransacter(dataSourceService: DataSourceService) : Transacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#constructors","title":"Constructors","text":"RealTransacter [jvm]constructor(dataSourceService: DataSourceService)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#properties","title":"Properties","text":"Name Summary inTransaction [jvm]open override val inTransaction: BooleanReturns true if the calling thread is currently within a transaction block."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#functions","title":"Functions","text":"Name Summary transaction [jvm]open override fun <T> transaction(work: (connection: Connection) -> T): TStarts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed. transactionWithSession [jvm]open override fun <T> transactionWithSession(work: (session: JDBCSession) -> T): TStarts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/-real-transacter/","title":"RealTransacter - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/RealTransacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/-real-transacter/#realtransacter","title":"RealTransacter","text":"[jvm]\\ constructor(dataSourceService: DataSourceService)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/in-transaction/","title":"inTransaction - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/inTransaction
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/in-transaction/#intransaction","title":"inTransaction","text":"[jvm]\\ open override val inTransaction: Boolean
Returns true if the calling thread is currently within a transaction block.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction-with-session/","title":"transactionWithSession - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/transactionWithSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction-with-session/#transactionwithsession","title":"transactionWithSession","text":"[jvm]\\ open override fun <T> transactionWithSession(work: (session: JDBCSession) -> T): T
Starts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed.
This session object passed in wraps a connection and provides a way to add pre and post commit hooks that execute before and after a transaction is committed.
It is an error to start a transaction if another transaction is already in progress.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction/","title":"transaction - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/transaction
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\ open override fun <T> transaction(work: (connection: Connection) -> T): T
Starts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed.
It is an error to start a transaction if another transaction is already in progress.
Prefer using transactionWithSession instead of this method as it has more functionality such as commit hooks.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/","title":"SchemaMigratorService - Misk","text":"//misk-jdbc/misk.jdbc/SchemaMigratorService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/#schemamigratorservice","title":"SchemaMigratorService","text":"[jvm]\\ class SchemaMigratorService : AbstractIdleService, HealthCheck, DatabaseReadyService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State status [jvm]open override fun status(): HealthStatus stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/status/","title":"status - Misk","text":"//misk-jdbc/misk.jdbc/SchemaMigratorService/status
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/status/#status","title":"status","text":"[jvm]\\ open override fun status(): HealthStatus
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/","title":"Session - Misk","text":"//misk-jdbc/misk.jdbc/Session
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/#session","title":"Session","text":"interface Session
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/#inheritors","title":"Inheritors","text":"JDBCSession"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/#functions","title":"Functions","text":"Name Summary onPostCommit [jvm]abstract fun onPostCommit(work: () -> Unit)Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed onPreCommit [jvm]abstract fun onPreCommit(work: () -> Unit)Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back. onSessionClose [jvm]abstract fun onSessionClose(work: () -> Unit)Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back. useConnection [jvm]abstract fun <T> useConnection(work: (Connection) -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-post-commit/","title":"onPostCommit - Misk","text":"//misk-jdbc/misk.jdbc/Session/onPostCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-post-commit/#onpostcommit","title":"onPostCommit","text":"[jvm]\\ abstract fun onPostCommit(work: () -> Unit)
Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-pre-commit/","title":"onPreCommit - Misk","text":"//misk-jdbc/misk.jdbc/Session/onPreCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-pre-commit/#onprecommit","title":"onPreCommit","text":"[jvm]\\ abstract fun onPreCommit(work: () -> Unit)
Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-session-close/","title":"onSessionClose - Misk","text":"//misk-jdbc/misk.jdbc/Session/onSessionClose
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-session-close/#onsessionclose","title":"onSessionClose","text":"[jvm]\\ abstract fun onSessionClose(work: () -> Unit)
Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back.
A new transaction can be initiated as part of this hook.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/use-connection/","title":"useConnection - Misk","text":"//misk-jdbc/misk.jdbc/Session/useConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/use-connection/#useconnection","title":"useConnection","text":"[jvm]\\ abstract fun <T> useConnection(work: (Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/","title":"SpanInjector - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#spaninjector","title":"SpanInjector","text":"[jvm]\\ class SpanInjector(val tracer: Tracer?, val config: DataSourceConfig) : QueryTransformer, DataSourceDecorator
On the fly decorates queries with the span context, so the query call can be traced all the way through Vitess
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#constructors","title":"Constructors","text":"SpanInjector [jvm]constructor(tracer: Tracer?, config: DataSourceConfig)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig tracer [jvm]val tracer: Tracer?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#functions","title":"Functions","text":"Name Summary decorate [jvm]open override fun decorate(dataSource: DataSource): DataSource transformQuery [jvm]open override fun transformQuery(transformInfo: TransformInfo?): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/-span-injector/","title":"SpanInjector - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/SpanInjector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/-span-injector/#spaninjector","title":"SpanInjector","text":"[jvm]\\ constructor(tracer: Tracer?, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/decorate/","title":"decorate - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/decorate
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/decorate/#decorate","title":"decorate","text":"[jvm]\\ open override fun decorate(dataSource: DataSource): DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/tracer/","title":"tracer - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/tracer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/tracer/#tracer","title":"tracer","text":"[jvm]\\ val tracer: Tracer?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/transform-query/","title":"transformQuery - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/transformQuery
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/transform-query/#transformquery","title":"transformQuery","text":"[jvm]\\ open override fun transformQuery(transformInfo: TransformInfo?): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/","title":"StringBuilderCarrier - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#stringbuildercarrier","title":"StringBuilderCarrier","text":"[jvm]\\ class StringBuilderCarrier : TextMap
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#constructors","title":"Constructors","text":"StringBuilderCarrier [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#properties","title":"Properties","text":"Name Summary map [jvm]val map: HashMap<String, String>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#functions","title":"Functions","text":"Name Summary forEach [jvm]open fun forEach(p0: Consumer<in MutableMap.MutableEntry<String, String>>) iterator [jvm]open operator override fun iterator(): MutableIterator<MutableMap.MutableEntry<String, String>> put [jvm]open override fun put(key: String?, value: String?) spliterator [jvm]open fun spliterator(): Spliterator<MutableMap.MutableEntry<String, String>> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/-string-builder-carrier/","title":"StringBuilderCarrier - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/StringBuilderCarrier
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/-string-builder-carrier/#stringbuildercarrier","title":"StringBuilderCarrier","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/iterator/","title":"iterator - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/iterator
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/iterator/#iterator","title":"iterator","text":"[jvm]\\ open operator override fun iterator(): MutableIterator<MutableMap.MutableEntry<String, String>>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/map/","title":"map - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/map
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/map/#map","title":"map","text":"[jvm]\\ val map: HashMap<String, String>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/put/","title":"put - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/put
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/put/#put","title":"put","text":"[jvm]\\ open override fun put(key: String?, value: String?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/","title":"TableScanException - Misk","text":"//misk-jdbc/misk.jdbc/TableScanException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#tablescanexception","title":"TableScanException","text":"[jvm]\\ class TableScanException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckException
Exception thrown if we execute a query lacking an index.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#constructors","title":"Constructors","text":"TableScanException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/-table-scan-exception/","title":"TableScanException - Misk","text":"//misk-jdbc/misk.jdbc/TableScanException/TableScanException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/-table-scan-exception/#tablescanexception","title":"TableScanException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/","title":"Transacter - Misk","text":"//misk-jdbc/misk.jdbc/Transacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#transacter","title":"Transacter","text":"interface Transacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#inheritors","title":"Inheritors","text":"RealTransacter"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#properties","title":"Properties","text":"Name Summary inTransaction [jvm]abstract val inTransaction: BooleanReturns true if the calling thread is currently within a transaction block."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#functions","title":"Functions","text":"Name Summary transactionWithSession [jvm]abstract fun <T> transactionWithSession(work: (session: JDBCSession) -> T): TStarts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/in-transaction/","title":"inTransaction - Misk","text":"//misk-jdbc/misk.jdbc/Transacter/inTransaction
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/in-transaction/#intransaction","title":"inTransaction","text":"[jvm]\\ abstract val inTransaction: Boolean
Returns true if the calling thread is currently within a transaction block.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/transaction-with-session/","title":"transactionWithSession - Misk","text":"//misk-jdbc/misk.jdbc/Transacter/transactionWithSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/transaction-with-session/#transactionwithsession","title":"transactionWithSession","text":"[jvm]\\ abstract fun <T> transactionWithSession(work: (session: JDBCSession) -> T): T
Starts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed.
This session object passed in wraps a connection and provides a way to add pre and post commit hooks that execute before and after a transaction is committed.
It is an error to start a transaction if another transaction is already in progress.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/","title":"Package-level declarations - Misk","text":"//misk-jdbc/misk.vitess
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/#types","title":"Types","text":"Name Summary CowriteException [jvm]class CowriteException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckExceptionThrown when a transaction that writes to multiple entity groups is detected. Destination [jvm]data class Destination(val keyspace: Keyspace?, val shard: Shard?, val tabletType: TabletType?) FullScatterException [jvm]class FullScatterException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckExceptionException thrown if we use a scatter query that is too wide in the wrong context. Keyspace [jvm]data class Keyspace(val name: String) Shard [jvm]data class Shard(val keyspace: Keyspace, val name: String) TabletType [jvm]enum TabletType : Enum<TabletType>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/#functions","title":"Functions","text":"Name Summary checkValidShardIdentifier [jvm]fun checkValidShardIdentifier(identifier: String) failSafeRead [jvm]fun <T> Connection.failSafeRead(block: (conn: Connection) -> T): TRuns a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.[jvm]fun <T> Connection.failSafeRead(shard: Shard, block: (conn: Connection) -> T): T getRootCause [jvm]fun getRootCause(throwable: Throwable): Throwable shards [jvm]fun shards(dataSourceService: DataSourceService): Supplier<Set<Shard>> tabletDoesNotExists [jvm]fun tabletDoesNotExists(e: Exception): Boolean target [jvm]fun <T> Connection.target(shard: Shard, block: (conn: Connection) -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/check-valid-shard-identifier/","title":"checkValidShardIdentifier - Misk","text":"//misk-jdbc/misk.vitess/checkValidShardIdentifier
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/check-valid-shard-identifier/#checkvalidshardidentifier","title":"checkValidShardIdentifier","text":"[jvm]\\ fun checkValidShardIdentifier(identifier: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/fail-safe-read/","title":"failSafeRead - Misk","text":"//misk-jdbc/misk.vitess/failSafeRead
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/fail-safe-read/#failsaferead","title":"failSafeRead","text":"[jvm]\\ fun <T> Connection.failSafeRead(block: (conn: Connection) -> T): T
Runs a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.
[jvm]\\ fun <T> Connection.failSafeRead(shard: Shard, block: (conn: Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/get-root-cause/","title":"getRootCause - Misk","text":"//misk-jdbc/misk.vitess/getRootCause
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/get-root-cause/#getrootcause","title":"getRootCause","text":"[jvm]\\ fun getRootCause(throwable: Throwable): Throwable
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/shards/","title":"shards - Misk","text":"//misk-jdbc/misk.vitess/shards
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/shards/#shards","title":"shards","text":"[jvm]\\ fun shards(dataSourceService: DataSourceService): Supplier<Set<Shard>>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/tablet-does-not-exists/","title":"tabletDoesNotExists - Misk","text":"//misk-jdbc/misk.vitess/tabletDoesNotExists
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/tablet-does-not-exists/#tabletdoesnotexists","title":"tabletDoesNotExists","text":"[jvm]\\ fun tabletDoesNotExists(e: Exception): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/target/","title":"target - Misk","text":"//misk-jdbc/misk.vitess/target
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/target/#target","title":"target","text":"[jvm]\\ fun <T> Connection.target(shard: Shard, block: (conn: Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/","title":"CowriteException - Misk","text":"//misk-jdbc/misk.vitess/CowriteException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#cowriteexception","title":"CowriteException","text":"[jvm]\\ class CowriteException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckException
Thrown when a transaction that writes to multiple entity groups is detected.
Multi shard transactions are not safe and while multiple entity groups may currently reside on the same shard there is no guarantee they will do so across shard splits.
A transaction never spans a shard split. That is they never start before the split and end after, either they commit before the split or they start after the split. That said a transaction may start before a shard split and then time out or cancel and be retried after the shard split. If two entity groups resided on the same shard before the transaction they may no longer do so when the transaction is retried.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#constructors","title":"Constructors","text":"CowriteException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/-cowrite-exception/","title":"CowriteException - Misk","text":"//misk-jdbc/misk.vitess/CowriteException/CowriteException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/-cowrite-exception/#cowriteexception","title":"CowriteException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/","title":"Destination - Misk","text":"//misk-jdbc/misk.vitess/Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#destination","title":"Destination","text":"[jvm]\\ data class Destination(val keyspace: Keyspace?, val shard: Shard?, val tabletType: TabletType?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#constructors","title":"Constructors","text":"Destination [jvm]constructor(shard: Shard)constructor(tabletType: TabletType)constructor(shard: Shard, tabletType: TabletType)constructor(keyspace: Keyspace?, shard: Shard?, tabletType: TabletType?)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#properties","title":"Properties","text":"Name Summary keyspace [jvm]val keyspace: Keyspace? shard [jvm]val shard: Shard? tabletType [jvm]val tabletType: TabletType?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#functions","title":"Functions","text":"Name Summary isBlank [jvm]fun isBlank(): Boolean mergedWith [jvm]fun mergedWith(other: Destination): Destination toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-destination/","title":"Destination - Misk","text":"//misk-jdbc/misk.vitess/Destination/Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-destination/#destination","title":"Destination","text":"[jvm]\\ constructor(shard: Shard)
constructor(tabletType: TabletType)
constructor(shard: Shard, tabletType: TabletType)
constructor(keyspace: Keyspace?, shard: Shard?, tabletType: TabletType?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/is-blank/","title":"isBlank - Misk","text":"//misk-jdbc/misk.vitess/Destination/isBlank
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/is-blank/#isblank","title":"isBlank","text":"[jvm]\\ fun isBlank(): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/keyspace/","title":"keyspace - Misk","text":"//misk-jdbc/misk.vitess/Destination/keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/keyspace/#keyspace","title":"keyspace","text":"[jvm]\\ val keyspace: Keyspace?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/merged-with/","title":"mergedWith - Misk","text":"//misk-jdbc/misk.vitess/Destination/mergedWith
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/merged-with/#mergedwith","title":"mergedWith","text":"[jvm]\\ fun mergedWith(other: Destination): Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/shard/","title":"shard - Misk","text":"//misk-jdbc/misk.vitess/Destination/shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/shard/#shard","title":"shard","text":"[jvm]\\ val shard: Shard?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/tablet-type/","title":"tabletType - Misk","text":"//misk-jdbc/misk.vitess/Destination/tabletType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/tablet-type/#tablettype","title":"tabletType","text":"[jvm]\\ val tabletType: TabletType?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.vitess/Destination/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.vitess/Destination/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(string: String): Destination"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/parse/","title":"parse - Misk","text":"//misk-jdbc/misk.vitess/Destination/Companion/parse
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(string: String): Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/","title":"FullScatterException - Misk","text":"//misk-jdbc/misk.vitess/FullScatterException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#fullscatterexception","title":"FullScatterException","text":"[jvm]\\ class FullScatterException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckException
Exception thrown if we use a scatter query that is too wide in the wrong context.
Strongly consistent reads require reads from the master of a cluster. The master of a cluster is a limited resource that we can\u2019t add more of. We can split shards but a wide scatter query will still hit all of the shards so we can\u2019t scale if we have too many wide scatters. For this reason we do not allow wide scatters for strongly consistent reads.
Note: For eventually consistent reads (that go to replicas) we may very well allow wide scatter queries because we can tune the availability by adding more replicas. Currently we do NOT differentiate between these types of reads for the detector but if you do need this it can be implemented.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#constructors","title":"Constructors","text":"FullScatterException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/-full-scatter-exception/","title":"FullScatterException - Misk","text":"//misk-jdbc/misk.vitess/FullScatterException/FullScatterException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/-full-scatter-exception/#fullscatterexception","title":"FullScatterException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.vitess/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ data class Keyspace(val name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#constructors","title":"Constructors","text":"Keyspace [jvm]constructor(name: String)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.vitess/Keyspace/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/name/","title":"name - Misk","text":"//misk-jdbc/misk.vitess/Keyspace/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.vitess/Keyspace/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/","title":"Shard - Misk","text":"//misk-jdbc/misk.vitess/Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#shard","title":"Shard","text":"[jvm]\\ data class Shard(val keyspace: Keyspace, val name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#constructors","title":"Constructors","text":"Shard [jvm]constructor(keyspace: Keyspace, name: String)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Key [jvm]data class Key(val bytes: ByteString) : Comparable<Shard.Key>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#properties","title":"Properties","text":"Name Summary keyspace [jvm]val keyspace: Keyspace name [jvm]val name: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#functions","title":"Functions","text":"Name Summary contains [jvm]operator fun contains(keyspaceId: Shard.Key): Boolean keyRange [jvm]fun keyRange(): Range<Shard.Key> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-shard/","title":"Shard - Misk","text":"//misk-jdbc/misk.vitess/Shard/Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-shard/#shard","title":"Shard","text":"[jvm]\\ constructor(keyspace: Keyspace, name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/contains/","title":"contains - Misk","text":"//misk-jdbc/misk.vitess/Shard/contains
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/contains/#contains","title":"contains","text":"[jvm]\\ operator fun contains(keyspaceId: Shard.Key): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/key-range/","title":"keyRange - Misk","text":"//misk-jdbc/misk.vitess/Shard/keyRange
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/key-range/#keyrange","title":"keyRange","text":"[jvm]\\ fun keyRange(): Range<Shard.Key>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/keyspace/","title":"keyspace - Misk","text":"//misk-jdbc/misk.vitess/Shard/keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/keyspace/#keyspace","title":"keyspace","text":"[jvm]\\ val keyspace: Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/name/","title":"name - Misk","text":"//misk-jdbc/misk.vitess/Shard/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.vitess/Shard/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/#properties","title":"Properties","text":"Name Summary MAX_LENGTH [jvm]const val MAX_LENGTH: Int = 8 SINGLE_KEYSPACE [jvm]val SINGLE_KEYSPACE: Keyspace SINGLE_SHARD [jvm]val SINGLE_SHARD: Shard SINGLE_SHARD_ID [jvm]const val SINGLE_SHARD_ID: String SINGLE_SHARD_SET [jvm]val SINGLE_SHARD_SET: ImmutableSet<Shard>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(string: String): Shard"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-m-a-x_-l-e-n-g-t-h/","title":"MAX_LENGTH - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/MAX_LENGTH
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-m-a-x_-l-e-n-g-t-h/#max_length","title":"MAX_LENGTH","text":"[jvm]\\ const val MAX_LENGTH: Int = 8
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-k-e-y-s-p-a-c-e/","title":"SINGLE_KEYSPACE - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_KEYSPACE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-k-e-y-s-p-a-c-e/#single_keyspace","title":"SINGLE_KEYSPACE","text":"[jvm]\\ val SINGLE_KEYSPACE: Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d/","title":"SINGLE_SHARD - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_SHARD
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d/#single_shard","title":"SINGLE_SHARD","text":"[jvm]\\ val SINGLE_SHARD: Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-i-d/","title":"SINGLE_SHARD_ID - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_SHARD_ID
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-i-d/#single_shard_id","title":"SINGLE_SHARD_ID","text":"[jvm]\\ const val SINGLE_SHARD_ID: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-s-e-t/","title":"SINGLE_SHARD_SET - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_SHARD_SET
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-s-e-t/#single_shard_set","title":"SINGLE_SHARD_SET","text":"[jvm]\\ val SINGLE_SHARD_SET: ImmutableSet<Shard>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/parse/","title":"parse - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/parse
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(string: String): Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/","title":"Key - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#key","title":"Key","text":"[jvm]\\ data class Key(val bytes: ByteString) : Comparable<Shard.Key>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#constructors","title":"Constructors","text":"Key [jvm]constructor(hex: String)Vitess always converts sharding keys to a left-justified binary string for computing a shard. This left-justification makes the right-most zeroes insignificant and optional.constructor(bytes: ByteString)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#properties","title":"Properties","text":"Name Summary bytes [jvm]val bytes: ByteString"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Shard.Key): Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-key/","title":"Key - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/Key
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-key/#key","title":"Key","text":"[jvm]\\ constructor(hex: String)
Vitess always converts sharding keys to a left-justified binary string for computing a shard. This left-justification makes the right-most zeroes insignificant and optional.
To make compareTo, equals and hashCode work properly in Java, these keys are force padded with 0\u2019s at the end. Dynamic end padding when comparing would break the equals/hashCode contract in Java.
[jvm]\\ constructor(bytes: ByteString)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/bytes/","title":"bytes - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/bytes
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/bytes/#bytes","title":"bytes","text":"[jvm]\\ val bytes: ByteString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/compare-to/","title":"compareTo - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/compareTo
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Shard.Key): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/#functions","title":"Functions","text":"Name Summary hash [jvm]fun hash(id: Long): Shard.Key"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/hash/","title":"hash - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/Companion/hash
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/hash/#hash","title":"hash","text":"[jvm]\\ fun hash(id: Long): Shard.Key
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/","title":"TabletType - Misk","text":"//misk-jdbc/misk.vitess/TabletType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#tablettype","title":"TabletType","text":"[jvm]\\ enum TabletType : Enum<TabletType>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#entries","title":"Entries","text":"MASTER [jvm]MASTER REPLICA [jvm]REPLICA"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<TabletType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): TabletTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<TabletType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.vitess/TabletType/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<TabletType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.vitess/TabletType/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): TabletType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value/","title":"value - Misk","text":"//misk-jdbc/misk.vitess/TabletType/value
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value/#value","title":"value","text":"[jvm]\\ val value: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/values/","title":"values - Misk","text":"//misk-jdbc/misk.vitess/TabletType/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<TabletType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-m-a-s-t-e-r/","title":"MASTER - Misk","text":"//misk-jdbc/misk.vitess/TabletType/MASTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-m-a-s-t-e-r/#master","title":"MASTER","text":"[jvm]\\ MASTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-m-a-s-t-e-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-r-e-p-l-i-c-a/","title":"REPLICA - Misk","text":"//misk-jdbc/misk.vitess/TabletType/REPLICA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-r-e-p-l-i-c-a/#replica","title":"REPLICA","text":"[jvm]\\ REPLICA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-r-e-p-l-i-c-a/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jobqueue/","title":"misk-jobqueue - Misk","text":"//misk-jobqueue
"},{"location":"0.x/misk-jobqueue/#misk-jobqueue","title":"misk-jobqueue","text":""},{"location":"0.x/misk-jobqueue/#packages","title":"Packages","text":"Name misk.jobqueue"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/","title":"Package-level declarations - Misk","text":"//misk-jobqueue/misk.jobqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/#types","title":"Types","text":"Name Summary Job [jvm]interface JobIncoming job JobConsumer [jvm]interface JobConsumerA JobConsumer allows applications to subscribe to receive incoming jobs JobHandler [jvm]interface JobHandlerA JobHandler is an application implemented interface that handles jobs received by this service. JobHandlers must explicitly call Job.acknowledge after successful processing to cause the to be deleted from the underlying queue and not redelivered, or can call Job.deadLetter to put the job onto the associated dead letter queue. The jobqueue framework assumes that the underlying queueing system is at-least-once, so handlers must be prepared for the possibility that a job will be delivered more than once (for example if the process fails or the visibility timeout expires after processing but before acknowledgement). Typically this is handled by either storing some sort of ticket in the local database when the job is enqueued and deleting it as part of the application transaction when the job is processed but prior to acknowledgement, or by storing some sort of \"processed marker\" in the local database during job processing and ignoring jobs whose marker is already recorded. JobQueue [jvm]interface JobQueueA JobQueue enqueues jobs for asynchronous execution, possibly in another process. Jobs are enqueued immediately and may involve an RPC to the underlying job queueing system, so should not be done from within a database transaction. Applications that need to enqueue jobs atomically with a local database transaction should use the TransactionalJobQueue interface QueueName [jvm]data class QueueName(val value: String)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/#functions","title":"Functions","text":"Name Summary subscribe [jvm]inline fun JobConsumer.subscribe(queueName: QueueName, crossinline handler: (Job) -> Unit)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/subscribe/","title":"subscribe - Misk","text":"//misk-jobqueue/misk.jobqueue/subscribe
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ inline fun JobConsumer.subscribe(queueName: QueueName, crossinline handler: (Job) -> Unit)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/","title":"Job - Misk","text":"//misk-jobqueue/misk.jobqueue/Job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/#job","title":"Job","text":"[jvm]\\ interface Job
Incoming job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/#properties","title":"Properties","text":"Name Summary attributes [jvm]abstract val attributes: Map<String, String>context attributes associated with the job body [jvm]abstract val body: Stringbody of the job id [jvm]abstract val id: Stringsystem assigned globally unique id for the job idempotenceKey [jvm]abstract val idempotenceKey: StringApplication assigned key for a job. queueName [jvm]abstract val queueName: QueueNamename of the queue on which the job was received"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/#functions","title":"Functions","text":"Name Summary acknowledge [jvm]abstract fun acknowledge()Acknowledges the job and deletes it from the underlying queue. May perform an RPC, and thus should not be called while holding database transactions or other resources deadLetter [jvm]abstract fun deadLetter()Moves the job from the main queue onto the associated dead letter queue. May perform an RPC delayWithBackoff [jvm]abstract fun delayWithBackoff()Assigns and applies a visibility timeout for the job by making it unreachable for some time duration. The timeout increases after each retry. May perform an RPC."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/acknowledge/","title":"acknowledge - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/acknowledge
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/acknowledge/#acknowledge","title":"acknowledge","text":"[jvm]\\ abstract fun acknowledge()
Acknowledges the job and deletes it from the underlying queue. May perform an RPC, and thus should not be called while holding database transactions or other resources
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/attributes/","title":"attributes - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/attributes
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/attributes/#attributes","title":"attributes","text":"[jvm]\\ abstract val attributes: Map<String, String>
context attributes associated with the job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/body/","title":"body - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/body
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/body/#body","title":"body","text":"[jvm]\\ abstract val body: String
body of the job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/dead-letter/","title":"deadLetter - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/deadLetter
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/dead-letter/#deadletter","title":"deadLetter","text":"[jvm]\\ abstract fun deadLetter()
Moves the job from the main queue onto the associated dead letter queue. May perform an RPC
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/delay-with-backoff/","title":"delayWithBackoff - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/delayWithBackoff
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/delay-with-backoff/#delaywithbackoff","title":"delayWithBackoff","text":"[jvm]\\ abstract fun delayWithBackoff()
Assigns and applies a visibility timeout for the job by making it unreachable for some time duration. The timeout increases after each retry. May perform an RPC.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/id/","title":"id - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/id
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/id/#id","title":"id","text":"[jvm]\\ abstract val id: String
system assigned globally unique id for the job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/idempotence-key/","title":"idempotenceKey - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/idempotenceKey
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/idempotence-key/#idempotencekey","title":"idempotenceKey","text":"[jvm]\\ abstract val idempotenceKey: String
Application assigned key for a job.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/idempotence-key/#see-also","title":"See also","text":"JobQueue.enqueue"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/queue-name/","title":"queueName - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/queueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/queue-name/#queuename","title":"queueName","text":"[jvm]\\ abstract val queueName: QueueName
name of the queue on which the job was received
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/","title":"JobConsumer - Misk","text":"//misk-jobqueue/misk.jobqueue/JobConsumer
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/#jobconsumer","title":"JobConsumer","text":"[jvm]\\ interface JobConsumer
A JobConsumer allows applications to subscribe to receive incoming jobs
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/#functions","title":"Functions","text":"Name Summary subscribe [jvm]abstract fun subscribe(queueName: QueueName, handler: JobHandler)Registers a handler to receive messages. Once registered, the consumer will immediately begin receiving messages from the underlying job queue and dispatch them to the provided handler. A service may only have one subscription outstanding per queue subscribe [jvm]inline fun JobConsumer.subscribe(queueName: QueueName, crossinline handler: (Job) -> Unit) unsubscribe [jvm]abstract fun unsubscribe(queueName: QueueName)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/subscribe/","title":"subscribe - Misk","text":"//misk-jobqueue/misk.jobqueue/JobConsumer/subscribe
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ abstract fun subscribe(queueName: QueueName, handler: JobHandler)
Registers a handler to receive messages. Once registered, the consumer will immediately begin receiving messages from the underlying job queue and dispatch them to the provided handler. A service may only have one subscription outstanding per queue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/unsubscribe/","title":"unsubscribe - Misk","text":"//misk-jobqueue/misk.jobqueue/JobConsumer/unsubscribe
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/unsubscribe/#unsubscribe","title":"unsubscribe","text":"[jvm]\\ abstract fun unsubscribe(queueName: QueueName)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/","title":"JobHandler - Misk","text":"//misk-jobqueue/misk.jobqueue/JobHandler
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/#jobhandler","title":"JobHandler","text":"[jvm]\\ interface JobHandler
A JobHandler is an application implemented interface that handles jobs received by this service. JobHandlers must explicitly call Job.acknowledge after successful processing to cause the to be deleted from the underlying queue and not redelivered, or can call Job.deadLetter to put the job onto the associated dead letter queue. The jobqueue framework assumes that the underlying queueing system is at-least-once, so handlers must be prepared for the possibility that a job will be delivered more than once (for example if the process fails or the visibility timeout expires after processing but before acknowledgement). Typically this is handled by either storing some sort of ticket in the local database when the job is enqueued and deleting it as part of the application transaction when the job is processed but prior to acknowledgement, or by storing some sort of \"processed marker\" in the local database during job processing and ignoring jobs whose marker is already recorded.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/#functions","title":"Functions","text":"Name Summary handleJob [jvm]abstract fun handleJob(job: Job)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/handle-job/","title":"handleJob - Misk","text":"//misk-jobqueue/misk.jobqueue/JobHandler/handleJob
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/handle-job/#handlejob","title":"handleJob","text":"[jvm]\\ abstract fun handleJob(job: Job)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/","title":"JobQueue - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/#jobqueue","title":"JobQueue","text":"[jvm]\\ interface JobQueue
A JobQueue enqueues jobs for asynchronous execution, possibly in another process. Jobs are enqueued immediately and may involve an RPC to the underlying job queueing system, so should not be done from within a database transaction. Applications that need to enqueue jobs atomically with a local database transaction should use the TransactionalJobQueue interface
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/#types","title":"Types","text":"Name Summary BatchEnqueueException [jvm]data class BatchEnqueueException(val queueName: QueueName, val successful: List<String>, val failed: List<JobQueue.EnqueueErrorResult>) : ExceptionException Data class containing the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned Companion [jvm]object Companion EnqueueErrorResult [jvm]data class EnqueueErrorResult(val idempotenceKey: String, val clientError: Boolean, val code: String, val message: String)Data class containing the error result of a failed job enqueue JobRequest [jvm]data class JobRequest@JvmOverloadsconstructor(val body: String, val idempotenceKey: String = UUID.randomUUID().toString(), val deliveryDelay: Duration? = null, val attributes: Map<String, String> = mapOf())Data class containing the necessary information to be enqueued in a batch enqueue"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/#functions","title":"Functions","text":"Name Summary batchEnqueue [jvm]abstract fun batchEnqueue(queueName: QueueName, jobs: List<JobQueue.JobRequest>)throws BatchEnqueueException contains the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned enqueue [jvm]open fun enqueue(queueName: QueueName, body: String, deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())[jvm]abstract fun enqueue(queueName: QueueName, body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())Enqueue a job onto the given queue, along with a set of job attributes."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/batch-enqueue/","title":"batchEnqueue - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/batchEnqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/batch-enqueue/#batchenqueue","title":"batchEnqueue","text":"[jvm]\\ abstract fun batchEnqueue(queueName: QueueName, jobs: List<JobQueue.JobRequest>)
throws BatchEnqueueException contains the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/enqueue/","title":"enqueue - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/enqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/enqueue/#enqueue","title":"enqueue","text":"[jvm]\\ open fun enqueue(queueName: QueueName, body: String, deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())
[jvm]\\ abstract fun enqueue(queueName: QueueName, body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())
Enqueue a job onto the given queue, along with a set of job attributes.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/enqueue/#parameters","title":"Parameters","text":"jvm
queueName The name of the queue on which to place the job. body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body. idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set. deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m). If a longer delay is required by applications, use the TransactionalJobQueue interface instead. attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/","title":"BatchEnqueueException - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#batchenqueueexception","title":"BatchEnqueueException","text":"[jvm]\\ data class BatchEnqueueException(val queueName: QueueName, val successful: List<String>, val failed: List<JobQueue.EnqueueErrorResult>) : Exception
Exception Data class containing the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#constructors","title":"Constructors","text":"BatchEnqueueException [jvm]constructor(queueName: QueueName, successful: List<String>, failed: List<JobQueue.EnqueueErrorResult>)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? failed [jvm]val failed: List<JobQueue.EnqueueErrorResult> message [jvm]open val message: String? queueName [jvm]val queueName: QueueName successful [jvm]val successful: List<String>"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/-batch-enqueue-exception/","title":"BatchEnqueueException - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/BatchEnqueueException
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/-batch-enqueue-exception/#batchenqueueexception","title":"BatchEnqueueException","text":"[jvm]\\ constructor(queueName: QueueName, successful: List<String>, failed: List<JobQueue.EnqueueErrorResult>)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/failed/","title":"failed - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/failed
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/failed/#failed","title":"failed","text":"[jvm]\\ val failed: List<JobQueue.EnqueueErrorResult>
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/queue-name/","title":"queueName - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/queueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/queue-name/#queuename","title":"queueName","text":"[jvm]\\ val queueName: QueueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/successful/","title":"successful - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/successful
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/successful/#successful","title":"successful","text":"[jvm]\\ val successful: List<String>
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/","title":"Companion - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/Companion
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/#properties","title":"Properties","text":"Name Summary SQS_MAX_BATCH_ENQUEUE_JOB_SIZE [jvm]const val SQS_MAX_BATCH_ENQUEUE_JOB_SIZE: Int = 10"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/-s-q-s_-m-a-x_-b-a-t-c-h_-e-n-q-u-e-u-e_-j-o-b_-s-i-z-e/","title":"SQS_MAX_BATCH_ENQUEUE_JOB_SIZE - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/Companion/SQS_MAX_BATCH_ENQUEUE_JOB_SIZE
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/-s-q-s_-m-a-x_-b-a-t-c-h_-e-n-q-u-e-u-e_-j-o-b_-s-i-z-e/#sqs_max_batch_enqueue_job_size","title":"SQS_MAX_BATCH_ENQUEUE_JOB_SIZE","text":"[jvm]\\ const val SQS_MAX_BATCH_ENQUEUE_JOB_SIZE: Int = 10
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/","title":"EnqueueErrorResult - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#enqueueerrorresult","title":"EnqueueErrorResult","text":"data class EnqueueErrorResult(val idempotenceKey: String, val clientError: Boolean, val code: String, val message: String)
Data class containing the error result of a failed job enqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key for the failed enqueued job clientError Indicates whether the error is due to a clientside error code Error code returned by the JobQueue service message Error message returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#constructors","title":"Constructors","text":"EnqueueErrorResult [jvm]constructor(idempotenceKey: String, clientError: Boolean, code: String, message: String)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#properties","title":"Properties","text":"Name Summary clientError [jvm]val clientError: Boolean code [jvm]val code: String idempotenceKey [jvm]val idempotenceKey: String message [jvm]val message: String"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/-enqueue-error-result/","title":"EnqueueErrorResult - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/EnqueueErrorResult
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/-enqueue-error-result/#enqueueerrorresult","title":"EnqueueErrorResult","text":"[jvm]\\ constructor(idempotenceKey: String, clientError: Boolean, code: String, message: String)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/-enqueue-error-result/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key for the failed enqueued job clientError Indicates whether the error is due to a clientside error code Error code returned by the JobQueue service message Error message returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/client-error/","title":"clientError - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/clientError
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/client-error/#clienterror","title":"clientError","text":"[jvm]\\ val clientError: Boolean
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/client-error/#parameters","title":"Parameters","text":"jvm
clientError Indicates whether the error is due to a clientside error"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/code/","title":"code - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/code
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/code/#code","title":"code","text":"[jvm]\\ val code: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/code/#parameters","title":"Parameters","text":"jvm
code Error code returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/idempotence-key/","title":"idempotenceKey - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/idempotenceKey
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/idempotence-key/#idempotencekey","title":"idempotenceKey","text":"[jvm]\\ val idempotenceKey: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/idempotence-key/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key for the failed enqueued job"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/message/","title":"message - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/message
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/message/#message","title":"message","text":"[jvm]\\ val message: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/message/#parameters","title":"Parameters","text":"jvm
message Error message returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/","title":"JobRequest - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#jobrequest","title":"JobRequest","text":"data class JobRequest@JvmOverloadsconstructor(val body: String, val idempotenceKey: String = UUID.randomUUID().toString(), val deliveryDelay: Duration? = null, val attributes: Map<String, String> = mapOf())
Data class containing the necessary information to be enqueued in a batch enqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#parameters","title":"Parameters","text":"jvm
body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body. idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set. deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m). attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#constructors","title":"Constructors","text":"JobRequest [jvm]@JvmOverloadsconstructor(body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#properties","title":"Properties","text":"Name Summary attributes [jvm]val attributes: Map<String, String> body [jvm]val body: String deliveryDelay [jvm]val deliveryDelay: Duration? = null idempotenceKey [jvm]val idempotenceKey: String"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/-job-request/","title":"JobRequest - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/JobRequest
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/-job-request/#jobrequest","title":"JobRequest","text":"[jvm]\\
@JvmOverloads
constructor(body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/-job-request/#parameters","title":"Parameters","text":"jvm
body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body. idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set. deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m). attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/attributes/","title":"attributes - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/attributes
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/attributes/#attributes","title":"attributes","text":"[jvm]\\ val attributes: Map<String, String>
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/attributes/#parameters","title":"Parameters","text":"jvm
attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/body/","title":"body - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/body
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/body/#body","title":"body","text":"[jvm]\\ val body: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/body/#parameters","title":"Parameters","text":"jvm
body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/delivery-delay/","title":"deliveryDelay - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/deliveryDelay
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/delivery-delay/#deliverydelay","title":"deliveryDelay","text":"[jvm]\\ val deliveryDelay: Duration? = null
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/delivery-delay/#parameters","title":"Parameters","text":"jvm
deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m)."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/idempotence-key/","title":"idempotenceKey - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/idempotenceKey
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/idempotence-key/#idempotencekey","title":"idempotenceKey","text":"[jvm]\\ val idempotenceKey: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/idempotence-key/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/","title":"QueueName - Misk","text":"//misk-jobqueue/misk.jobqueue/QueueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/#queuename","title":"QueueName","text":"[jvm]\\ data class QueueName(val value: String)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/#constructors","title":"Constructors","text":"QueueName [jvm]constructor(value: String)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/-queue-name/","title":"QueueName - Misk","text":"//misk-jobqueue/misk.jobqueue/QueueName/QueueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/-queue-name/#queuename","title":"QueueName","text":"[jvm]\\ constructor(value: String)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/value/","title":"value - Misk","text":"//misk-jobqueue/misk.jobqueue/QueueName/value
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-jooq/","title":"misk-jooq - Misk","text":"//misk-jooq
"},{"location":"0.x/misk-jooq/#misk-jooq","title":"misk-jooq","text":""},{"location":"0.x/misk-jooq/#packages","title":"Packages","text":"Name misk.jooq misk.jooq.listeners misk.jooq.testgen misk.jooq.testgen.keys misk.jooq.testgen.tables misk.jooq.testgen.tables.records misk.jooq.testgen.tables.references"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/#types","title":"Types","text":"Name Summary IsolationLevelAwareConnectionProvider [jvm]class IsolationLevelAwareConnectionProvider(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions) : ConnectionProvider JooqHealthCheck [jvm]class JooqHealthCheck(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock) : HealthCheck JooqModule [jvm]class JooqModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {}) : KAbstractModule JooqSession [jvm]class JooqSession(val ctx: DSLContext) : Session JooqTransacter [jvm]class JooqTransacter@JvmOverloadsconstructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {}) TransactionIsolationLevel [jvm]enum TransactionIsolationLevel : Enum<TransactionIsolationLevel>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/#functions","title":"Functions","text":"Name Summary fetchOneOrNull [jvm]fun <RECORD : Record?> ResultQuery<RECORD>.fetchOneOrNull(): RECORD? getOrThrow [jvm]fun <ANY> ANY?.getOrThrow(): ANY ifNotNull [jvm]inline fun <ANY> ANY?.ifNotNull(condition: (any: ANY) -> Condition): Condition toInstant [jvm]fun LocalDateTime.toInstant(): Instant toLocalDateTime [jvm]fun Instant.toLocalDateTime(): LocalDateTime"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/fetch-one-or-null/","title":"fetchOneOrNull - Misk","text":"//misk-jooq/misk.jooq/fetchOneOrNull
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/fetch-one-or-null/#fetchoneornull","title":"fetchOneOrNull","text":"[jvm]\\ fun <RECORD : Record?> ResultQuery<RECORD>.fetchOneOrNull(): RECORD?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/get-or-throw/","title":"getOrThrow - Misk","text":"//misk-jooq/misk.jooq/getOrThrow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/get-or-throw/#getorthrow","title":"getOrThrow","text":"[jvm]\\ fun <ANY> ANY?.getOrThrow(): ANY
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/if-not-null/","title":"ifNotNull - Misk","text":"//misk-jooq/misk.jooq/ifNotNull
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/if-not-null/#ifnotnull","title":"ifNotNull","text":"[jvm]\\ inline fun <ANY> ANY?.ifNotNull(condition: (any: ANY) -> Condition): Condition
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-instant/","title":"toInstant - Misk","text":"//misk-jooq/misk.jooq/toInstant
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-instant/#toinstant","title":"toInstant","text":"[jvm]\\ fun LocalDateTime.toInstant(): Instant
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-local-date-time/","title":"toLocalDateTime - Misk","text":"//misk-jooq/misk.jooq/toLocalDateTime
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-local-date-time/#tolocaldatetime","title":"toLocalDateTime","text":"[jvm]\\ fun Instant.toLocalDateTime(): LocalDateTime
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/","title":"IsolationLevelAwareConnectionProvider - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/#isolationlevelawareconnectionprovider","title":"IsolationLevelAwareConnectionProvider","text":"[jvm]\\ class IsolationLevelAwareConnectionProvider(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions) : ConnectionProvider
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/#constructors","title":"Constructors","text":"IsolationLevelAwareConnectionProvider [jvm]constructor(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): Connection release [jvm]open override fun release(connection: Connection)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/-isolation-level-aware-connection-provider/","title":"IsolationLevelAwareConnectionProvider - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider/IsolationLevelAwareConnectionProvider
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/-isolation-level-aware-connection-provider/#isolationlevelawareconnectionprovider","title":"IsolationLevelAwareConnectionProvider","text":"[jvm]\\ constructor(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/acquire/","title":"acquire - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider/acquire
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Connection
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/release/","title":"release - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider/release
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/release/#release","title":"release","text":"[jvm]\\ open override fun release(connection: Connection)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/","title":"JooqHealthCheck - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#jooqhealthcheck","title":"JooqHealthCheck","text":"[jvm]\\ class JooqHealthCheck(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock) : HealthCheck
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#constructors","title":"Constructors","text":"JooqHealthCheck [jvm]constructor(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#functions","title":"Functions","text":"Name Summary status [jvm]open override fun status(): HealthStatus"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-jooq-health-check/","title":"JooqHealthCheck - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/JooqHealthCheck
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-jooq-health-check/#jooqhealthcheck","title":"JooqHealthCheck","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/status/","title":"status - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/status
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/status/#status","title":"status","text":"[jvm]\\ open override fun status(): HealthStatus
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/#properties","title":"Properties","text":"Name Summary CLOCK_SKEW_UNHEALTHY_THRESHOLD [jvm]val CLOCK_SKEW_UNHEALTHY_THRESHOLD: Duration CLOCK_SKEW_WARN_THRESHOLD [jvm]val CLOCK_SKEW_WARN_THRESHOLD: Duration log [jvm]val log: KLogger"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-u-n-h-e-a-l-t-h-y_-t-h-r-e-s-h-o-l-d/","title":"CLOCK_SKEW_UNHEALTHY_THRESHOLD - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion/CLOCK_SKEW_UNHEALTHY_THRESHOLD
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-u-n-h-e-a-l-t-h-y_-t-h-r-e-s-h-o-l-d/#clock_skew_unhealthy_threshold","title":"CLOCK_SKEW_UNHEALTHY_THRESHOLD","text":"[jvm]\\ val CLOCK_SKEW_UNHEALTHY_THRESHOLD: Duration
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-w-a-r-n_-t-h-r-e-s-h-o-l-d/","title":"CLOCK_SKEW_WARN_THRESHOLD - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion/CLOCK_SKEW_WARN_THRESHOLD
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-w-a-r-n_-t-h-r-e-s-h-o-l-d/#clock_skew_warn_threshold","title":"CLOCK_SKEW_WARN_THRESHOLD","text":"[jvm]\\ val CLOCK_SKEW_WARN_THRESHOLD: Duration
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/log/","title":"log - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion/log
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/","title":"JooqModule - Misk","text":"//misk-jooq/misk.jooq/JooqModule
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/#jooqmodule","title":"JooqModule","text":"[jvm]\\ class JooqModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {}) : KAbstractModule
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/#constructors","title":"Constructors","text":"JooqModule [jvm]@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {})"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/-jooq-module/","title":"JooqModule - Misk","text":"//misk-jooq/misk.jooq/JooqModule/JooqModule
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/-jooq-module/#jooqmodule","title":"JooqModule","text":"[jvm]\\
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {})
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/","title":"JooqSession - Misk","text":"//misk-jooq/misk.jooq/JooqSession
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#jooqsession","title":"JooqSession","text":"[jvm]\\ class JooqSession(val ctx: DSLContext) : Session
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#constructors","title":"Constructors","text":"JooqSession [jvm]constructor(ctx: DSLContext)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#types","title":"Types","text":"Name Summary HookType [jvm]enum HookType : Enum<JooqSession.HookType>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#properties","title":"Properties","text":"Name Summary ctx [jvm]val ctx: DSLContext"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#functions","title":"Functions","text":"Name Summary add [jvm]fun ConcurrentMap<JooqSession.HookType, List<() -> Unit>>.add(hookType: JooqSession.HookType, work: () -> Unit) component1 [jvm]operator fun component1(): DSLContextAllows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (ctx) -> \u2026 } executePostCommitHooks [jvm]fun executePostCommitHooks() executePreCommitHooks [jvm]fun executePreCommitHooks() executeSessionCloseHooks [jvm]fun executeSessionCloseHooks() onPostCommit [jvm]open override fun onPostCommit(work: () -> Unit) onPreCommit [jvm]open override fun onPreCommit(work: () -> Unit) onSessionClose [jvm]open override fun onSessionClose(work: () -> Unit) useConnection [jvm]open override fun <T> useConnection(work: (Connection) -> T): T"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-jooq-session/","title":"JooqSession - Misk","text":"//misk-jooq/misk.jooq/JooqSession/JooqSession
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-jooq-session/#jooqsession","title":"JooqSession","text":"[jvm]\\ constructor(ctx: DSLContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/add/","title":"add - Misk","text":"//misk-jooq/misk.jooq/JooqSession/add
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/add/#add","title":"add","text":"[jvm]\\ fun ConcurrentMap<JooqSession.HookType, List<() -> Unit>>.add(hookType: JooqSession.HookType, work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/component1/","title":"component1 - Misk","text":"//misk-jooq/misk.jooq/JooqSession/component1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/component1/#component1","title":"component1","text":"[jvm]\\ operator fun component1(): DSLContext
Allows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (ctx) -> \u2026 }
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/ctx/","title":"ctx - Misk","text":"//misk-jooq/misk.jooq/JooqSession/ctx
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/ctx/#ctx","title":"ctx","text":"[jvm]\\ val ctx: DSLContext
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-post-commit-hooks/","title":"executePostCommitHooks - Misk","text":"//misk-jooq/misk.jooq/JooqSession/executePostCommitHooks
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-post-commit-hooks/#executepostcommithooks","title":"executePostCommitHooks","text":"[jvm]\\ fun executePostCommitHooks()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-pre-commit-hooks/","title":"executePreCommitHooks - Misk","text":"//misk-jooq/misk.jooq/JooqSession/executePreCommitHooks
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-pre-commit-hooks/#executeprecommithooks","title":"executePreCommitHooks","text":"[jvm]\\ fun executePreCommitHooks()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-session-close-hooks/","title":"executeSessionCloseHooks - Misk","text":"//misk-jooq/misk.jooq/JooqSession/executeSessionCloseHooks
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-session-close-hooks/#executesessionclosehooks","title":"executeSessionCloseHooks","text":"[jvm]\\ fun executeSessionCloseHooks()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-post-commit/","title":"onPostCommit - Misk","text":"//misk-jooq/misk.jooq/JooqSession/onPostCommit
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-post-commit/#onpostcommit","title":"onPostCommit","text":"[jvm]\\ open override fun onPostCommit(work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-pre-commit/","title":"onPreCommit - Misk","text":"//misk-jooq/misk.jooq/JooqSession/onPreCommit
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-pre-commit/#onprecommit","title":"onPreCommit","text":"[jvm]\\ open override fun onPreCommit(work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-session-close/","title":"onSessionClose - Misk","text":"//misk-jooq/misk.jooq/JooqSession/onSessionClose
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-session-close/#onsessionclose","title":"onSessionClose","text":"[jvm]\\ open override fun onSessionClose(work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/use-connection/","title":"useConnection - Misk","text":"//misk-jooq/misk.jooq/JooqSession/useConnection
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/use-connection/#useconnection","title":"useConnection","text":"[jvm]\\ open override fun <T> useConnection(work: (Connection) -> T): T
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/","title":"HookType - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#hooktype","title":"HookType","text":"[jvm]\\ enum HookType : Enum<JooqSession.HookType>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#entries","title":"Entries","text":"PRE [jvm]PRE POST [jvm]POST SESSION_CLOSE [jvm]SESSION_CLOSE"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<JooqSession.HookType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): JooqSession.HookTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<JooqSession.HookType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/entries/","title":"entries - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/entries
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<JooqSession.HookType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/value-of/","title":"valueOf - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/valueOf
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): JooqSession.HookType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/values/","title":"values - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/values
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<JooqSession.HookType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-o-s-t/","title":"POST - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/POST
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-o-s-t/#post","title":"POST","text":"[jvm]\\ POST
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-o-s-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-r-e/","title":"PRE - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/PRE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-r-e/#pre","title":"PRE","text":"[jvm]\\ PRE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/","title":"SESSION_CLOSE - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/SESSION_CLOSE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#session_close","title":"SESSION_CLOSE","text":"[jvm]\\ SESSION_CLOSE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/","title":"JooqTransacter - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#jooqtransacter","title":"JooqTransacter","text":"[jvm]\\ class JooqTransacter@JvmOverloadsconstructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {})
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#constructors","title":"Constructors","text":"JooqTransacter [jvm]@JvmOverloadsconstructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {})"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion TransacterOptions [jvm]data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val maxRetryDelayMillis: Long = 500, val isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#functions","title":"Functions","text":"Name Summary transaction [jvm]@JvmOverloadsfun <RETURN_TYPE> transaction(options: JooqTransacter.TransacterOptions = TransacterOptions(), callback: (jooqSession: JooqSession) -> RETURN_TYPE): RETURN_TYPE"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-jooq-transacter/","title":"JooqTransacter - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/JooqTransacter
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-jooq-transacter/#jooqtransacter","title":"JooqTransacter","text":"[jvm]\\
@JvmOverloads
constructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {})
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/transaction/","title":"transaction - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/transaction
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\
@JvmOverloads
fun <RETURN_TYPE> transaction(options: JooqTransacter.TransacterOptions = TransacterOptions(), callback: (jooqSession: JooqSession) -> RETURN_TYPE): RETURN_TYPE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/#properties","title":"Properties","text":"Name Summary noRetriesOptions [jvm]val noRetriesOptions: JooqTransacter.TransacterOptions"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/no-retries-options/","title":"noRetriesOptions - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/Companion/noRetriesOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/no-retries-options/#noretriesoptions","title":"noRetriesOptions","text":"[jvm]\\ val noRetriesOptions: JooqTransacter.TransacterOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\ data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val maxRetryDelayMillis: Long = 500, val isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/#constructors","title":"Constructors","text":"TransacterOptions [jvm]@JvmOverloadsconstructor(maxAttempts: Int = 3, maxRetryDelayMillis: Long = 500, isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/#properties","title":"Properties","text":"Name Summary isolationLevel [jvm]val isolationLevel: TransactionIsolationLevel maxAttempts [jvm]val maxAttempts: Int = 3 maxRetryDelayMillis [jvm]val maxRetryDelayMillis: Long = 500"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/TransacterOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\
@JvmOverloads
constructor(maxAttempts: Int = 3, maxRetryDelayMillis: Long = 500, isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/isolation-level/","title":"isolationLevel - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/isolationLevel
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/isolation-level/#isolationlevel","title":"isolationLevel","text":"[jvm]\\ val isolationLevel: TransactionIsolationLevel
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-attempts/","title":"maxAttempts - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/maxAttempts
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-attempts/#maxattempts","title":"maxAttempts","text":"[jvm]\\ val maxAttempts: Int = 3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-retry-delay-millis/","title":"maxRetryDelayMillis - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/maxRetryDelayMillis
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-retry-delay-millis/#maxretrydelaymillis","title":"maxRetryDelayMillis","text":"[jvm]\\ val maxRetryDelayMillis: Long = 500
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/","title":"TransactionIsolationLevel - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#transactionisolationlevel","title":"TransactionIsolationLevel","text":"[jvm]\\ enum TransactionIsolationLevel : Enum<TransactionIsolationLevel>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#entries","title":"Entries","text":"READ_UNCOMMITTED [jvm]READ_UNCOMMITTED READ_COMMITTED [jvm]READ_COMMITTED REPEATABLE_READ [jvm]REPEATABLE_READ SERIALIZABLE [jvm]SERIALIZABLE"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<TransactionIsolationLevel>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): TransactionIsolationLevelReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<TransactionIsolationLevel>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/entries/","title":"entries - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/entries
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<TransactionIsolationLevel>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value-of/","title":"valueOf - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/valueOf
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): TransactionIsolationLevel
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value/","title":"value - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/value
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value/#value","title":"value","text":"[jvm]\\ val value: Int
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/values/","title":"values - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/values
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<TransactionIsolationLevel>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-c-o-m-m-i-t-t-e-d/","title":"READ_COMMITTED - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/READ_COMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-c-o-m-m-i-t-t-e-d/#read_committed","title":"READ_COMMITTED","text":"[jvm]\\ READ_COMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-c-o-m-m-i-t-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-u-n-c-o-m-m-i-t-t-e-d/","title":"READ_UNCOMMITTED - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/READ_UNCOMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-u-n-c-o-m-m-i-t-t-e-d/#read_uncommitted","title":"READ_UNCOMMITTED","text":"[jvm]\\ READ_UNCOMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-u-n-c-o-m-m-i-t-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-p-e-a-t-a-b-l-e_-r-e-a-d/","title":"REPEATABLE_READ - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/REPEATABLE_READ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-p-e-a-t-a-b-l-e_-r-e-a-d/#repeatable_read","title":"REPEATABLE_READ","text":"[jvm]\\ REPEATABLE_READ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-p-e-a-t-a-b-l-e_-r-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-s-e-r-i-a-l-i-z-a-b-l-e/","title":"SERIALIZABLE - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/SERIALIZABLE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-s-e-r-i-a-l-i-z-a-b-l-e/#serializable","title":"SERIALIZABLE","text":"[jvm]\\ SERIALIZABLE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-s-e-r-i-a-l-i-z-a-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.listeners
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/#types","title":"Types","text":"Name Summary AvoidUsingSelectStarException [jvm]class AvoidUsingSelectStarException(message: String) : RuntimeException AvoidUsingSelectStarListener [jvm]class AvoidUsingSelectStarListener : DefaultExecuteListener JooqSQLLogger [jvm]class JooqSQLLogger : DefaultExecuteListener JooqTimestampRecordListener [jvm]class JooqTimestampRecordListener(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String) : DefaultRecordListenerA Record Listener that will automatically set the current timestamp for the createdAtColumnName during insertions. And the current timestamp to the updatedAtColumnName while updating a row JooqTimestampRecordListenerOptions [jvm]data class JooqTimestampRecordListenerOptions@JvmOverloadsconstructor(val install: Boolean, val createdAtColumnName: String = \"\", val updatedAtColumnName: String = \"\")Use this class to configure the installation of the misk.jooq.listeners.JooqTimestampRecordListener You can use both or configure just one of the createdAtColumnName to be set to the current timestamp when inserting or updating it. If you leave the one you don\u2019t want set as an empty string the JooqTimestampRecordListener will ignore it."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/","title":"AvoidUsingSelectStarException - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarException
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#avoidusingselectstarexception","title":"AvoidUsingSelectStarException","text":"[jvm]\\ class AvoidUsingSelectStarException(message: String) : RuntimeException
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#constructors","title":"Constructors","text":"AvoidUsingSelectStarException [jvm]constructor(message: String)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/-avoid-using-select-star-exception/","title":"AvoidUsingSelectStarException - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarException/AvoidUsingSelectStarException
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/-avoid-using-select-star-exception/#avoidusingselectstarexception","title":"AvoidUsingSelectStarException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/","title":"AvoidUsingSelectStarListener - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#avoidusingselectstarlistener","title":"AvoidUsingSelectStarListener","text":"[jvm]\\ class AvoidUsingSelectStarListener : DefaultExecuteListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#constructors","title":"Constructors","text":"AvoidUsingSelectStarListener [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#functions","title":"Functions","text":"Name Summary bindEnd [jvm]open fun bindEnd(p0: ExecuteContext) bindStart [jvm]open fun bindStart(p0: ExecuteContext) end [jvm]open fun end(p0: ExecuteContext) exception [jvm]open fun exception(p0: ExecuteContext) executeEnd [jvm]open fun executeEnd(p0: ExecuteContext) executeStart [jvm]open fun executeStart(p0: ExecuteContext) fetchEnd [jvm]open fun fetchEnd(p0: ExecuteContext) fetchStart [jvm]open fun fetchStart(p0: ExecuteContext) outEnd [jvm]open fun outEnd(p0: ExecuteContext) outStart [jvm]open fun outStart(p0: ExecuteContext) prepareEnd [jvm]open fun prepareEnd(p0: ExecuteContext) prepareStart [jvm]open fun prepareStart(p0: ExecuteContext) recordEnd [jvm]open fun recordEnd(p0: ExecuteContext) recordStart [jvm]open fun recordStart(p0: ExecuteContext) renderEnd [jvm]open override fun renderEnd(ctx: ExecuteContext?)This catches any query that has a select * from or select table.* from. We don\u2019t want to use any query that uses a select * in it, as jooq has a hard time converting the result set into a jooq table record. It captures the result set via indexes and not the column names. If you try to fetch the result set into a jooq record, jooq will expect the order in which the columns are returned in the query matches the order of in which the columns are declared in the jooq generated code. I suppose it does ResultSet.get(0), ResulSet.get(1) instead of doing ResultSet.get(<column name) renderStart [jvm]open fun renderStart(p0: ExecuteContext) resultEnd [jvm]open fun resultEnd(p0: ExecuteContext) resultStart [jvm]open fun resultStart(p0: ExecuteContext) start [jvm]open fun start(p0: ExecuteContext) warning [jvm]open fun warning(p0: ExecuteContext)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-avoid-using-select-star-listener/","title":"AvoidUsingSelectStarListener - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/AvoidUsingSelectStarListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-avoid-using-select-star-listener/#avoidusingselectstarlistener","title":"AvoidUsingSelectStarListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/render-end/","title":"renderEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/renderEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/render-end/#renderend","title":"renderEnd","text":"[jvm]\\ open override fun renderEnd(ctx: ExecuteContext?)
This catches any query that has a select * from or select table.* from. We don\u2019t want to use any query that uses a select * in it, as jooq has a hard time converting the result set into a jooq table record. It captures the result set via indexes and not the column names. If you try to fetch the result set into a jooq record, jooq will expect the order in which the columns are returned in the query matches the order of in which the columns are declared in the jooq generated code. I suppose it does ResultSet.get(0), ResulSet.get(1) instead of doing ResultSet.get(<column name)
If the databases in dev, staging and prod don\u2019t all have the same column ordering, then things start to fail.
Either way from a code maintainability point of view it is best to avoid select * from and always specify the columns you need. If you need all the columns in a table 2 ways of doing that in jooq
ctx.selectFrom(<table name>)...\nIf you are joining multiple tables and need the columns of only one table
ctx.select(<jooq gen table>.fields().toList()).from(<table>.innerJoin....)\nDO NOT DO THIS:
ctx.select(<jooq gen table>.asterisk()).from(<table>)...\nThis listener\u2019s purpose is to catch the above and prevent it from happening.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/#properties","title":"Properties","text":"Name Summary selectStarFromRegex [jvm]val selectStarFromRegex: Regex"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/select-star-from-regex/","title":"selectStarFromRegex - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/Companion/selectStarFromRegex
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/select-star-from-regex/#selectstarfromregex","title":"selectStarFromRegex","text":"[jvm]\\ val selectStarFromRegex: Regex
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/","title":"JooqSQLLogger - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#jooqsqllogger","title":"JooqSQLLogger","text":"[jvm]\\ class JooqSQLLogger : DefaultExecuteListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#constructors","title":"Constructors","text":"JooqSQLLogger [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#functions","title":"Functions","text":"Name Summary bindEnd [jvm]open fun bindEnd(p0: ExecuteContext) bindStart [jvm]open fun bindStart(p0: ExecuteContext) end [jvm]open fun end(p0: ExecuteContext) exception [jvm]open override fun exception(ctx: ExecuteContext) executeEnd [jvm]open override fun executeEnd(ctx: ExecuteContext) executeStart [jvm]open fun executeStart(p0: ExecuteContext) fetchEnd [jvm]open fun fetchEnd(p0: ExecuteContext) fetchStart [jvm]open fun fetchStart(p0: ExecuteContext) outEnd [jvm]open override fun outEnd(ctx: ExecuteContext) outStart [jvm]open fun outStart(p0: ExecuteContext) prepareEnd [jvm]open fun prepareEnd(p0: ExecuteContext) prepareStart [jvm]open fun prepareStart(p0: ExecuteContext) recordEnd [jvm]open override fun recordEnd(ctx: ExecuteContext) recordStart [jvm]open fun recordStart(p0: ExecuteContext) renderEnd [jvm]open override fun renderEnd(ctx: ExecuteContext) renderStart [jvm]open fun renderStart(p0: ExecuteContext) resultEnd [jvm]open override fun resultEnd(ctx: ExecuteContext) resultStart [jvm]open fun resultStart(p0: ExecuteContext) start [jvm]open fun start(p0: ExecuteContext) warning [jvm]open fun warning(p0: ExecuteContext)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-jooq-s-q-l-logger/","title":"JooqSQLLogger - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/JooqSQLLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-jooq-s-q-l-logger/#jooqsqllogger","title":"JooqSQLLogger","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/exception/","title":"exception - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/exception
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/exception/#exception","title":"exception","text":"[jvm]\\ open override fun exception(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/execute-end/","title":"executeEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/executeEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/execute-end/#executeend","title":"executeEnd","text":"[jvm]\\ open override fun executeEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/out-end/","title":"outEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/outEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/out-end/#outend","title":"outEnd","text":"[jvm]\\ open override fun outEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/record-end/","title":"recordEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/recordEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/record-end/#recordend","title":"recordEnd","text":"[jvm]\\ open override fun recordEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/render-end/","title":"renderEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/renderEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/render-end/#renderend","title":"renderEnd","text":"[jvm]\\ open override fun renderEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/result-end/","title":"resultEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/resultEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/result-end/#resultend","title":"resultEnd","text":"[jvm]\\ open override fun resultEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/log/","title":"log - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/Companion/log
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/","title":"JooqTimestampRecordListener - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/#jooqtimestamprecordlistener","title":"JooqTimestampRecordListener","text":"[jvm]\\ class JooqTimestampRecordListener(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String) : DefaultRecordListener
A Record Listener that will automatically set the current timestamp for the createdAtColumnName during insertions. And the current timestamp to the updatedAtColumnName while updating a row
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/#constructors","title":"Constructors","text":"JooqTimestampRecordListener [jvm]constructor(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/#functions","title":"Functions","text":"Name Summary deleteEnd [jvm]open fun deleteEnd(p0: RecordContext) deleteStart [jvm]open fun deleteStart(p0: RecordContext) exception [jvm]open fun exception(p0: RecordContext) insertEnd [jvm]open fun insertEnd(p0: RecordContext) insertStart [jvm]open override fun insertStart(ctx: RecordContext?) loadEnd [jvm]open fun loadEnd(p0: RecordContext) loadStart [jvm]open fun loadStart(p0: RecordContext) mergeEnd [jvm]open fun mergeEnd(p0: RecordContext) mergeStart [jvm]open fun mergeStart(p0: RecordContext) refreshEnd [jvm]open fun refreshEnd(p0: RecordContext) refreshStart [jvm]open fun refreshStart(p0: RecordContext) storeEnd [jvm]open fun storeEnd(p0: RecordContext) storeStart [jvm]open fun storeStart(p0: RecordContext) updateEnd [jvm]open fun updateEnd(p0: RecordContext) updateStart [jvm]open override fun updateStart(ctx: RecordContext?)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/-jooq-timestamp-record-listener/","title":"JooqTimestampRecordListener - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener/JooqTimestampRecordListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/-jooq-timestamp-record-listener/#jooqtimestamprecordlistener","title":"JooqTimestampRecordListener","text":"[jvm]\\ constructor(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/insert-start/","title":"insertStart - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener/insertStart
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/insert-start/#insertstart","title":"insertStart","text":"[jvm]\\ open override fun insertStart(ctx: RecordContext?)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/update-start/","title":"updateStart - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener/updateStart
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/update-start/#updatestart","title":"updateStart","text":"[jvm]\\ open override fun updateStart(ctx: RecordContext?)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/","title":"JooqTimestampRecordListenerOptions - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/#jooqtimestamprecordlisteneroptions","title":"JooqTimestampRecordListenerOptions","text":"[jvm]\\ data class JooqTimestampRecordListenerOptions@JvmOverloadsconstructor(val install: Boolean, val createdAtColumnName: String = \"\", val updatedAtColumnName: String = \"\")
Use this class to configure the installation of the misk.jooq.listeners.JooqTimestampRecordListener You can use both or configure just one of the createdAtColumnName to be set to the current timestamp when inserting or updating it. If you leave the one you don\u2019t want set as an empty string the JooqTimestampRecordListener will ignore it.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/#constructors","title":"Constructors","text":"JooqTimestampRecordListenerOptions [jvm]@JvmOverloadsconstructor(install: Boolean, createdAtColumnName: String = \"\", updatedAtColumnName: String = \"\")"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/#properties","title":"Properties","text":"Name Summary createdAtColumnName [jvm]val createdAtColumnName: String install [jvm]val install: Boolean updatedAtColumnName [jvm]val updatedAtColumnName: String"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/-jooq-timestamp-record-listener-options/","title":"JooqTimestampRecordListenerOptions - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/JooqTimestampRecordListenerOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/-jooq-timestamp-record-listener-options/#jooqtimestamprecordlisteneroptions","title":"JooqTimestampRecordListenerOptions","text":"[jvm]\\
@JvmOverloads
constructor(install: Boolean, createdAtColumnName: String = \"\", updatedAtColumnName: String = \"\")
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/created-at-column-name/","title":"createdAtColumnName - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/createdAtColumnName
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/created-at-column-name/#createdatcolumnname","title":"createdAtColumnName","text":"[jvm]\\ val createdAtColumnName: String
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/install/","title":"install - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/install
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/install/#install","title":"install","text":"[jvm]\\ val install: Boolean
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/updated-at-column-name/","title":"updatedAtColumnName - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/updatedAtColumnName
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/updated-at-column-name/#updatedatcolumnname","title":"updatedAtColumnName","text":"[jvm]\\ val updatedAtColumnName: String
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.testgen
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/#types","title":"Types","text":"Name Summary DefaultCatalog [jvm]open class DefaultCatalog : CatalogImplThis class is generated by jOOQ. Jooq [jvm]open class Jooq : SchemaImplThis class is generated by jOOQ."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/","title":"DefaultCatalog - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#defaultcatalog","title":"DefaultCatalog","text":"[jvm]\\ open class DefaultCatalog : CatalogImpl
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#constructors","title":"Constructors","text":"DefaultCatalog [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#properties","title":"Properties","text":"Name Summary JOOQ [jvm]val JOOQ: JooqThe schemajooq."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#functions","title":"Functions","text":"Name Summary $name [jvm]override fun $name(): Name accept [jvm]override fun accept(p0: Context<*>) clauses [jvm]override fun clauses(p0: Context<*>): Array<Clause> declaresCTE [jvm]open override fun declaresCTE(): Boolean declaresFields [jvm]open override fun declaresFields(): Boolean declaresTables [jvm]open override fun declaresTables(): Boolean declaresWindows [jvm]open override fun declaresWindows(): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean generatesCast [jvm]open override fun generatesCast(): Boolean getComment [jvm]override fun getComment(): String getCommentPart [jvm]override fun getCommentPart(): Comment getName [jvm]override fun getName(): String getQualifiedName [jvm]open override fun getQualifiedName(): Name getSchema [jvm]override fun getSchema(p0: String): Schema?override fun getSchema(p0: Name): Schema? getSchemas [jvm]open override fun getSchemas(): List<Schema> getUnqualifiedName [jvm]override fun getUnqualifiedName(): Name hashCode [jvm]open override fun hashCode(): Int rendersContent [jvm]open override fun rendersContent(p0: Context<*>): Boolean schemaStream [jvm]override fun schemaStream(): Stream<Schema> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-default-catalog/","title":"DefaultCatalog - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/DefaultCatalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-default-catalog/#defaultcatalog","title":"DefaultCatalog","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-j-o-o-q/","title":"JOOQ - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/JOOQ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-j-o-o-q/#jooq","title":"JOOQ","text":"[jvm]\\ val JOOQ: Jooq
The schema jooq.
//misk-jooq/misk.jooq.testgen/DefaultCatalog/getSchemas
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/get-schemas/#getschemas","title":"getSchemas","text":"[jvm]\\ open override fun getSchemas(): List<Schema>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT_CATALOG [jvm]val DEFAULT_CATALOG: DefaultCatalogThe reference instance ofDEFAULT_CATALOG"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/-d-e-f-a-u-l-t_-c-a-t-a-l-o-g/","title":"DEFAULT_CATALOG - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/Companion/DEFAULT_CATALOG
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/-d-e-f-a-u-l-t_-c-a-t-a-l-o-g/#default_catalog","title":"DEFAULT_CATALOG","text":"[jvm]\\ val DEFAULT_CATALOG: DefaultCatalog
The reference instance of DEFAULT_CATALOG
//misk-jooq/misk.jooq.testgen/Jooq
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#jooq","title":"Jooq","text":"[jvm]\\ open class Jooq : SchemaImpl
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#constructors","title":"Constructors","text":"Jooq [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#properties","title":"Properties","text":"Name Summary MOVIE [jvm]val MOVIE: MovieThe tablejooq.movie."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#functions","title":"Functions","text":"Name Summary $name [jvm]override fun $name(): Name accept [jvm]override fun accept(p0: Context<*>) clauses [jvm]override fun clauses(p0: Context<*>): Array<Clause> declaresCTE [jvm]open override fun declaresCTE(): Boolean declaresFields [jvm]open override fun declaresFields(): Boolean declaresTables [jvm]open override fun declaresTables(): Boolean declaresWindows [jvm]open override fun declaresWindows(): Boolean domainStream [jvm]override fun domainStream(): Stream<Domain<*>> equals [jvm]open operator override fun equals(other: Any?): Boolean foreignKeyStream [jvm]override fun foreignKeyStream(): Stream<ForeignKey<*, *>> generatesCast [jvm]open override fun generatesCast(): Boolean getCatalog [jvm]open override fun getCatalog(): Catalog getComment [jvm]override fun getComment(): String getCommentPart [jvm]override fun getCommentPart(): Comment getDomain [jvm]override fun getDomain(p0: String): Domain<>?override fun getDomain(p0: Name): Domain<>? getDomains [jvm]open override fun getDomains(): MutableList<Domain<*>> getForeignKeys [jvm]open override fun getForeignKeys(): MutableList<ForeignKey<, *>>override fun getForeignKeys(p0: String): MutableList<ForeignKey<, >>override fun getForeignKeys(p0: Name): MutableList<ForeignKey<, *>> getIndexes [jvm]open override fun getIndexes(): MutableList<Index>override fun getIndexes(p0: String): MutableList<Index>override fun getIndexes(p0: Name): MutableList<Index> getName [jvm]override fun getName(): String getPrimaryKeys [jvm]open override fun getPrimaryKeys(): MutableList<UniqueKey<>>override fun getPrimaryKeys(p0: String): MutableList<UniqueKey<>>override fun getPrimaryKeys(p0: Name): MutableList<UniqueKey<*>> getQualifiedName [jvm]open override fun getQualifiedName(): Name getSequence [jvm]override fun getSequence(p0: String): Sequence<>?override fun getSequence(p0: Name): Sequence<>? getSequences [jvm]open override fun getSequences(): MutableList<Sequence<*>> getTable [jvm]override fun getTable(p0: String): Table<>?override fun getTable(p0: Name): Table<>? getTables [jvm]open override fun getTables(): List<Table<*>> getUDT [jvm]override fun getUDT(p0: String): UDT<>?override fun getUDT(p0: Name): UDT<>? getUDTs [jvm]open override fun getUDTs(): MutableList<UDT<*>> getUniqueKeys [jvm]open override fun getUniqueKeys(): MutableList<UniqueKey<>>override fun getUniqueKeys(p0: String): MutableList<UniqueKey<>>override fun getUniqueKeys(p0: Name): MutableList<UniqueKey<*>> getUnqualifiedName [jvm]override fun getUnqualifiedName(): Name hashCode [jvm]open override fun hashCode(): Int indexStream [jvm]override fun indexStream(): Stream<Index> primaryKeyStream [jvm]override fun primaryKeyStream(): Stream<UniqueKey<*>> rendersContent [jvm]open override fun rendersContent(p0: Context<*>): Boolean sequenceStream [jvm]override fun sequenceStream(): Stream<Sequence<*>> tableStream [jvm]override fun tableStream(): Stream<Table<*>> toString [jvm]open override fun toString(): String udtStream [jvm]override fun udtStream(): Stream<UDT<*>> uniqueKeyStream [jvm]override fun uniqueKeyStream(): Stream<UniqueKey<*>>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-jooq/","title":"Jooq - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/Jooq
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-jooq/#jooq","title":"Jooq","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-m-o-v-i-e/","title":"MOVIE - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/MOVIE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-m-o-v-i-e/#movie","title":"MOVIE","text":"[jvm]\\ val MOVIE: Movie
The table jooq.movie.
//misk-jooq/misk.jooq.testgen/Jooq/getCatalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/get-catalog/#getcatalog","title":"getCatalog","text":"[jvm]\\ open override fun getCatalog(): Catalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/get-tables/","title":"getTables - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/getTables
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/get-tables/#gettables","title":"getTables","text":"[jvm]\\ open override fun getTables(): List<Table<*>>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/#properties","title":"Properties","text":"Name Summary JOOQ [jvm]val JOOQ: JooqThe reference instance ofjooq"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/-j-o-o-q/","title":"JOOQ - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/Companion/JOOQ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/-j-o-o-q/#jooq","title":"JOOQ","text":"[jvm]\\ val JOOQ: Jooq
The reference instance of jooq
//misk-jooq/misk.jooq.testgen.keys
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/#properties","title":"Properties","text":"Name Summary KEY_MOVIE_PRIMARY [jvm]val KEY_MOVIE_PRIMARY: UniqueKey<MovieRecord>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/-k-e-y_-m-o-v-i-e_-p-r-i-m-a-r-y/","title":"KEY_MOVIE_PRIMARY - Misk","text":"//misk-jooq/misk.jooq.testgen.keys/KEY_MOVIE_PRIMARY
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/-k-e-y_-m-o-v-i-e_-p-r-i-m-a-r-y/#key_movie_primary","title":"KEY_MOVIE_PRIMARY","text":"[jvm]\\ val KEY_MOVIE_PRIMARY: UniqueKey<MovieRecord>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.testgen.tables
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/#types","title":"Types","text":"Name Summary Movie [jvm]open class Movie(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?) : TableImpl<MovieRecord> This class is generated by jOOQ."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/","title":"Movie - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#movie","title":"Movie","text":"[jvm]\\ open class Movie(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?) : TableImpl<MovieRecord>
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#constructors","title":"Constructors","text":"Movie [jvm]constructor(alias: String)Create an aliasedjooq.movie table referenceconstructor(alias: Name)Create an aliased jooq.movie table referenceconstructor()Create a jooq.movie table referenceconstructor(child: Table<out Record>, key: ForeignKey<out Record, MovieRecord>)constructor(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#properties","title":"Properties","text":"Name Summary CREATED_AT [jvm]val CREATED_AT: TableField<MovieRecord, LocalDateTime?>The column jooq.movie.created_at. GENRE [jvm]val GENRE: TableField<MovieRecord, String?>The column jooq.movie.genre. ID [jvm]val ID: TableField<MovieRecord, Long?>The column jooq.movie.id. NAME [jvm]val NAME: TableField<MovieRecord, String?>The column jooq.movie.name. UPDATED_AT [jvm]val UPDATED_AT: TableField<MovieRecord, LocalDateTime?>The column jooq.movie.updated_at. VERSION [jvm]val VERSION: TableField<MovieRecord, Int?>The column jooq.movie.version."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#functions","title":"Functions","text":"Name Summary $alias [jvm]open override fun $alias(): Name? $aliased [jvm]open override fun $aliased(): Table<MovieRecord> $dataType [jvm]override fun $dataType(): DataType<MovieRecord> $name [jvm]override fun $name(): Name $schema [jvm]override fun $schema(): Schema? accept [jvm]override fun accept(p0: Context<*>) as [jvm]open override fun as(alias: String): Movieopen override fun as(alias: Name): Movieoverride fun as(p0: Field<>): SelectField<MovieRecord>open override fun as(p0: Table<>): Table<MovieRecord>override fun as(p0: String, p1: BiFunction<in Field<>, in Int, out String>): Table<MovieRecord>override fun as(p0: String, p1: Function<in Field<>, out String>): Table<MovieRecord>override fun as(p0: String, vararg p1: String): Table<MovieRecord>override fun as(p0: String, p1: MutableCollection<out String>): Table<MovieRecord>override fun as(p0: Name, p1: BiFunction<in Field<>, in Int, out Name>): Table<MovieRecord>override fun as(p0: Name, p1: Function<in Field<>, out Name>): Table<MovieRecord>override fun as(p0: Name, p1: MutableCollection<out Name>): Table<MovieRecord>override fun as(p0: Table<>, p1: BiFunction<in Field<>, in Int, out Field<>>): Table<MovieRecord>override fun as(p0: Table<>, p1: Function<in Field<>, out Field<>>): Table<MovieRecord>override fun as(p0: Table<>, vararg p1: Field<>): Table<MovieRecord>override fun as(p0: Table<>, p1: MutableCollection<out Field<>>): Table<MovieRecord>open override fun as(p0: Name, vararg p1: Name): Table<MovieRecord> asMultiset [jvm]override fun asMultiset(): Field<Result<MovieRecord>>override fun asMultiset(p0: String): Field<Result<MovieRecord>>override fun asMultiset(p0: Field<*>): Field<Result<MovieRecord>>override fun asMultiset(p0: Name): Field<Result<MovieRecord>> asTable [jvm]override fun asTable(): Table<MovieRecord>override fun asTable(p0: String): Table<MovieRecord>override fun asTable(p0: Name): Table<MovieRecord>override fun asTable(p0: Table<>): Table<MovieRecord>override fun asTable(p0: String, p1: BiFunction<in Field<>, in Int, out String>): Table<MovieRecord>override fun asTable(p0: String, p1: Function<in Field<>, out String>): Table<MovieRecord>override fun asTable(p0: String, vararg p1: String): Table<MovieRecord>override fun asTable(p0: String, p1: MutableCollection<out String>): Table<MovieRecord>override fun asTable(p0: Name, vararg p1: Name): Table<MovieRecord>override fun asTable(p0: Name, p1: MutableCollection<out Name>): Table<MovieRecord>override fun asTable(p0: Table<>, vararg p1: Field<>): Table<MovieRecord>override fun asTable(p0: Table<>, p1: MutableCollection<out Field<*>>): Table<MovieRecord> asterisk [jvm]override fun asterisk(): QualifiedAsterisk clauses [jvm]override fun clauses(p0: Context<*>): Array<Clause> convert [jvm]override fun <U : Any> convert(p0: Binding<MovieRecord, U>): SelectField<U>override fun <U : Any> convert(p0: Converter<MovieRecord, U>): SelectField<U>override fun <U : Any> convert(p0: Class<U>, p1: Function<in MovieRecord, out U>, p2: Function<in U, out MovieRecord>): SelectField<U> convertFrom [jvm]override fun <U : Any> convertFrom(p0: Function<in MovieRecord, out U>): SelectField<U>override fun <U : Any> convertFrom(p0: Class<U>, p1: Function<in MovieRecord, out U>): SelectField<U> convertTo [jvm]override fun <U : Any> convertTo(p0: Function<in U, out MovieRecord>): SelectField<U>override fun <U : Any> convertTo(p0: Class<U>, p1: Function<in U, out MovieRecord>): SelectField<U> crossApply [jvm]override fun crossApply(p0: String): Table<Record>override fun crossApply(p0: Name): Table<Record>override fun crossApply(p0: SQL): Table<Record>override fun crossApply(p0: TableLike<*>): Table<Record>override fun crossApply(p0: String, vararg p1: Any): Table<Record>override fun crossApply(p0: String, vararg p1: QueryPart): Table<Record> crossJoin [jvm]override fun crossJoin(p0: String): Table<Record>override fun crossJoin(p0: Name): Table<Record>override fun crossJoin(p0: SQL): Table<Record>override fun crossJoin(p0: TableLike<*>): Table<Record>override fun crossJoin(p0: String, vararg p1: Any): Table<Record>override fun crossJoin(p0: String, vararg p1: QueryPart): Table<Record> dataType [jvm]@Nullableabstract fun dataType(p0: Int): @NullableDataType<>?@Nullableabstract fun dataType(p0: String): @NullableDataType<>?@Nullableabstract fun dataType(p0: Name): @NullableDataType<*>? dataTypes [jvm]@NotNullabstract fun dataTypes(): @NotNullArray<@NotNullDataType<*>> declaresCTE [jvm]open override fun declaresCTE(): Boolean declaresFields [jvm]open override fun declaresFields(): Boolean declaresTables [jvm]open override fun declaresTables(): Boolean declaresWindows [jvm]open override fun declaresWindows(): Boolean divideBy [jvm]override fun divideBy(p0: Table<*>): DivideByOnStep eq [jvm]override fun eq(p0: Table<MovieRecord>): Condition equal [jvm]override fun equal(p0: Table<MovieRecord>): Condition equals [jvm]open operator override fun equals(other: Any?): Boolean field [jvm]@Nullableabstract fun field(p0: Int): @NullableField<>?@Nullableabstract fun <T : Any> field(p0: Field<T>): @NullableField<T>?@Nullableabstract fun <T : Any> field(p0: Int, p1: Class<T>): @NullableField<T>?@Nullableabstract fun <T : Any> field(p0: Int, p1: DataType<T>): @NullableField<T>?open override fun field(p0: String): Field<>?open override fun field(p0: Name): Field<*>?open override fun <T : Any> field(p0: String, p1: Class<T>): Field<T>?open override fun <T : Any> field(p0: String, p1: DataType<T>): Field<T>?open override fun <T : Any> field(p0: Name, p1: Class<T>): Field<T>?open override fun <T : Any> field(p0: Name, p1: DataType<T>): Field<T>? fields [jvm]@Nullableabstract fun fields(vararg p0: String): @NotNullArray<@NullableField<>?>@Nullableabstract fun fields(vararg p0: Field<>): @NotNullArray<@NullableField<>?>@Nullableabstract fun fields(vararg p0: Name): @NotNullArray<@NullableField<>?>@Nullableabstract fun fields(vararg p0: Int): @NotNullArray<@NullableField<>?>override fun fields(): Array<Field<>> fieldsRow [jvm]open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> fieldStream [jvm]@NotNullabstract fun fieldStream(): @NotNullStream<Field<*>> forceIndex [jvm]override fun forceIndex(vararg p0: String): Table<MovieRecord> forceIndexForGroupBy [jvm]override fun forceIndexForGroupBy(vararg p0: String): Table<MovieRecord> forceIndexForJoin [jvm]override fun forceIndexForJoin(vararg p0: String): Table<MovieRecord> forceIndexForOrderBy [jvm]override fun forceIndexForOrderBy(vararg p0: String): Table<MovieRecord> from [jvm]override fun from(p0: Record): MovieRecord fullJoin [jvm]override fun fullJoin(p0: String): TablePartitionByStep<Record>override fun fullJoin(p0: Name): TablePartitionByStep<Record>override fun fullJoin(p0: SQL): TablePartitionByStep<Record>override fun fullJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun fullJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun fullJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> fullOuterJoin [jvm]override fun fullOuterJoin(p0: String): TablePartitionByStep<Record>override fun fullOuterJoin(p0: Name): TablePartitionByStep<Record>override fun fullOuterJoin(p0: SQL): TablePartitionByStep<Record>override fun fullOuterJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun fullOuterJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun fullOuterJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> generatesCast [jvm]open override fun generatesCast(): Boolean getBinding [jvm]override fun getBinding(): Binding<*, MovieRecord> getCatalog [jvm]override fun getCatalog(): Catalog? getChecks [jvm]open override fun getChecks(): MutableList<Check<MovieRecord>> getComment [jvm]override fun getComment(): String getCommentPart [jvm]override fun getCommentPart(): Comment getConverter [jvm]override fun getConverter(): ContextConverter<*, MovieRecord> getDataType [jvm]override fun getDataType(): DataType<MovieRecord>override fun getDataType(p0: Configuration): DataType<MovieRecord> getIdentity [jvm]open override fun getIdentity(): Identity<MovieRecord, Long?> getIndexes [jvm]open override fun getIndexes(): MutableList<Index> getKeys [jvm]open override fun getKeys(): List<UniqueKey<MovieRecord>> getName [jvm]override fun getName(): String getOptions [jvm]override fun getOptions(): TableOptions getPackage [jvm]override fun getPackage(): Package? getPrimaryKey [jvm]open override fun getPrimaryKey(): UniqueKey<MovieRecord> getQualifiedName [jvm]open override fun getQualifiedName(): Name getRecordTimestamp [jvm]open override fun getRecordTimestamp(): TableField<MovieRecord, *>? getRecordType [jvm]open override fun getRecordType(): Class<MovieRecord>The class holding records for this type getRecordVersion [jvm]open override fun getRecordVersion(): TableField<MovieRecord, Int?> getReferences [jvm]open override fun getReferences(): MutableList<ForeignKey<MovieRecord, *>> getReferencesFrom [jvm]override fun <O : Record> getReferencesFrom(p0: Table<O>): MutableList<ForeignKey<O, MovieRecord>> getReferencesTo [jvm]override fun <O : Record> getReferencesTo(p0: Table<O>): MutableList<ForeignKey<MovieRecord, O>> getSchema [jvm]open override fun getSchema(): Schema getTableType [jvm]override fun getTableType(): TableOptions.TableType getType [jvm]override fun getType(): Class<MovieRecord> getUniqueKeys [jvm]open override fun getUniqueKeys(): MutableList<UniqueKey<MovieRecord>> getUnqualifiedName [jvm]override fun getUnqualifiedName(): Name hashCode [jvm]open override fun hashCode(): Int ignoreIndex [jvm]override fun ignoreIndex(vararg p0: String): Table<MovieRecord> ignoreIndexForGroupBy [jvm]override fun ignoreIndexForGroupBy(vararg p0: String): Table<MovieRecord> ignoreIndexForJoin [jvm]override fun ignoreIndexForJoin(vararg p0: String): Table<MovieRecord> ignoreIndexForOrderBy [jvm]override fun ignoreIndexForOrderBy(vararg p0: String): Table<MovieRecord> indexOf [jvm]abstract fun indexOf(p0: String): Intabstract fun indexOf(p0: Field<*>): Intabstract fun indexOf(p0: Name): Int innerJoin [jvm]override fun innerJoin(p0: String): TableOnStep<Record>override fun innerJoin(p0: Name): TableOnStep<Record>override fun innerJoin(p0: SQL): TableOnStep<Record>override fun innerJoin(p0: TableLike<*>): TableOnStep<Record>override fun innerJoin(p0: String, vararg p1: Any): TableOnStep<Record>override fun innerJoin(p0: String, vararg p1: QueryPart): TableOnStep<Record> isSimple [jvm]@Internaloverride fun isSimple(p0: Context<*>): Boolean join [jvm]override fun join(p0: String): TableOnStep<Record>override fun join(p0: Name): TableOnStep<Record>override fun join(p0: SQL): TableOnStep<Record>override fun join(p0: TableLike<>): TableOnStep<Record>override fun join(p0: String, vararg p1: Any): TableOnStep<Record>override fun join(p0: String, vararg p1: QueryPart): TableOnStep<Record>override fun join(p0: TableLike<>, p1: JoinType): JoinTable<*> leftAntiJoin [jvm]override fun leftAntiJoin(p0: TableLike<*>): TableOnStep<MovieRecord> leftJoin [jvm]override fun leftJoin(p0: String): TablePartitionByStep<Record>override fun leftJoin(p0: Name): TablePartitionByStep<Record>override fun leftJoin(p0: SQL): TablePartitionByStep<Record>override fun leftJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun leftJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun leftJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> leftOuterJoin [jvm]override fun leftOuterJoin(p0: String): TablePartitionByStep<Record>override fun leftOuterJoin(p0: Name): TablePartitionByStep<Record>override fun leftOuterJoin(p0: SQL): TablePartitionByStep<Record>override fun leftOuterJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun leftOuterJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun leftOuterJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> leftSemiJoin [jvm]override fun leftSemiJoin(p0: TableLike<*>): TableOnStep<MovieRecord> naturalFullOuterJoin [jvm]override fun naturalFullOuterJoin(p0: String): Table<Record>override fun naturalFullOuterJoin(p0: Name): Table<Record>override fun naturalFullOuterJoin(p0: SQL): Table<Record>override fun naturalFullOuterJoin(p0: TableLike<*>): Table<Record>override fun naturalFullOuterJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalFullOuterJoin(p0: String, vararg p1: QueryPart): Table<Record> naturalJoin [jvm]override fun naturalJoin(p0: String): Table<Record>override fun naturalJoin(p0: Name): Table<Record>override fun naturalJoin(p0: SQL): Table<Record>override fun naturalJoin(p0: TableLike<*>): Table<Record>override fun naturalJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalJoin(p0: String, vararg p1: QueryPart): Table<Record> naturalLeftOuterJoin [jvm]override fun naturalLeftOuterJoin(p0: String): Table<Record>override fun naturalLeftOuterJoin(p0: Name): Table<Record>override fun naturalLeftOuterJoin(p0: SQL): Table<Record>override fun naturalLeftOuterJoin(p0: TableLike<*>): Table<Record>override fun naturalLeftOuterJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalLeftOuterJoin(p0: String, vararg p1: QueryPart): Table<Record> naturalRightOuterJoin [jvm]override fun naturalRightOuterJoin(p0: String): Table<Record>override fun naturalRightOuterJoin(p0: Name): Table<Record>override fun naturalRightOuterJoin(p0: SQL): Table<Record>override fun naturalRightOuterJoin(p0: TableLike<*>): Table<Record>override fun naturalRightOuterJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalRightOuterJoin(p0: String, vararg p1: QueryPart): Table<Record> ne [jvm]override fun ne(p0: Table<MovieRecord>): Condition newRecord [jvm]override fun newRecord(): MovieRecord notEqual [jvm]override fun notEqual(p0: Table<MovieRecord>): Condition outerApply [jvm]override fun outerApply(p0: String): Table<Record>override fun outerApply(p0: Name): Table<Record>override fun outerApply(p0: SQL): Table<Record>override fun outerApply(p0: TableLike<*>): Table<Record>override fun outerApply(p0: String, vararg p1: Any): Table<Record>override fun outerApply(p0: String, vararg p1: QueryPart): Table<Record> recordType [jvm]override fun recordType(): RecordType<MovieRecord> rename [jvm]open override fun rename(name: String): Movieopen override fun rename(name: Name): MovieRename this table[jvm]open fun rename(p0: Table<*>): Table<MovieRecord> rendersContent [jvm]open override fun rendersContent(p0: Context<*>): Boolean rightJoin [jvm]override fun rightJoin(p0: String): TablePartitionByStep<Record>override fun rightJoin(p0: Name): TablePartitionByStep<Record>override fun rightJoin(p0: SQL): TablePartitionByStep<Record>override fun rightJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun rightJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun rightJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> rightOuterJoin [jvm]override fun rightOuterJoin(p0: String): TablePartitionByStep<Record>override fun rightOuterJoin(p0: Name): TablePartitionByStep<Record>override fun rightOuterJoin(p0: SQL): TablePartitionByStep<Record>override fun rightOuterJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun rightOuterJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun rightOuterJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> rowid [jvm]open override fun rowid(): Field<RowId> straightJoin [jvm]override fun straightJoin(p0: String): TableOptionalOnStep<Record>override fun straightJoin(p0: Name): TableOptionalOnStep<Record>override fun straightJoin(p0: SQL): TableOptionalOnStep<Record>override fun straightJoin(p0: TableLike<*>): TableOptionalOnStep<Record>override fun straightJoin(p0: String, vararg p1: Any): TableOptionalOnStep<Record>override fun straightJoin(p0: String, vararg p1: QueryPart): TableOptionalOnStep<Record> toString [jvm]open override fun toString(): String type [jvm]@Nullableabstract fun type(p0: Int): @NullableClass<>?@Nullableabstract fun type(p0: String): @NullableClass<>?@Nullableabstract fun type(p0: Name): @NullableClass<*>? types [jvm]@NotNullabstract fun types(): @NotNullArray<@NotNullClass<*>> useIndex [jvm]override fun useIndex(vararg p0: String): Table<MovieRecord> useIndexForGroupBy [jvm]override fun useIndexForGroupBy(vararg p0: String): Table<MovieRecord> useIndexForJoin [jvm]override fun useIndexForJoin(vararg p0: String): Table<MovieRecord> useIndexForOrderBy [jvm]override fun useIndexForOrderBy(vararg p0: String): Table<MovieRecord> where [jvm]open override fun where(vararg p0: Condition): Table<MovieRecord>open override fun where(p0: String): Table<MovieRecord>open override fun where(p0: MutableCollection<out Condition>): Table<MovieRecord>open override fun where(p0: Condition): Table<MovieRecord>open override fun where(p0: Field<Boolean>): Table<MovieRecord>open override fun where(p0: SQL): Table<MovieRecord>open override fun where(p0: String, vararg p1: Any): Table<MovieRecord>open override fun where(p0: String, vararg p1: QueryPart): Table<MovieRecord> whereExists [jvm]open override fun whereExists(p0: Select<*>): Table<MovieRecord> whereNotExists [jvm]open override fun whereNotExists(p0: Select<*>): Table<MovieRecord> withOrdinality [jvm]override fun withOrdinality(): Table<Record>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-c-r-e-a-t-e-d_-a-t/","title":"CREATED_AT - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/CREATED_AT
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-c-r-e-a-t-e-d_-a-t/#created_at","title":"CREATED_AT","text":"[jvm]\\ val CREATED_AT: TableField<MovieRecord, LocalDateTime?>
The column jooq.movie.created_at.
//misk-jooq/misk.jooq.testgen.tables/Movie/GENRE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-g-e-n-r-e/#genre","title":"GENRE","text":"[jvm]\\ val GENRE: TableField<MovieRecord, String?>
The column jooq.movie.genre.
//misk-jooq/misk.jooq.testgen.tables/Movie/ID
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-i-d/#id","title":"ID","text":"[jvm]\\ val ID: TableField<MovieRecord, Long?>
The column jooq.movie.id.
//misk-jooq/misk.jooq.testgen.tables/Movie/Movie
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-movie/#movie","title":"Movie","text":"[jvm]\\ constructor(alias: String)
constructor(alias: Name)
Create an aliased jooq.movie table reference
[jvm]\\ constructor()
Create a jooq.movie table reference
[jvm]\\ constructor(child: Table<out Record>, key: ForeignKey<out Record, MovieRecord>)
constructor(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-n-a-m-e/","title":"NAME - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/NAME
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-n-a-m-e/#name","title":"NAME","text":"[jvm]\\ val NAME: TableField<MovieRecord, String?>
The column jooq.movie.name.
//misk-jooq/misk.jooq.testgen.tables/Movie/UPDATED_AT
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-u-p-d-a-t-e-d_-a-t/#updated_at","title":"UPDATED_AT","text":"[jvm]\\ val UPDATED_AT: TableField<MovieRecord, LocalDateTime?>
The column jooq.movie.updated_at.
//misk-jooq/misk.jooq.testgen.tables/Movie/VERSION
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-v-e-r-s-i-o-n/#version","title":"VERSION","text":"[jvm]\\ val VERSION: TableField<MovieRecord, Int?>
The column jooq.movie.version.
//misk-jooq/misk.jooq.testgen.tables/Movie/as
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/as/#as","title":"as","text":"[jvm]\\ open override fun as(alias: String): Movie
open override fun as(alias: Name): Movie
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/fields-row/","title":"fieldsRow - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/fieldsRow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/fields-row/#fieldsrow","title":"fieldsRow","text":"[jvm]\\ open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-identity/","title":"getIdentity - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getIdentity
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-identity/#getidentity","title":"getIdentity","text":"[jvm]\\ open override fun getIdentity(): Identity<MovieRecord, Long?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-keys/","title":"getKeys - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getKeys
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-keys/#getkeys","title":"getKeys","text":"[jvm]\\ open override fun getKeys(): List<UniqueKey<MovieRecord>>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-primary-key/","title":"getPrimaryKey - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getPrimaryKey
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-primary-key/#getprimarykey","title":"getPrimaryKey","text":"[jvm]\\ open override fun getPrimaryKey(): UniqueKey<MovieRecord>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-type/","title":"getRecordType - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getRecordType
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-type/#getrecordtype","title":"getRecordType","text":"[jvm]\\ open override fun getRecordType(): Class<MovieRecord>
The class holding records for this type
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-version/","title":"getRecordVersion - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getRecordVersion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-version/#getrecordversion","title":"getRecordVersion","text":"[jvm]\\ open override fun getRecordVersion(): TableField<MovieRecord, Int?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-schema/","title":"getSchema - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getSchema
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-schema/#getschema","title":"getSchema","text":"[jvm]\\ open override fun getSchema(): Schema
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/rename/","title":"rename - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/rename
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/rename/#rename","title":"rename","text":"[jvm]\\ open override fun rename(name: String): Movie
open override fun rename(name: Name): Movie
Rename this table
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/#properties","title":"Properties","text":"Name Summary MOVIE [jvm]val MOVIE: MovieThe reference instance ofjooq.movie"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/-m-o-v-i-e/","title":"MOVIE - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/Companion/MOVIE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/-m-o-v-i-e/#movie","title":"MOVIE","text":"[jvm]\\ val MOVIE: Movie
The reference instance of jooq.movie
//misk-jooq/misk.jooq.testgen.tables.records
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/#types","title":"Types","text":"Name Summary MovieRecord [jvm]open class MovieRecord : UpdatableRecordImpl<MovieRecord> , Record6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> This class is generated by jOOQ."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/","title":"MovieRecord - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#movierecord","title":"MovieRecord","text":"[jvm]\\ open class MovieRecord : UpdatableRecordImpl<MovieRecord> , Record6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#constructors","title":"Constructors","text":"MovieRecord [jvm]constructor(id: Long? = null, name: String? = null, genre: String? = null, version: Int? = null, createdAt: LocalDateTime? = null, updatedAt: LocalDateTime? = null)Create a detached, initialised MovieRecordconstructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#properties","title":"Properties","text":"Name Summary createdAt [jvm]var createdAt: LocalDateTime? genre [jvm]var genre: String? id [jvm]var id: Long? name [jvm]var name: String? updatedAt [jvm]var updatedAt: LocalDateTime? version [jvm]var version: Int?"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#functions","title":"Functions","text":"Name Summary attach [jvm]override fun attach(p0: Configuration) changed [jvm]override fun changed(): Booleanoverride fun changed(p0: Boolean)override fun changed(p0: Int): Booleanoverride fun changed(p0: String): Booleanoverride fun changed(p0: Field<>): Booleanoverride fun changed(p0: Name): Booleanoverride fun changed(p0: Int, p1: Boolean)override fun changed(p0: String, p1: Boolean)override fun changed(p0: Field<>, p1: Boolean)override fun changed(p0: Name, p1: Boolean) children [jvm]override fun <O : TableRecord<O>> children(p0: ForeignKey<O, MovieRecord>): Table<O> compareTo [jvm]open operator override fun compareTo(other: Record): Int component1 [jvm]open operator override fun component1(): Long? component2 [jvm]open operator override fun component2(): String? component3 [jvm]open operator override fun component3(): String? component4 [jvm]open operator override fun component4(): Int? component5 [jvm]open operator override fun component5(): LocalDateTime? component6 [jvm]open operator override fun component6(): LocalDateTime? configuration [jvm]override fun configuration(): Configuration? copy [jvm]override fun copy(): MovieRecord dataType [jvm]override fun dataType(p0: Int): DataType<>?override fun dataType(p0: String): DataType<>?override fun dataType(p0: Name): DataType<*>? dataTypes [jvm]override fun dataTypes(): Array<DataType<*>> delete [jvm]override fun delete(): Int detach [jvm]override fun detach() equals [jvm]open operator override fun equals(other: Any?): Boolean fetchChild [jvm]override fun <O : TableRecord<O>> fetchChild(p0: ForeignKey<O, MovieRecord>): O? fetchChildren [jvm]override fun <O : TableRecord<O>> fetchChildren(p0: ForeignKey<O, MovieRecord>): Result<O> fetchParent [jvm]override fun <O : UpdatableRecord<O>> fetchParent(p0: ForeignKey<MovieRecord, O>): O? field [jvm]override fun field(p0: Int): Field<>?override fun field(p0: String): Field<>?override fun <T : Any> field(p0: Field<T>): Field<T>?override fun field(p0: Name): Field<*>?override fun <T : Any> field(p0: Int, p1: Class<T>): Field<T>?override fun <T : Any> field(p0: Int, p1: DataType<T>): Field<T>?override fun <T : Any> field(p0: String, p1: Class<T>): Field<T>?override fun <T : Any> field(p0: String, p1: DataType<T>): Field<T>?override fun <T : Any> field(p0: Name, p1: Class<T>): Field<T>?override fun <T : Any> field(p0: Name, p1: DataType<T>): Field<T>? field1 [jvm]open override fun field1(): Field<Long?> field2 [jvm]open override fun field2(): Field<String?> field3 [jvm]open override fun field3(): Field<String?> field4 [jvm]open override fun field4(): Field<Int?> field5 [jvm]open override fun field5(): Field<LocalDateTime?> field6 [jvm]open override fun field6(): Field<LocalDateTime?> fields [jvm]override fun fields(): Array<Field<>>override fun fields(vararg p0: String): Array<Field<>?>override fun fields(vararg p0: Field<>): Array<Field<>?>override fun fields(vararg p0: Name): Array<Field<>?>override fun fields(vararg p0: Int): Array<Field<>?> fieldsRow [jvm]open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> fieldStream [jvm]override fun fieldStream(): Stream<Field<*>> format [jvm]override fun format(): Stringoverride fun format(p0: OutputStream)override fun format(p0: Writer)override fun format(p0: Int): Stringoverride fun format(p0: TXTFormat): Stringoverride fun format(p0: OutputStream, p1: Int)override fun format(p0: OutputStream, p1: TXTFormat)override fun format(p0: Writer, p1: Int)override fun format(p0: Writer, p1: TXTFormat) formatChart [jvm]override fun formatChart(): Stringoverride fun formatChart(p0: OutputStream)override fun formatChart(p0: Writer)override fun formatChart(p0: ChartFormat): Stringoverride fun formatChart(p0: OutputStream, p1: ChartFormat)override fun formatChart(p0: Writer, p1: ChartFormat) formatCSV [jvm]override fun formatCSV(): Stringoverride fun formatCSV(p0: OutputStream)override fun formatCSV(p0: Writer)override fun formatCSV(p0: Boolean): Stringoverride fun formatCSV(p0: Char): Stringoverride fun formatCSV(p0: CSVFormat): Stringoverride fun formatCSV(p0: OutputStream, p1: Boolean)override fun formatCSV(p0: OutputStream, p1: Char)override fun formatCSV(p0: OutputStream, p1: CSVFormat)override fun formatCSV(p0: Writer, p1: Boolean)override fun formatCSV(p0: Writer, p1: Char)override fun formatCSV(p0: Boolean, p1: Char): Stringoverride fun formatCSV(p0: Char, p1: String): Stringoverride fun formatCSV(p0: OutputStream, p1: Boolean, p2: Char)override fun formatCSV(p0: OutputStream, p1: Char, p2: String)override fun formatCSV(p0: Writer, p1: Boolean, p2: Char)override fun formatCSV(p0: Writer, p1: Char, p2: String)override fun formatCSV(p0: Boolean, p1: Char, p2: String): Stringoverride fun formatCSV(p0: OutputStream, p1: Boolean, p2: Char, p3: String)override fun formatCSV(p0: Writer, p1: Boolean, p2: Char, p3: String)override fun formatCSV(p0: Writer, p1: CSVFormat) formatHTML [jvm]override fun formatHTML(): Stringoverride fun formatHTML(p0: OutputStream)override fun formatHTML(p0: Writer) formatInsert [jvm]override fun formatInsert(): Stringoverride fun formatInsert(p0: OutputStream)override fun formatInsert(p0: Table<>, vararg p1: Field<>): Stringoverride fun formatInsert(p0: OutputStream, p1: Table<>, vararg p2: Field<>)override fun formatInsert(p0: Writer)override fun formatInsert(p0: Writer, p1: Table<>, vararg p2: Field<>) formatJSON [jvm]override fun formatJSON(): Stringoverride fun formatJSON(p0: OutputStream)override fun formatJSON(p0: Writer)override fun formatJSON(p0: JSONFormat): Stringoverride fun formatJSON(p0: OutputStream, p1: JSONFormat)override fun formatJSON(p0: Writer, p1: JSONFormat) formatXML [jvm]override fun formatXML(): Stringoverride fun formatXML(p0: OutputStream)override fun formatXML(p0: Writer)override fun formatXML(p0: XMLFormat): Stringoverride fun formatXML(p0: OutputStream, p1: XMLFormat)override fun formatXML(p0: Writer, p1: XMLFormat) from [jvm]override fun from(p0: Any)override fun from(p0: Any, vararg p1: String)override fun from(p0: Any, vararg p1: Field<*>)override fun from(p0: Any, vararg p1: Name)override fun from(p0: Any, vararg p1: Int) fromArray [jvm]override fun fromArray(vararg p0: Any)override fun fromArray(p0: Array<Any>, vararg p1: String)override fun fromArray(p0: Array<Any>, vararg p1: Field<*>)override fun fromArray(p0: Array<Any>, vararg p1: Name)override fun fromArray(p0: Array<Any>, vararg p1: Int) fromMap [jvm]override fun fromMap(p0: MutableMap<String, >)override fun fromMap(p0: MutableMap<String, *>, vararg p1: String)override fun fromMap(p0: MutableMap<String, *>, vararg p1: Field<>)override fun fromMap(p0: MutableMap<String, *>, vararg p1: Name)override fun fromMap(p0: MutableMap<String, *>, vararg p1: Int) get [jvm]operator override fun get(p0: Int): Any?operator override fun get(p0: String): Any?operator override fun <T : Any> get(p0: Field<T>): Toperator override fun get(p0: Name): Any?operator override fun <U : Any> get(p0: Int, p1: Class<out U>): Uoperator override fun <U : Any> get(p0: Int, p1: Converter<, out U>): Uoperator override fun <T : Any> get(p0: String, p1: Class<out T>): Toperator override fun <U : Any> get(p0: String, p1: Converter<, out U>): Uoperator override fun <U : Any> get(p0: Field<>, p1: Class<out U>): Uoperator override fun <T : Any, U : Any> get(p0: Field<T>, p1: Converter<in T, out U>): Uoperator override fun <T : Any> get(p0: Name, p1: Class<out T>): Toperator override fun <U : Any> get(p0: Name, p1: Converter<, out U>): U getQualifier [jvm]override fun getQualifier(): RecordQualifier<MovieRecord> getSQLTypeName [jvm]override fun getSQLTypeName(): String getTable [jvm]override fun getTable(): Table<MovieRecord> getValue [jvm]override fun getValue(p0: Int): Anyoverride fun getValue(p0: String): Anyoverride fun <T : Any> getValue(p0: Field<T>): Toverride fun getValue(p0: Name): Anyoverride fun <T : Any> getValue(p0: Int, p1: Class<out T>): Toverride fun <U : Any> getValue(p0: Int, p1: Converter<, out U>): Uoverride fun <T : Any> getValue(p0: String, p1: Class<out T>): Toverride fun <U : Any> getValue(p0: String, p1: Converter<, out U>): Uoverride fun <T : Any> getValue(p0: Field<>, p1: Class<out T>): Toverride fun <T : Any, U : Any> getValue(p0: Field<T>, p1: Converter<in T, out U>): Uoverride fun <T : Any> getValue(p0: Name, p1: Class<out T>): Toverride fun <U : Any> getValue(p0: Name, p1: Converter<, out U>): U hashCode [jvm]open override fun hashCode(): Int indexOf [jvm]override fun indexOf(p0: String): Intoverride fun indexOf(p0: Field<*>): Intoverride fun indexOf(p0: Name): Int insert [jvm]override fun insert(): Intoverride fun insert(vararg p0: Field<>): Intoverride fun insert(p0: MutableCollection<out Field<>>): Int into [jvm]open override fun <E : Any> into(p0: E): E & Anyoverride fun <E : Any> into(p0: Class<out E>): Eoverride fun into(vararg p0: Field<*>): Recordoverride fun <T1 : Any> into(p0: Field<T1>): Record1<T1>override fun <R : Record> into(p0: Table<R>): R & Anyoverride fun <T1 : Any, T2 : Any> into(p0: Field<T1>, p1: Field<T2>): Record2<T1, T2>override fun <T1 : Any, T2 : Any, T3 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>): Record3<T1, T2, T3>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>): Record4<T1, T2, T3, T4>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>): Record5<T1, T2, T3, T4, T5>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>): Record6<T1, T2, T3, T4, T5, T6>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>): Record7<T1, T2, T3, T4, T5, T6, T7>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>): Record8<T1, T2, T3, T4, T5, T6, T7, T8>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>): Record9<T1, T2, T3, T4, T5, T6, T7, T8, T9>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>): Record10<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>): Record11<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>): Record12<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>): Record13<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>): Record14<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>): Record15<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>): Record16<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>): Record17<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>): Record18<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>): Record19<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any, T20 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>, p19: Field<T20>): Record20<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any, T20 : Any, T21 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>, p19: Field<T20>, p20: Field<T21>): Record21<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any, T20 : Any, T21 : Any, T22 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>, p19: Field<T20>, p20: Field<T21>, p21: Field<T22>): Record22<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> intoArray [jvm]override fun intoArray(): Array<Any?> intoList [jvm]override fun intoList(): MutableList<Any> intoMap [jvm]override fun intoMap(): MutableMap<String, Any> intoResultSet [jvm]override fun intoResultSet(): ResultSet intoStream [jvm]override fun intoStream(): Stream<Any> intoXML [jvm]override fun intoXML(): Documentoverride fun <H : ContentHandler> intoXML(p0: H): Hoverride fun intoXML(p0: XMLFormat): Documentoverride fun <H : ContentHandler> intoXML(p0: H, p1: XMLFormat): H key [jvm]open override fun key(): Record1<Long?> map [jvm]override fun <E : Any> map(p0: RecordMapper<Record, E>): E & Any merge [jvm]override fun merge(): Intopen override fun merge(vararg p0: Field<>): Intoverride fun merge(p0: MutableCollection<out Field<>>): Int original [jvm]override fun original(p0: Int): Any?override fun original(p0: String): Any?override fun <T : Any> original(p0: Field<T>): Toverride fun original(p0: Name): Any?override fun original(): MovieRecord parent [jvm]override fun <O : UpdatableRecord<O>> parent(p0: ForeignKey<MovieRecord, O>): Table<O> readSQL [jvm]override fun readSQL(p0: SQLInput, p1: String) refresh [jvm]override fun refresh()override fun refresh(vararg p0: Field<>)override fun refresh(p0: MutableCollection<out Field<>>) reset [jvm]override fun reset()override fun reset(p0: Int)override fun reset(p0: String)override fun reset(p0: Field<*>)override fun reset(p0: Name) set [jvm]operator override fun <T : Any> set(p0: Field<T>, p1: T)operator override fun <T : Any, U : Any> set(p0: Field<T>, p1: U, p2: Converter<out T, in U>) setValue [jvm]override fun <T : Any> setValue(p0: Field<T>, p1: T)override fun <T : Any, U : Any> setValue(p0: Field<T>, p1: U, p2: Converter<out T, in U>) size [jvm]override fun size(): Int store [jvm]override fun store(): Intoverride fun store(vararg p0: Field<>): Intoverride fun store(p0: MutableCollection<out Field<>>): Int toString [jvm]open override fun toString(): String type [jvm]override fun type(p0: Int): Class<>?override fun type(p0: String): Class<>?override fun type(p0: Name): Class<*>? types [jvm]override fun types(): Array<Class<*>> update [jvm]override fun update(): Intopen override fun update(vararg p0: Field<>): Intoverride fun update(p0: MutableCollection<out Field<>>): Int value1 [jvm]open override fun value1(): Long?open override fun value1(value: Long?): MovieRecord value2 [jvm]open override fun value2(): String?open override fun value2(value: String?): MovieRecord value3 [jvm]open override fun value3(): String?open override fun value3(value: String?): MovieRecord value4 [jvm]open override fun value4(): Int?open override fun value4(value: Int?): MovieRecord value5 [jvm]open override fun value5(): LocalDateTime?open override fun value5(value: LocalDateTime?): MovieRecord value6 [jvm]open override fun value6(): LocalDateTime?open override fun value6(value: LocalDateTime?): MovieRecord values [jvm]open override fun values(value1: Long?, value2: String?, value3: String?, value4: Int?, value5: LocalDateTime?, value6: LocalDateTime?): MovieRecord valuesRow [jvm]open override fun valuesRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> with [jvm]override fun <T : Any> with(p0: Field<T>, p1: T): MovieRecordoverride fun <T : Any, U : Any> with(p0: Field<T>, p1: U, p2: Converter<out T, in U>): MovieRecord writeSQL [jvm]override fun writeSQL(p0: SQLOutput)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/-movie-record/","title":"MovieRecord - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/-movie-record/#movierecord","title":"MovieRecord","text":"[jvm]\\ constructor(id: Long? = null, name: String? = null, genre: String? = null, version: Int? = null, createdAt: LocalDateTime? = null, updatedAt: LocalDateTime? = null)
Create a detached, initialised MovieRecord
[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component1/","title":"component1 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component1/#component1","title":"component1","text":"[jvm]\\ open operator override fun component1(): Long?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component2/","title":"component2 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component2
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component2/#component2","title":"component2","text":"[jvm]\\ open operator override fun component2(): String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component3/","title":"component3 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component3/#component3","title":"component3","text":"[jvm]\\ open operator override fun component3(): String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component4/","title":"component4 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component4
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component4/#component4","title":"component4","text":"[jvm]\\ open operator override fun component4(): Int?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component5/","title":"component5 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component5
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component5/#component5","title":"component5","text":"[jvm]\\ open operator override fun component5(): LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component6/","title":"component6 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component6
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component6/#component6","title":"component6","text":"[jvm]\\ open operator override fun component6(): LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/created-at/","title":"createdAt - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/createdAt
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/created-at/#createdat","title":"createdAt","text":"[jvm]\\ var createdAt: LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field1/","title":"field1 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field1/#field1","title":"field1","text":"[jvm]\\ open override fun field1(): Field<Long?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field2/","title":"field2 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field2
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field2/#field2","title":"field2","text":"[jvm]\\ open override fun field2(): Field<String?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field3/","title":"field3 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field3/#field3","title":"field3","text":"[jvm]\\ open override fun field3(): Field<String?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field4/","title":"field4 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field4
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field4/#field4","title":"field4","text":"[jvm]\\ open override fun field4(): Field<Int?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field5/","title":"field5 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field5
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field5/#field5","title":"field5","text":"[jvm]\\ open override fun field5(): Field<LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field6/","title":"field6 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field6
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field6/#field6","title":"field6","text":"[jvm]\\ open override fun field6(): Field<LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/fields-row/","title":"fieldsRow - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/fieldsRow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/fields-row/#fieldsrow","title":"fieldsRow","text":"[jvm]\\ open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/genre/","title":"genre - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/genre
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/genre/#genre","title":"genre","text":"[jvm]\\ var genre: String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/id/","title":"id - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/id
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/id/#id","title":"id","text":"[jvm]\\ var id: Long?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/key/","title":"key - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/key
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/key/#key","title":"key","text":"[jvm]\\ open override fun key(): Record1<Long?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/name/","title":"name - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/name
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/name/#name","title":"name","text":"[jvm]\\ var name: String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/updated-at/","title":"updatedAt - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/updatedAt
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/updated-at/#updatedat","title":"updatedAt","text":"[jvm]\\ var updatedAt: LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value1/","title":"value1 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value1/#value1","title":"value1","text":"[jvm]\\ open override fun value1(): Long?
open override fun value1(value: Long?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value2/","title":"value2 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value2
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value2/#value2","title":"value2","text":"[jvm]\\ open override fun value2(): String?
open override fun value2(value: String?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value3/","title":"value3 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value3/#value3","title":"value3","text":"[jvm]\\ open override fun value3(): String?
open override fun value3(value: String?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value4/","title":"value4 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value4
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value4/#value4","title":"value4","text":"[jvm]\\ open override fun value4(): Int?
open override fun value4(value: Int?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value5/","title":"value5 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value5
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value5/#value5","title":"value5","text":"[jvm]\\ open override fun value5(): LocalDateTime?
open override fun value5(value: LocalDateTime?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value6/","title":"value6 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value6
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value6/#value6","title":"value6","text":"[jvm]\\ open override fun value6(): LocalDateTime?
open override fun value6(value: LocalDateTime?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values-row/","title":"valuesRow - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/valuesRow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values-row/#valuesrow","title":"valuesRow","text":"[jvm]\\ open override fun valuesRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values/","title":"values - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/values
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values/#values","title":"values","text":"[jvm]\\ open override fun values(value1: Long?, value2: String?, value3: String?, value4: Int?, value5: LocalDateTime?, value6: LocalDateTime?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/version/","title":"version - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/version
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/version/#version","title":"version","text":"[jvm]\\ var version: Int?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.references
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/#properties","title":"Properties","text":"Name Summary MOVIE [jvm]val MOVIE: MovieThe tablejooq.movie."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/-m-o-v-i-e/","title":"MOVIE - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.references/MOVIE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/-m-o-v-i-e/#movie","title":"MOVIE","text":"[jvm]\\ val MOVIE: Movie
The table jooq.movie.
//misk-launchdarkly
"},{"location":"0.x/misk-launchdarkly/#misk-launchdarkly","title":"misk-launchdarkly","text":""},{"location":"0.x/misk-launchdarkly/#packages","title":"Packages","text":"Name misk.feature.launchdarkly"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/","title":"Package-level declarations - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/#types","title":"Types","text":"Name Summary LaunchDarklyConfig [jvm]data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val use_relay_proxy: Boolean = true, val ssl: HttpClientSSLConfig? = null) : Config LaunchDarklyModule [jvm]class LaunchDarklyModule@JvmOverloadsconstructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null) : KAbstractModuleBinds a FeatureFlags backed by LaunchDarkly (https://launchdarkly.com)."},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\ data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val use_relay_proxy: Boolean = true, val ssl: HttpClientSSLConfig? = null) : Config
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/#constructors","title":"Constructors","text":"LaunchDarklyConfig [jvm]@JvmOverloadsconstructor(sdk_key: String, base_uri: String, use_relay_proxy: Boolean = true, ssl: HttpClientSSLConfig? = null)"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/#properties","title":"Properties","text":"Name Summary base_uri [jvm]val base_uri: String sdk_key [jvm]val sdk_key: String ssl [jvm]val ssl: HttpClientSSLConfig? = null use_relay_proxy [jvm]val use_relay_proxy: Boolean = true"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/LaunchDarklyConfig
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\
@JvmOverloads
constructor(sdk_key: String, base_uri: String, use_relay_proxy: Boolean = true, ssl: HttpClientSSLConfig? = null)
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/base_uri/","title":"base_uri - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/base_uri
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/base_uri/#base_uri","title":"base_uri","text":"[jvm]\\ val base_uri: String
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/sdk_key/","title":"sdk_key - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/sdk_key
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/sdk_key/#sdk_key","title":"sdk_key","text":"[jvm]\\ val sdk_key: String
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/ssl/","title":"ssl - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/ssl
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/use_relay_proxy/","title":"use_relay_proxy - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/use_relay_proxy
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/use_relay_proxy/#use_relay_proxy","title":"use_relay_proxy","text":"[jvm]\\ val use_relay_proxy: Boolean = true
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/","title":"LaunchDarklyModule - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyModule
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/#launchdarklymodule","title":"LaunchDarklyModule","text":"[jvm]\\ class LaunchDarklyModule@JvmOverloadsconstructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null) : KAbstractModule
Binds a FeatureFlags backed by LaunchDarkly (https://launchdarkly.com).
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/#constructors","title":"Constructors","text":"LaunchDarklyModule [jvm]@JvmOverloadsconstructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null)"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/-launch-darkly-module/","title":"LaunchDarklyModule - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyModule/LaunchDarklyModule
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/-launch-darkly-module/#launchdarklymodule","title":"LaunchDarklyModule","text":"[jvm]\\
@JvmOverloads
constructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null)
"},{"location":"0.x/misk-launchdarkly-core/","title":"misk-launchdarkly-core - Misk","text":"//misk-launchdarkly-core
"},{"location":"0.x/misk-launchdarkly-core/#misk-launchdarkly-core","title":"misk-launchdarkly-core","text":""},{"location":"0.x/misk-launchdarkly-core/#packages","title":"Packages","text":"Name misk.feature.launchdarkly"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/","title":"Package-level declarations - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/#types","title":"Types","text":"Name Summary LaunchDarklyDynamicConfig [jvm]@Singletonclass LaunchDarklyDynamicConfig@Injectconstructor(featureFlags: FeatureFlags) : DynamicConfig LaunchDarklyFeatureFlags [jvm]@Singletonclass LaunchDarklyFeatureFlags@Injectconstructor(delegate: LaunchDarklyFeatureFlags) : AbstractIdleService, FeatureFlags, FeatureServiceImplementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation."},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\ @Singleton
class LaunchDarklyDynamicConfig@Injectconstructor(featureFlags: FeatureFlags) : DynamicConfig
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#constructors","title":"Constructors","text":"LaunchDarklyDynamicConfig [jvm]@Injectconstructor(featureFlags: FeatureFlags)"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open override fun getBoolean(feature: Feature): Boolean getDouble [jvm]open override fun getDouble(feature: Feature): Double getEnum [jvm]open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T getInt [jvm]open override fun getInt(feature: Feature): Int getJson [jvm]open override fun <T> getJson(feature: Feature, clazz: Class<T>): T getString [jvm]open override fun getString(feature: Feature): String trackBoolean [jvm]open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/LaunchDarklyDynamicConfig
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\
@Inject
constructor(featureFlags: FeatureFlags)
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature): Boolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-double/","title":"getDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature): Double
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-int/","title":"getInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature): Int
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-json/","title":"getJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-string/","title":"getString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature): String
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-int/","title":"trackInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-json/","title":"trackJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-string/","title":"trackString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/","title":"Companion - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/Companion
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/#properties","title":"Properties","text":"Name Summary ATTRIBUTES [jvm]val ATTRIBUTES: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/","title":"ATTRIBUTES - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/Companion/ATTRIBUTES
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/#attributes","title":"ATTRIBUTES","text":"[jvm]\\ val ATTRIBUTES: Attributes
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/","title":"KEY - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/Companion/KEY
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\ @Singleton
class LaunchDarklyFeatureFlags@Injectconstructor(delegate: LaunchDarklyFeatureFlags) : AbstractIdleService, FeatureFlags, FeatureService
Implementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation.
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/#constructors","title":"Constructors","text":"LaunchDarklyFeatureFlags [jvm]@Injectconstructor(delegate: LaunchDarklyFeatureFlags)"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getDouble [jvm]open fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getString [jvm]open fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/LaunchDarklyFeatureFlags
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\
@Inject
constructor(delegate: LaunchDarklyFeatureFlags)
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-double/","title":"getDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-enum/","title":"getEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-int/","title":"getInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature, key: String, attributes: Attributes): Int
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-json/","title":"getJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-string/","title":"getString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature, key: String, attributes: Attributes): String
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get/","title":"get - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/get
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get/#get","title":"get","text":"[jvm]\\ open override fun get(flag: BooleanFeatureFlag): Boolean
open override fun get(flag: StringFeatureFlag): String
open override fun get(flag: IntFeatureFlag): Int
open override fun get(flag: DoubleFeatureFlag): Double
open override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
open override fun <T : Any> get(flag: JsonFeatureFlag<T>): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-double/","title":"trackDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-int/","title":"trackInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-json/","title":"trackJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-string/","title":"trackString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/misk-lease/","title":"misk-lease - Misk","text":"//misk-lease
"},{"location":"0.x/misk-lease/#misk-lease","title":"misk-lease","text":""},{"location":"0.x/misk-lease/#packages","title":"Packages","text":"Name misk.lease"},{"location":"0.x/misk-lease/misk-lease/misk.lease/","title":"Package-level declarations - Misk","text":"//misk-lease/misk.lease
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-lease/misk-lease/misk.lease/#types","title":"Types","text":"Name Summary LeaseService [jvm]@Singletonclass LeaseService@Injectconstructor(leaseManager: LeaseManager) : AbstractIdleService"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/","title":"LeaseService - Misk","text":"//misk-lease/misk.lease/LeaseService
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#leaseservice","title":"LeaseService","text":"[jvm]\\ @Singleton
class LeaseService@Injectconstructor(leaseManager: LeaseManager) : AbstractIdleService
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#constructors","title":"Constructors","text":"LeaseService [jvm]@Injectconstructor(leaseManager: LeaseManager)"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-lease-service/","title":"LeaseService - Misk","text":"//misk-lease/misk.lease/LeaseService/LeaseService
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-lease-service/#leaseservice","title":"LeaseService","text":"[jvm]\\
@Inject
constructor(leaseManager: LeaseManager)
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-companion/","title":"Companion - Misk","text":"//misk-lease/misk.lease/LeaseService/Companion
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/","title":"misk-metrics - Misk","text":"//misk-metrics
"},{"location":"0.x/misk-metrics/#misk-metrics","title":"misk-metrics","text":""},{"location":"0.x/misk-metrics/#packages","title":"Packages","text":"Name misk.metrics misk.metrics.v2"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/","title":"Package-level declarations - Misk","text":"//misk-metrics/misk.metrics
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/#types","title":"Types","text":"Name Summary Histogram [jvm]interface HistogramSkeleton for the functionality of histograms MetricsModule [jvm]class MetricsModule : KAbstractModule"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/#properties","title":"Properties","text":"Name Summary defaultQuantiles [jvm]val defaultQuantiles: Map<Double, Double>"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/default-quantiles/","title":"defaultQuantiles - Misk","text":"//misk-metrics/misk.metrics/defaultQuantiles
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/default-quantiles/#defaultquantiles","title":"defaultQuantiles","text":"[jvm]\\ val defaultQuantiles: Map<Double, Double>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/","title":"Histogram - Misk","text":"//misk-metrics/misk.metrics/Histogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/#histogram","title":"Histogram","text":"[jvm]\\ interface Histogram
Skeleton for the functionality of histograms
A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets.
A sample implementation can be found in PrometheusHistogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/#functions","title":"Functions","text":"Name Summary count [jvm]open fun count(vararg labelValues: String): Intreturns the number of buckets getHistogram [jvm]abstract fun getHistogram(): Summary record [jvm]open fun record(duration: Double, vararg labelValues: String)records a new set of labels and accompanying duration timedMills [jvm]open fun <T> timedMills(vararg labelValues: String, work: () -> T): Trecords a new set of labels and the time to execute the work lambda in milliseconds"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/count/","title":"count - Misk","text":"//misk-metrics/misk.metrics/Histogram/count
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/count/#count","title":"count","text":"[jvm]\\ open fun count(vararg labelValues: String): Int
returns the number of buckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/get-histogram/","title":"getHistogram - Misk","text":"//misk-metrics/misk.metrics/Histogram/getHistogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/get-histogram/#gethistogram","title":"getHistogram","text":"[jvm]\\ abstract fun getHistogram(): Summary
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/record/","title":"record - Misk","text":"//misk-metrics/misk.metrics/Histogram/record
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/record/#record","title":"record","text":"[jvm]\\ open fun record(duration: Double, vararg labelValues: String)
records a new set of labels and accompanying duration
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/timed-mills/","title":"timedMills - Misk","text":"//misk-metrics/misk.metrics/Histogram/timedMills
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/timed-mills/#timedmills","title":"timedMills","text":"[jvm]\\ open fun <T> timedMills(vararg labelValues: String, work: () -> T): T
records a new set of labels and the time to execute the work lambda in milliseconds
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/","title":"Companion - Misk","text":"//misk-metrics/misk.metrics/Histogram/Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/#functions","title":"Functions","text":"Name Summary factory [jvm]fun factory(summary: Summary): Histogram"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/factory/","title":"factory - Misk","text":"//misk-metrics/misk.metrics/Histogram/Companion/factory
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/factory/#factory","title":"factory","text":"[jvm]\\ fun factory(summary: Summary): Histogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/","title":"MetricsModule - Misk","text":"//misk-metrics/misk.metrics/MetricsModule
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/#metricsmodule","title":"MetricsModule","text":"[jvm]\\ class MetricsModule : KAbstractModule
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/#constructors","title":"Constructors","text":"MetricsModule [jvm]constructor()"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/-metrics-module/","title":"MetricsModule - Misk","text":"//misk-metrics/misk.metrics/MetricsModule/MetricsModule
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/-metrics-module/#metricsmodule","title":"MetricsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/","title":"Package-level declarations - Misk","text":"//misk-metrics/misk.metrics.v2
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#types","title":"Types","text":"Name Summary Metrics [jvm]interface MetricsInterface for application code to emit metrics to a metrics backend like Prometheus. PeakGauge [jvm]@ThreadSafeclass PeakGauge : SimpleCollector<PeakGauge.Child> A peak gauge is a variant of a io.prometheus.client.Gauge that resets to an initial value of 0 after a metric collection."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#properties","title":"Properties","text":"Name Summary defaultBuckets [jvm]val defaultBuckets: List<Double>defaultBuckets is a default set of buckets which assumes the value is in milliseconds (ms). defaultQuantiles [jvm]val defaultQuantiles: Map<Double, Double> defaultSparseBuckets [jvm]val defaultSparseBuckets: List<Double>defaultSparseBuckets is a default set of buckets which assumes the value is in milliseconds (ms)."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#functions","title":"Functions","text":"Name Summary exponentialBuckets [jvm]fun exponentialBuckets(start: Double, factor: Double, count: Int): List<Double>Generate a list of upper bounds of buckets for a histogram with an exponential sequence. linearBuckets [jvm]fun linearBuckets(start: Double, width: Double, count: Int): List<Double>Generate a list of upper bounds of buckets for a histogram with a linear sequence."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-buckets/","title":"defaultBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/defaultBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-buckets/#defaultbuckets","title":"defaultBuckets","text":"[jvm]\\ val defaultBuckets: List<Double>
defaultBuckets is a default set of buckets which assumes the value is in milliseconds (ms).
It contains 58 buckets which range from 1ms to 1hr.
Adapted from the default M3 buckets.
https://github.com/m3db/m3/blob/v1.1.0/src/x/instrument/methods.go#L57-L83
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-quantiles/","title":"defaultQuantiles - Misk","text":"//misk-metrics/misk.metrics.v2/defaultQuantiles
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-quantiles/#defaultquantiles","title":"defaultQuantiles","text":"[jvm]\\ val defaultQuantiles: Map<Double, Double>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-sparse-buckets/","title":"defaultSparseBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/defaultSparseBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-sparse-buckets/#defaultsparsebuckets","title":"defaultSparseBuckets","text":"[jvm]\\ val defaultSparseBuckets: List<Double>
defaultSparseBuckets is a default set of buckets which assumes the value is in milliseconds (ms).
It contains 21 buckets which range from 1ms to 8m.
Adapted from the default M3 buckets.
https://github.com/m3db/m3/blob/v1.1.0/src/x/instrument/methods.go#L85-L147
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/exponential-buckets/","title":"exponentialBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/exponentialBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/exponential-buckets/#exponentialbuckets","title":"exponentialBuckets","text":"[jvm]\\ fun exponentialBuckets(start: Double, factor: Double, count: Int): List<Double>
Generate a list of upper bounds of buckets for a histogram with an exponential sequence.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/linear-buckets/","title":"linearBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/linearBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/linear-buckets/#linearbuckets","title":"linearBuckets","text":"[jvm]\\ fun linearBuckets(start: Double, width: Double, count: Int): List<Double>
Generate a list of upper bounds of buckets for a histogram with a linear sequence.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/","title":"Metrics - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/#metrics","title":"Metrics","text":"[jvm]\\ interface Metrics
Interface for application code to emit metrics to a metrics backend like Prometheus.
NOTE: misk.metrics.v2.Metrics is NOT backward compatible with misk.metrics.Metrics. This is because the metric type of the histogram(...) function has changed. If a callsite which used misk.metrics.Metrics.histogram(...) is upgraded to use misk.metrics.v2.Metrics.histogram(...), the dashboards and monitors based on the metric will break because the data type of the metric will have changed.
Tests that use this should install a metrics client like PrometheusMetricsClientModule. Services that use this should install a metrics service like PrometheusMetricsServiceModule.
Counter prometheus type. gauge [jvm]open fun gauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): Gaugegauge creates and registers a new Gauge prometheus type. getRegistry [jvm]abstract fun getRegistry(): CollectorRegistry histogram [jvm]open fun histogram(name: String, help: String = \"\", labelNames: List<String> = listOf(), buckets: List<Double> = defaultBuckets): Histogramhistogram creates a new Histogram prometheus type with the supplied parameters. peakGauge [jvm]open fun peakGauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): PeakGaugepeakGauge creates and registers a new Gauge prometheus type that resets to its initial value after each metrics collection. summary [jvm]open fun summary(name: String, help: String = \"\", labelNames: List<String> = listOf(), quantiles: Map<Double, Double> = defaultQuantiles, maxAgeSeconds: Long? = null): Summarysummary creates and registers a new Summary prometheus type."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/counter/","title":"counter - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/counter
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/counter/#counter","title":"counter","text":"[jvm]\\ open fun counter(name: String, help: String, labelNames: List<String> = listOf()): Counter
counter creates and registers a new Counter prometheus type.
See https://prometheus.github.io/client_java/io/prometheus/client/Counter.html for more info.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/counter/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/gauge/","title":"gauge - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/gauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/gauge/#gauge","title":"gauge","text":"[jvm]\\ open fun gauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): Gauge
gauge creates and registers a new Gauge prometheus type.
See https://prometheus.github.io/client_java/io/prometheus/client/Gauge.html for more info.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/gauge/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/get-registry/","title":"getRegistry - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/getRegistry
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/get-registry/#getregistry","title":"getRegistry","text":"[jvm]\\ abstract fun getRegistry(): CollectorRegistry
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/histogram/","title":"histogram - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/histogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/histogram/#histogram","title":"histogram","text":"[jvm]\\ open fun histogram(name: String, help: String = \"\", labelNames: List<String> = listOf(), buckets: List<Double> = defaultBuckets): Histogram
histogram creates a new Histogram prometheus type with the supplied parameters.
NOTE: misk.metrics.v2.Metrics is NOT backward compatible with misk.metrics.Metrics. This is because the metric type of the histogram(...) function has changed. If a callsite which used misk.metrics.Metrics.histogram(...) is upgraded to use misk.metrics.v2.Metrics.histogram(...), the dashboards and monitors based on the metric will break because the data type of the metric will have changed.
See https://prometheus.github.io/client_java/io/prometheus/client/Histogram.html for more info.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/histogram/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric. buckets a list of upper bounds of buckets for the histogram."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/peak-gauge/","title":"peakGauge - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/peakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/peak-gauge/#peakgauge","title":"peakGauge","text":"[jvm]\\ open fun peakGauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): PeakGauge
peakGauge creates and registers a new Gauge prometheus type that resets to its initial value after each metrics collection.
jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/summary/","title":"summary - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/summary
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/summary/#summary","title":"summary","text":"[jvm]\\ open fun summary(name: String, help: String = \"\", labelNames: List<String> = listOf(), quantiles: Map<Double, Double> = defaultQuantiles, maxAgeSeconds: Long? = null): Summary
summary creates and registers a new Summary prometheus type.
See https://prometheus.github.io/client_java/io/prometheus/client/Summary.html for more info.
NB: Summaries can be an order of magnitude more expensive than histograms in terms of CPU. Unless you require the specific properties of a summary, consider using histogram instead.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/summary/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric. quantiles is a map of all of the quantiles (a.k.a. percentiles) that will be computed for the metric. The key of the map is the quantile as a ratio (e.g. 0.99 represents p99) and the value is the \"tolerable error\" of the computed quantile."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/","title":"Companion - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/#functions","title":"Functions","text":"Name Summary factory [jvm]fun factory(registry: CollectorRegistry): Metrics"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/factory/","title":"factory - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/Companion/factory
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/factory/#factory","title":"factory","text":"[jvm]\\ fun factory(registry: CollectorRegistry): Metrics
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/","title":"PeakGauge - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#peakgauge","title":"PeakGauge","text":"[jvm]\\ @ThreadSafe
class PeakGauge : SimpleCollector<PeakGauge.Child>
A peak gauge is a variant of a io.prometheus.client.Gauge that resets to an initial value of 0 after a metric collection.
This is useful for accurately capturing maximum observed values over time. In contrast to the histogram maximum which tracks the maximum value in its sampling window. That sampling window typically covers multiple metric collections.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#constructors","title":"Constructors","text":"PeakGauge [jvm]constructor(builder: PeakGauge.Builder)"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : SimpleCollector.Builder<PeakGauge.Builder, PeakGauge> Child [jvm]class Child Companion [jvm]object Companion"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#functions","title":"Functions","text":"Name Summary clear [jvm]open fun clear() collect [jvm]open fun collect(p0: Predicate<String>): MutableList<Collector.MetricFamilySamples>open override fun collect(): MutableList<Collector.MetricFamilySamples> labels [jvm]open fun labels(vararg p0: String): PeakGauge.Child record [jvm]fun record(newValue: Double)Convenience method for recording values without labels register [jvm]open fun <T : Collector> register(): Topen fun <T : Collector> register(p0: CollectorRegistry): T remove [jvm]open fun remove(vararg p0: String) setChild [jvm]open fun <T : Collector> setChild(p0: PeakGauge.Child, vararg p1: String): T"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-peak-gauge/","title":"PeakGauge - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/PeakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-peak-gauge/#peakgauge","title":"PeakGauge","text":"[jvm]\\ constructor(builder: PeakGauge.Builder)
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/collect/","title":"collect - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/collect
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/collect/#collect","title":"collect","text":"[jvm]\\ open override fun collect(): MutableList<Collector.MetricFamilySamples>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/record/","title":"record - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/record
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/record/#record","title":"record","text":"[jvm]\\ fun record(newValue: Double)
Convenience method for recording values without labels
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/","title":"Builder - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Builder
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : SimpleCollector.Builder<PeakGauge.Builder, PeakGauge>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(): PeakGauge help [jvm]open fun help(p0: String): PeakGauge.Builder labelNames [jvm]open fun labelNames(vararg p0: String): PeakGauge.Builder name [jvm]open fun name(p0: String): PeakGauge.Builder namespace [jvm]open fun namespace(p0: String): PeakGauge.Builder register [jvm]open fun register(): PeakGaugeopen fun register(p0: CollectorRegistry): PeakGauge subsystem [jvm]open fun subsystem(p0: String): PeakGauge.Builder unit [jvm]open fun unit(p0: String): PeakGauge.Builder"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Builder/Builder
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/create/","title":"create - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Builder/create
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/create/#create","title":"create","text":"[jvm]\\ open override fun create(): PeakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/","title":"Child - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/#child","title":"Child","text":"[jvm]\\ class Child
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/#constructors","title":"Constructors","text":"Child [jvm]constructor()"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/#functions","title":"Functions","text":"Name Summary getAndClear [jvm]fun getAndClear(): DoubleReset to the initial value and return previously held value. record [jvm]fun record(newValue: Double)Updates the stored value if the new value is greater."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/-child/","title":"Child - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child/Child
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/-child/#child","title":"Child","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/get-and-clear/","title":"getAndClear - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child/getAndClear
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/get-and-clear/#getandclear","title":"getAndClear","text":"[jvm]\\ fun getAndClear(): Double
Reset to the initial value and return previously held value.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/record/","title":"record - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child/record
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/record/#record","title":"record","text":"[jvm]\\ fun record(newValue: Double)
Updates the stored value if the new value is greater.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/","title":"Companion - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/#functions","title":"Functions","text":"Name Summary builder [jvm]fun builder(name: String, help: String): PeakGauge.Builder"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/builder/","title":"builder - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Companion/builder
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/builder/#builder","title":"builder","text":"[jvm]\\ fun builder(name: String, help: String): PeakGauge.Builder
"},{"location":"0.x/misk-metrics-digester/","title":"misk-metrics-digester - Misk","text":"//misk-metrics-digester
"},{"location":"0.x/misk-metrics-digester/#misk-metrics-digester","title":"misk-metrics-digester","text":""},{"location":"0.x/misk-metrics-digester/#packages","title":"Packages","text":"Name com.squareup.digester.protos.service com.squareup.digester.protos.tdigest misk.metrics.digester"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/","title":"Package-level declarations - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/#types","title":"Types","text":"Name Summary DigestData [jvm]class DigestData : Message<M, B> Representation of internals of a t-digest implementation. GetDigestsRequest [jvm]class GetDigestsRequest : Message<M, B> GetDigestsResponse [jvm]class GetDigestsResponse : Message<M, B> MetricFamily [jvm]class MetricFamily : Message<M, B> A group of digest metrics all having the same name and label names."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/","title":"DigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#digestdata","title":"DigestData","text":"[jvm]\\ class DigestData : Message<M, B>
Representation of internals of a t-digest implementation.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#constructors","title":"Constructors","text":"DigestData [jvm]constructor(count: Long, sum: Double, veneur_digest: ByteString)constructor(count: Long, sum: Double, veneur_digest: ByteString, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<DigestData> Companion [jvm]val Companion: Message.Companion count [jvm]val count: LongCount of values observed. DEFAULT_COUNT [jvm]val DEFAULT_COUNT: Long DEFAULT_SUM [jvm]val DEFAULT_SUM: Double DEFAULT_VENEUR_DIGEST [jvm]val DEFAULT_VENEUR_DIGEST: ByteString sum [jvm]val sum: DoubleSum of observed values. veneur_digest [jvm]val veneur_digest: ByteStringSerialized Veneur t-digest proto bytes."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): DigestData.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<DigestData>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-c-o-u-n-t/","title":"DEFAULT_COUNT - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DEFAULT_COUNT
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-c-o-u-n-t/#default_count","title":"DEFAULT_COUNT","text":"[jvm]\\ val DEFAULT_COUNT: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-s-u-m/","title":"DEFAULT_SUM - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DEFAULT_SUM
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-s-u-m/#default_sum","title":"DEFAULT_SUM","text":"[jvm]\\ val DEFAULT_SUM: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-v-e-n-e-u-r_-d-i-g-e-s-t/","title":"DEFAULT_VENEUR_DIGEST - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DEFAULT_VENEUR_DIGEST
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-v-e-n-e-u-r_-d-i-g-e-s-t/#default_veneur_digest","title":"DEFAULT_VENEUR_DIGEST","text":"[jvm]\\ val DEFAULT_VENEUR_DIGEST: ByteString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-digest-data/","title":"DigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-digest-data/#digestdata","title":"DigestData","text":"[jvm]\\ constructor(count: Long, sum: Double, veneur_digest: ByteString)
constructor(count: Long, sum: Double, veneur_digest: ByteString, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/count/","title":"count - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/count/#count","title":"count","text":"[jvm]\\ val count: Long
Count of values observed.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): DigestData.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/sum/","title":"sum - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/sum/#sum","title":"sum","text":"[jvm]\\ val sum: Double
Sum of observed values.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/veneur_digest/","title":"veneur_digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/veneur_digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/veneur_digest/#veneur_digest","title":"veneur_digest","text":"[jvm]\\ val veneur_digest: ByteString
Serialized Veneur t-digest proto bytes. github.com/stripe/veneur/tdigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#properties","title":"Properties","text":"Name Summary count [jvm]open var count: Long sum [jvm]open var sum: Double veneur_digest [jvm]open var veneur_digest: ByteString"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): DigestData buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> count [jvm]open fun count(count: Long): DigestData.BuilderCount of values observed. getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) sum [jvm]open fun sum(sum: Double): DigestData.BuilderSum of observed values. veneur_digest [jvm]open fun veneur_digest(veneur_digest: ByteString): DigestData.BuilderSerialized Veneur t-digest proto bytes."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/count/","title":"count - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/count/#count","title":"count","text":"[jvm]\\ open fun count(count: Long): DigestData.Builder
Count of values observed.
[jvm]\\ open var count: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/sum/","title":"sum - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/sum/#sum","title":"sum","text":"[jvm]\\ open fun sum(sum: Double): DigestData.Builder
Sum of observed values.
[jvm]\\ open var sum: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/veneur_digest/","title":"veneur_digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/veneur_digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/veneur_digest/#veneur_digest","title":"veneur_digest","text":"[jvm]\\ open fun veneur_digest(veneur_digest: ByteString): DigestData.Builder
Serialized Veneur t-digest proto bytes. github.com/stripe/veneur/tdigest
[jvm]\\ open var veneur_digest: ByteString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/","title":"GetDigestsRequest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#getdigestsrequest","title":"GetDigestsRequest","text":"[jvm]\\ class GetDigestsRequest : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#constructors","title":"Constructors","text":"GetDigestsRequest [jvm]constructor(windows_end_from_ms: Long, windows_end_to_ms: Long)constructor(windows_end_from_ms: Long, windows_end_to_ms: Long, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<GetDigestsRequest> Companion [jvm]val Companion: Message.Companion DEFAULT_WINDOWS_END_FROM_MS [jvm]val DEFAULT_WINDOWS_END_FROM_MS: Long DEFAULT_WINDOWS_END_TO_MS [jvm]val DEFAULT_WINDOWS_END_TO_MS: Long windows_end_from_ms [jvm]val windows_end_from_ms: LongEarliest end time of windows to return, inclusive. windows_end_to_ms [jvm]val windows_end_to_ms: LongLatest end time of windows to return, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): GetDigestsRequest.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<GetDigestsRequest>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-f-r-o-m_-m-s/","title":"DEFAULT_WINDOWS_END_FROM_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/DEFAULT_WINDOWS_END_FROM_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-f-r-o-m_-m-s/#default_windows_end_from_ms","title":"DEFAULT_WINDOWS_END_FROM_MS","text":"[jvm]\\ val DEFAULT_WINDOWS_END_FROM_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-t-o_-m-s/","title":"DEFAULT_WINDOWS_END_TO_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/DEFAULT_WINDOWS_END_TO_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-t-o_-m-s/#default_windows_end_to_ms","title":"DEFAULT_WINDOWS_END_TO_MS","text":"[jvm]\\ val DEFAULT_WINDOWS_END_TO_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-get-digests-request/","title":"GetDigestsRequest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/GetDigestsRequest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-get-digests-request/#getdigestsrequest","title":"GetDigestsRequest","text":"[jvm]\\ constructor(windows_end_from_ms: Long, windows_end_to_ms: Long)
constructor(windows_end_from_ms: Long, windows_end_to_ms: Long, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): GetDigestsRequest.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_from_ms/","title":"windows_end_from_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/windows_end_from_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_from_ms/#windows_end_from_ms","title":"windows_end_from_ms","text":"[jvm]\\ val windows_end_from_ms: Long
Earliest end time of windows to return, inclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_to_ms/","title":"windows_end_to_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/windows_end_to_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_to_ms/#windows_end_to_ms","title":"windows_end_to_ms","text":"[jvm]\\ val windows_end_to_ms: Long
Latest end time of windows to return, inclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#properties","title":"Properties","text":"Name Summary windows_end_from_ms [jvm]open var windows_end_from_ms: Long windows_end_to_ms [jvm]open var windows_end_to_ms: Long"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): GetDigestsRequest buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) windows_end_from_ms [jvm]open fun windows_end_from_ms(windows_end_from_ms: Long): GetDigestsRequest.BuilderEarliest end time of windows to return, inclusive. windows_end_to_ms [jvm]open fun windows_end_to_ms(windows_end_to_ms: Long): GetDigestsRequest.BuilderLatest end time of windows to return, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): GetDigestsRequest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_from_ms/","title":"windows_end_from_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/windows_end_from_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_from_ms/#windows_end_from_ms","title":"windows_end_from_ms","text":"[jvm]\\ open fun windows_end_from_ms(windows_end_from_ms: Long): GetDigestsRequest.Builder
Earliest end time of windows to return, inclusive.
[jvm]\\ open var windows_end_from_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_to_ms/","title":"windows_end_to_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/windows_end_to_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_to_ms/#windows_end_to_ms","title":"windows_end_to_ms","text":"[jvm]\\ open fun windows_end_to_ms(windows_end_to_ms: Long): GetDigestsRequest.Builder
Latest end time of windows to return, inclusive.
[jvm]\\ open var windows_end_to_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/","title":"GetDigestsResponse - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#getdigestsresponse","title":"GetDigestsResponse","text":"[jvm]\\ class GetDigestsResponse : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#constructors","title":"Constructors","text":"GetDigestsResponse [jvm]constructor(metric_family: MetricFamily)constructor(metric_family: MetricFamily, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<GetDigestsResponse> Companion [jvm]val Companion: Message.Companion metric_family [jvm]val metric_family: MetricFamily"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): GetDigestsResponse.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<GetDigestsResponse>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-get-digests-response/","title":"GetDigestsResponse - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/GetDigestsResponse
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-get-digests-response/#getdigestsresponse","title":"GetDigestsResponse","text":"[jvm]\\ constructor(metric_family: MetricFamily)
constructor(metric_family: MetricFamily, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/metric_family/","title":"metric_family - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/metric_family
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/metric_family/#metric_family","title":"metric_family","text":"[jvm]\\ val metric_family: MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): GetDigestsResponse.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#properties","title":"Properties","text":"Name Summary metric_family [jvm]open var metric_family: MetricFamily"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): GetDigestsResponse buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter metric_family [jvm]open fun metric_family(metric_family: MetricFamily): GetDigestsResponse.Builder setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): GetDigestsResponse
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/metric_family/","title":"metric_family - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder/metric_family
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/metric_family/#metric_family","title":"metric_family","text":"[jvm]\\ open fun metric_family(metric_family: MetricFamily): GetDigestsResponse.Builder
open var metric_family: MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/","title":"MetricFamily - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#metricfamily","title":"MetricFamily","text":"[jvm]\\ class MetricFamily : Message<M, B>
A group of digest metrics all having the same name and label names.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#constructors","title":"Constructors","text":"MetricFamily [jvm]constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>)constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B> Digest [jvm]class Digest : Message<M, B> Digest holds a t-digest of data points observed in a specific time range. Metric [jvm]class Metric : Message<M, B> MetricDescriptor [jvm]class MetricDescriptor : Message<M, B> MetricDescriptor describes a named metric."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily> Companion [jvm]val Companion: Message.Companion metric_descriptor [jvm]val metric_descriptor: MetricFamily.MetricDescriptorDescriptor shared by each metric in this family. metrics [jvm]val metrics: List<MetricFamily.Metric>Metrics in the family, each having a unique set of labels."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-family/","title":"MetricFamily - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-family/#metricfamily","title":"MetricFamily","text":"[jvm]\\ constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>)
constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metric_descriptor/","title":"metric_descriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/metric_descriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metric_descriptor/#metric_descriptor","title":"metric_descriptor","text":"[jvm]\\ val metric_descriptor: MetricFamily.MetricDescriptor
Descriptor shared by each metric in this family.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metrics/","title":"metrics - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/metrics
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metrics/#metrics","title":"metrics","text":"[jvm]\\ val metrics: List<MetricFamily.Metric>
Metrics in the family, each having a unique set of labels.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#properties","title":"Properties","text":"Name Summary metric_descriptor [jvm]open var metric_descriptor: MetricFamily.MetricDescriptor metrics [jvm]open var metrics: List<MetricFamily.Metric>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter metric_descriptor [jvm]open fun metric_descriptor(metric_descriptor: MetricFamily.MetricDescriptor): MetricFamily.BuilderDescriptor shared by each metric in this family. metrics [jvm]open fun metrics(metrics: List<MetricFamily.Metric>): MetricFamily.BuilderMetrics in the family, each having a unique set of labels. setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metric_descriptor/","title":"metric_descriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/metric_descriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metric_descriptor/#metric_descriptor","title":"metric_descriptor","text":"[jvm]\\ open fun metric_descriptor(metric_descriptor: MetricFamily.MetricDescriptor): MetricFamily.Builder
Descriptor shared by each metric in this family.
[jvm]\\ open var metric_descriptor: MetricFamily.MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metrics/","title":"metrics - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/metrics
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metrics/#metrics","title":"metrics","text":"[jvm]\\ open fun metrics(metrics: List<MetricFamily.Metric>): MetricFamily.Builder
Metrics in the family, each having a unique set of labels.
[jvm]\\ open var metrics: List<MetricFamily.Metric>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/","title":"Digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#digest","title":"Digest","text":"[jvm]\\ class Digest : Message<M, B>
Digest holds a t-digest of data points observed in a specific time range.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#constructors","title":"Constructors","text":"Digest [jvm]constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData)constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily.Digest> Companion [jvm]val Companion: Message.Companion DEFAULT_END_AT_MS [jvm]val DEFAULT_END_AT_MS: Long DEFAULT_STAGGER [jvm]val DEFAULT_STAGGER: Long DEFAULT_START_AT_MS [jvm]val DEFAULT_START_AT_MS: Long digest_data [jvm]val digest_data: DigestDatat-digest of observed values. end_at_ms [jvm]val end_at_ms: LongEnd time window of data points, exclusive. stagger [jvm]val stagger: LongNumber of overlapping windows. start_at_ms [jvm]val start_at_ms: LongStart time window of data points, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.Digest.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily.Digest>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-e-n-d_-a-t_-m-s/","title":"DEFAULT_END_AT_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/DEFAULT_END_AT_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-e-n-d_-a-t_-m-s/#default_end_at_ms","title":"DEFAULT_END_AT_MS","text":"[jvm]\\ val DEFAULT_END_AT_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-g-g-e-r/","title":"DEFAULT_STAGGER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/DEFAULT_STAGGER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-g-g-e-r/#default_stagger","title":"DEFAULT_STAGGER","text":"[jvm]\\ val DEFAULT_STAGGER: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-r-t_-a-t_-m-s/","title":"DEFAULT_START_AT_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/DEFAULT_START_AT_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-r-t_-a-t_-m-s/#default_start_at_ms","title":"DEFAULT_START_AT_MS","text":"[jvm]\\ val DEFAULT_START_AT_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-digest/","title":"Digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-digest/#digest","title":"Digest","text":"[jvm]\\ constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData)
constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/digest_data/","title":"digest_data - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/digest_data
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/digest_data/#digest_data","title":"digest_data","text":"[jvm]\\ val digest_data: DigestData
t-digest of observed values. The registry and server must agree on the format of the digest.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/end_at_ms/","title":"end_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/end_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/end_at_ms/#end_at_ms","title":"end_at_ms","text":"[jvm]\\ val end_at_ms: Long
End time window of data points, exclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.Digest.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/stagger/","title":"stagger - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/stagger
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/stagger/#stagger","title":"stagger","text":"[jvm]\\ val stagger: Long
Number of overlapping windows. This is not directly related to the data, but is used by the collector to validate that registry and server configurations are compatible.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/start_at_ms/","title":"start_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/start_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/start_at_ms/#start_at_ms","title":"start_at_ms","text":"[jvm]\\ val start_at_ms: Long
Start time window of data points, inclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#properties","title":"Properties","text":"Name Summary digest_data [jvm]open var digest_data: DigestData end_at_ms [jvm]open var end_at_ms: Long stagger [jvm]open var stagger: Long start_at_ms [jvm]open var start_at_ms: Long"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily.Digest buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> digest_data [jvm]open fun digest_data(digest_data: DigestData): MetricFamily.Digest.Buildert-digest of observed values. end_at_ms [jvm]open fun end_at_ms(end_at_ms: Long): MetricFamily.Digest.BuilderEnd time window of data points, exclusive. getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) stagger [jvm]open fun stagger(stagger: Long): MetricFamily.Digest.BuilderNumber of overlapping windows. start_at_ms [jvm]open fun start_at_ms(start_at_ms: Long): MetricFamily.Digest.BuilderStart time window of data points, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily.Digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/digest_data/","title":"digest_data - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/digest_data
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/digest_data/#digest_data","title":"digest_data","text":"[jvm]\\ open fun digest_data(digest_data: DigestData): MetricFamily.Digest.Builder
t-digest of observed values. The registry and server must agree on the format of the digest.
[jvm]\\ open var digest_data: DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/end_at_ms/","title":"end_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/end_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/end_at_ms/#end_at_ms","title":"end_at_ms","text":"[jvm]\\ open fun end_at_ms(end_at_ms: Long): MetricFamily.Digest.Builder
End time window of data points, exclusive.
[jvm]\\ open var end_at_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/stagger/","title":"stagger - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/stagger
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/stagger/#stagger","title":"stagger","text":"[jvm]\\ open fun stagger(stagger: Long): MetricFamily.Digest.Builder
Number of overlapping windows. This is not directly related to the data, but is used by the collector to validate that registry and server configurations are compatible.
[jvm]\\ open var stagger: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/start_at_ms/","title":"start_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/start_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/start_at_ms/#start_at_ms","title":"start_at_ms","text":"[jvm]\\ open fun start_at_ms(start_at_ms: Long): MetricFamily.Digest.Builder
Start time window of data points, inclusive.
[jvm]\\ open var start_at_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/","title":"Metric - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#metric","title":"Metric","text":"[jvm]\\ class Metric : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#constructors","title":"Constructors","text":"Metric [jvm]constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>)constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily.Metric> Companion [jvm]val Companion: Message.Companion digests [jvm]val digests: List<MetricFamily.Digest>t-digests for the metric, each for a different window of time. labels [jvm]val labels: Map<String, String>Label values."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.Metric.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily.Metric>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-metric/","title":"Metric - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Metric
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-metric/#metric","title":"Metric","text":"[jvm]\\ constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>)
constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/digests/","title":"digests - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/digests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/digests/#digests","title":"digests","text":"[jvm]\\ val digests: List<MetricFamily.Digest>
t-digests for the metric, each for a different window of time.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/labels/","title":"labels - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/labels
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/labels/#labels","title":"labels","text":"[jvm]\\ val labels: Map<String, String>
Label values. There will be one value corresponding to each entry in the MetricDescriptor\u2019s label_names.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.Metric.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#properties","title":"Properties","text":"Name Summary digests [jvm]open var digests: List<MetricFamily.Digest> labels [jvm]open var labels: Map<String, String>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily.Metric buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> digests [jvm]open fun digests(digests: List<MetricFamily.Digest>): MetricFamily.Metric.Buildert-digests for the metric, each for a different window of time. getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter labels [jvm]open fun labels(labels: Map<String, String>): MetricFamily.Metric.BuilderLabel values. setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily.Metric
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/digests/","title":"digests - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/digests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/digests/#digests","title":"digests","text":"[jvm]\\ open fun digests(digests: List<MetricFamily.Digest>): MetricFamily.Metric.Builder
t-digests for the metric, each for a different window of time.
[jvm]\\ open var digests: List<MetricFamily.Digest>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/labels/","title":"labels - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/labels
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/labels/#labels","title":"labels","text":"[jvm]\\ open fun labels(labels: Map<String, String>): MetricFamily.Metric.Builder
Label values. There will be one value corresponding to each entry in the MetricDescriptor\u2019s label_names.
[jvm]\\ open var labels: Map<String, String>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/","title":"MetricDescriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#metricdescriptor","title":"MetricDescriptor","text":"[jvm]\\ class MetricDescriptor : Message<M, B>
MetricDescriptor describes a named metric.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#constructors","title":"Constructors","text":"MetricDescriptor [jvm]constructor(name: String, help: String)constructor(name: String, help: String, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily.MetricDescriptor> Companion [jvm]val Companion: Message.Companion DEFAULT_HELP [jvm]val DEFAULT_HELP: String = \"\" DEFAULT_NAME [jvm]val DEFAULT_NAME: String = \"\" help [jvm]val help: StringUser-friendly description of the metric. name [jvm]val name: StringName of the metric."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.MetricDescriptor.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily.MetricDescriptor>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-h-e-l-p/","title":"DEFAULT_HELP - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/DEFAULT_HELP
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-h-e-l-p/#default_help","title":"DEFAULT_HELP","text":"[jvm]\\ val DEFAULT_HELP: String = \"\"
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-n-a-m-e/","title":"DEFAULT_NAME - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/DEFAULT_NAME
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-n-a-m-e/#default_name","title":"DEFAULT_NAME","text":"[jvm]\\ val DEFAULT_NAME: String = \"\"
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-metric-descriptor/","title":"MetricDescriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-metric-descriptor/#metricdescriptor","title":"MetricDescriptor","text":"[jvm]\\ constructor(name: String, help: String)
constructor(name: String, help: String, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/help/","title":"help - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/help
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/help/#help","title":"help","text":"[jvm]\\ val help: String
User-friendly description of the metric.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/name/","title":"name - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/name
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/name/#name","title":"name","text":"[jvm]\\ val name: String
Name of the metric.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.MetricDescriptor.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#properties","title":"Properties","text":"Name Summary help [jvm]open var help: String name [jvm]open var name: String"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily.MetricDescriptor buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter help [jvm]open fun help(help: String): MetricFamily.MetricDescriptor.BuilderUser-friendly description of the metric. name [jvm]open fun name(name: String): MetricFamily.MetricDescriptor.BuilderName of the metric. setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily.MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/help/","title":"help - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/help
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/help/#help","title":"help","text":"[jvm]\\ open fun help(help: String): MetricFamily.MetricDescriptor.Builder
User-friendly description of the metric.
[jvm]\\ open var help: String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/name/","title":"name - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/name
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/name/#name","title":"name","text":"[jvm]\\ open fun name(name: String): MetricFamily.MetricDescriptor.Builder
Name of the metric.
[jvm]\\ open var name: String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/","title":"Package-level declarations - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/#types","title":"Types","text":"Name Summary Centroid [jvm]class Centroid : Message<M, B> MergingDigestData [jvm]class MergingDigestData : Message<M, B> MergingDigestData contains all fields necessary to generate a MergingDigest."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/","title":"Centroid - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#centroid","title":"Centroid","text":"[jvm]\\ class Centroid : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#constructors","title":"Constructors","text":"Centroid [jvm]constructor(mean: Double, weight: Double, samples: List<Double>)constructor(mean: Double, weight: Double, samples: List<Double>, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<Centroid> Companion [jvm]val Companion: Message.Companion DEFAULT_MEAN [jvm]val DEFAULT_MEAN: Double DEFAULT_WEIGHT [jvm]val DEFAULT_WEIGHT: Double mean [jvm]val mean: Double samples [jvm]val samples: List<Double> weight [jvm]val weight: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): Centroid.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<Centroid>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-centroid/","title":"Centroid - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Centroid
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-centroid/#centroid","title":"Centroid","text":"[jvm]\\ constructor(mean: Double, weight: Double, samples: List<Double>)
constructor(mean: Double, weight: Double, samples: List<Double>, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-m-e-a-n/","title":"DEFAULT_MEAN - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/DEFAULT_MEAN
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-m-e-a-n/#default_mean","title":"DEFAULT_MEAN","text":"[jvm]\\ val DEFAULT_MEAN: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-w-e-i-g-h-t/","title":"DEFAULT_WEIGHT - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/DEFAULT_WEIGHT
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-w-e-i-g-h-t/#default_weight","title":"DEFAULT_WEIGHT","text":"[jvm]\\ val DEFAULT_WEIGHT: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/mean/","title":"mean - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/mean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/mean/#mean","title":"mean","text":"[jvm]\\ val mean: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): Centroid.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/samples/","title":"samples - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/samples
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/samples/#samples","title":"samples","text":"[jvm]\\ val samples: List<Double>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/weight/","title":"weight - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/weight
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/weight/#weight","title":"weight","text":"[jvm]\\ val weight: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#properties","title":"Properties","text":"Name Summary mean [jvm]open var mean: Double samples [jvm]open var samples: List<Double> weight [jvm]open var weight: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): Centroid buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter mean [jvm]open fun mean(mean: Double): Centroid.Builder samples [jvm]open fun samples(samples: List<Double>): Centroid.Builder setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) weight [jvm]open fun weight(weight: Double): Centroid.Builder"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): Centroid
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/mean/","title":"mean - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/mean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/mean/#mean","title":"mean","text":"[jvm]\\ open fun mean(mean: Double): Centroid.Builder
open var mean: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/samples/","title":"samples - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/samples
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/samples/#samples","title":"samples","text":"[jvm]\\ open fun samples(samples: List<Double>): Centroid.Builder
open var samples: List<Double>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/weight/","title":"weight - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/weight
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/weight/#weight","title":"weight","text":"[jvm]\\ open fun weight(weight: Double): Centroid.Builder
open var weight: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/","title":"MergingDigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#mergingdigestdata","title":"MergingDigestData","text":"[jvm]\\ class MergingDigestData : Message<M, B>
MergingDigestData contains all fields necessary to generate a MergingDigest. This type should generally just be used when serializing MergingDigest\u2019s, and doesn\u2019t have much of a purpose on its own. Replica of stripe\u2019s tdigest implementation https://github.com/stripe/veneur/blob/master/tdigest/tdigest.proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#constructors","title":"Constructors","text":"MergingDigestData [jvm]constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double)constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MergingDigestData> Companion [jvm]val Companion: Message.Companion compression [jvm]val compression: Double DEFAULT_COMPRESSION [jvm]val DEFAULT_COMPRESSION: Double DEFAULT_MAX [jvm]val DEFAULT_MAX: Double DEFAULT_MIN [jvm]val DEFAULT_MIN: Double main_centroids [jvm]val main_centroids: List<Centroid> max [jvm]val max: Double min [jvm]val min: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MergingDigestData.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MergingDigestData>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-c-o-m-p-r-e-s-s-i-o-n/","title":"DEFAULT_COMPRESSION - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/DEFAULT_COMPRESSION
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-c-o-m-p-r-e-s-s-i-o-n/#default_compression","title":"DEFAULT_COMPRESSION","text":"[jvm]\\ val DEFAULT_COMPRESSION: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-a-x/","title":"DEFAULT_MAX - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/DEFAULT_MAX
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-a-x/#default_max","title":"DEFAULT_MAX","text":"[jvm]\\ val DEFAULT_MAX: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-i-n/","title":"DEFAULT_MIN - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/DEFAULT_MIN
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-i-n/#default_min","title":"DEFAULT_MIN","text":"[jvm]\\ val DEFAULT_MIN: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-merging-digest-data/","title":"MergingDigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/MergingDigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-merging-digest-data/#mergingdigestdata","title":"MergingDigestData","text":"[jvm]\\ constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double)
constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/compression/","title":"compression - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/compression
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/compression/#compression","title":"compression","text":"[jvm]\\ val compression: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/main_centroids/","title":"main_centroids - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/main_centroids
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/main_centroids/#main_centroids","title":"main_centroids","text":"[jvm]\\ val main_centroids: List<Centroid>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/max/","title":"max - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/max
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/max/#max","title":"max","text":"[jvm]\\ val max: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/min/","title":"min - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/min
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/min/#min","title":"min","text":"[jvm]\\ val min: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MergingDigestData.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#properties","title":"Properties","text":"Name Summary compression [jvm]open var compression: Double main_centroids [jvm]open var main_centroids: List<Centroid> max [jvm]open var max: Double min [jvm]open var min: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MergingDigestData buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> compression [jvm]open fun compression(compression: Double): MergingDigestData.Builder getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter main_centroids [jvm]open fun main_centroids(main_centroids: List<Centroid>): MergingDigestData.Builder max [jvm]open fun max(max: Double): MergingDigestData.Builder min [jvm]open fun min(min: Double): MergingDigestData.Builder setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MergingDigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/compression/","title":"compression - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/compression
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/compression/#compression","title":"compression","text":"[jvm]\\ open fun compression(compression: Double): MergingDigestData.Builder
open var compression: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/main_centroids/","title":"main_centroids - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/main_centroids
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/main_centroids/#main_centroids","title":"main_centroids","text":"[jvm]\\ open fun main_centroids(main_centroids: List<Centroid>): MergingDigestData.Builder
open var main_centroids: List<Centroid>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/max/","title":"max - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/max
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/max/#max","title":"max","text":"[jvm]\\ open fun max(max: Double): MergingDigestData.Builder
open var max: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/min/","title":"min - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/min
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/min/#min","title":"min","text":"[jvm]\\ open fun min(min: Double): MergingDigestData.Builder
open var min: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/","title":"Package-level declarations - Misk","text":"//misk-metrics-digester/misk.metrics.digester
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/#types","title":"Types","text":"Name Summary FakeDigest [jvm]class FakeDigest : TDigest<FakeDigest> Simulates VeneurDigest for testing purposes MergingDigest [jvm]class MergingDigest(compression: Double)Provides an implementation of t-digest to be used to send histogram data SlidingWindowDigest [jvm]class SlidingWindowDigest<T : TDigest<T>>@JvmOverloadsconstructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())SlidingWindowDigest approximates quantiles of data for a trailing time period. It is thread-safe. Snapshot [jvm]data class Snapshot(val quantileVals: List<Double>, val count: Long, val sum: Double)Snapshot is the state of a SlidingWindowDigest at a point in time. TDigest [jvm]interface TDigest<T : TDigest<T>>TDigest abstract common methods for t-digest implementations VeneurDigest [jvm]class VeneurDigest : TDigest<VeneurDigest> Wraps an adapted t-digest implementation from Stripe\u2019s Veneur project Window [jvm]data class Window(val start: ZonedDateTime, val end: ZonedDateTime)Window represents a time range WindowDigest [jvm]data class WindowDigest<T : TDigest<T>>(val window: Window, val digest: T)WindowDigest holds a t-digest whose data points are scoped to a specific time window. Windower [jvm]class Windower(windowSecs: Int, stagger: Int)Windower contains multiple windows with a specified duration"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/","title":"FakeDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/#fakedigest","title":"FakeDigest","text":"[jvm]\\ class FakeDigest : TDigest<FakeDigest>
Simulates VeneurDigest for testing purposes
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/#constructors","title":"Constructors","text":"FakeDigest [jvm]constructor()constructor(values: List<Double>)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(value: Double)Adds a new observation to the t-digest count [jvm]open override fun count(): LongReturns the count of the number of observations recorded within the t-digest mergeInto [jvm]open override fun mergeInto(other: FakeDigest)Merges this t-digest into another t-digest proto [jvm]open override fun proto(): DigestDataReturns a representation fo the t-digest that can be later be reconstituted into an instance of the same type quantile [jvm]open override fun quantile(quantile: Double): DoubleQuantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned. sum [jvm]open override fun sum(): DoubleReturns the sum of all values added into the digest, or NaN if no values have been added"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/-fake-digest/","title":"FakeDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/FakeDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/-fake-digest/#fakedigest","title":"FakeDigest","text":"[jvm]\\ constructor()
constructor(values: List<Double>)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/add/#add","title":"add","text":"[jvm]\\ open override fun add(value: Double)
Adds a new observation to the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/count/#count","title":"count","text":"[jvm]\\ open override fun count(): Long
Returns the count of the number of observations recorded within the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/merge-into/","title":"mergeInto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/mergeInto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/merge-into/#mergeinto","title":"mergeInto","text":"[jvm]\\ open override fun mergeInto(other: FakeDigest)
Merges this t-digest into another t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/proto/","title":"proto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/proto/#proto","title":"proto","text":"[jvm]\\ open override fun proto(): DigestData
Returns a representation fo the t-digest that can be later be reconstituted into an instance of the same type
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ open override fun quantile(quantile: Double): Double
Quantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/sum/#sum","title":"sum","text":"[jvm]\\ open override fun sum(): Double
Returns the sum of all values added into the digest, or NaN if no values have been added
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/","title":"MergingDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/#mergingdigest","title":"MergingDigest","text":"[jvm]\\ class MergingDigest(compression: Double)
Provides an implementation of t-digest to be used to send histogram data
Direct port of Veneur digest created by Stripe https://github.com/stripe/veneur/blob/master/tdigest/merging_digest.go
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/#constructors","title":"Constructors","text":"MergingDigest [jvm]constructor(mergingDigestData: MergingDigestData)Constructs a MergingDigest with values initialized from MergingDigestData. This should be the way to generate a MergingDigest from a serialized protobuf.constructor(compression: Double)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(value: Double, weight: Double)Adds a new value to the t-digest, with a given weight that must be positive. Infinities and NaN cannot be added. data [jvm]fun data(): MergingDigestDataMergingDigestData contains all fields necessary to generate a MergingDigest. This type should generally just be used when serializing MergingDigest\u2019s, and doesn\u2019t have much of a purpose on its own. mergeFrom [jvm]fun mergeFrom(other: MergingDigest)Merge another digest into this one. Neither td nor other can be shared concurrently during the execution of this method. quantile [jvm]fun quantile(quantile: Double): DoubleReturns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/-merging-digest/","title":"MergingDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/MergingDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/-merging-digest/#mergingdigest","title":"MergingDigest","text":"[jvm]\\ constructor(mergingDigestData: MergingDigestData)
Constructs a MergingDigest with values initialized from MergingDigestData. This should be the way to generate a MergingDigest from a serialized protobuf.
[jvm]\\ constructor(compression: Double)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/add/#add","title":"add","text":"[jvm]\\ fun add(value: Double, weight: Double)
Adds a new value to the t-digest, with a given weight that must be positive. Infinities and NaN cannot be added.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/data/","title":"data - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/data
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/data/#data","title":"data","text":"[jvm]\\ fun data(): MergingDigestData
MergingDigestData contains all fields necessary to generate a MergingDigest. This type should generally just be used when serializing MergingDigest\u2019s, and doesn\u2019t have much of a purpose on its own.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/merge-from/","title":"mergeFrom - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/mergeFrom
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/merge-from/#mergefrom","title":"mergeFrom","text":"[jvm]\\ fun mergeFrom(other: MergingDigest)
Merge another digest into this one. Neither td nor other can be shared concurrently during the execution of this method.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ fun quantile(quantile: Double): Double
Returns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/","title":"SlidingWindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/#slidingwindowdigest","title":"SlidingWindowDigest","text":"[jvm]\\ class SlidingWindowDigest<T : TDigest<T>>@JvmOverloadsconstructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())
SlidingWindowDigest approximates quantiles of data for a trailing time period. It is thread-safe.
To efficiently store observed data in a mergeable way, t-openDigests are used. As t-openDigests do not support discarding older data points, the sliding window aspect is approximated by keeping multiple separate t-openDigests scoped to discrete overlapping time windows. As a result, quantile data is reported from the most recent window that has ended.
The following example creates a 1 minute sliding window where there are 6 overlapping windows at a given time. Reported quantiles are at most 10 seconds out of date. SlidingWindowDigest(Windower(60, 6), fun() = VeneurDigest())
The following example creates a 10 second sliding window where there are 2 overlapping windows at a given time. Reported quantiles are at most 5 seconds out of date: NewSlidingWindowDigest(Windower(10, 2), fun() = VeneurDigest())
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/#constructors","title":"Constructors","text":"SlidingWindowDigest [jvm]@JvmOverloadsconstructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/#functions","title":"Functions","text":"Name Summary closedDigests [jvm]@Synchronizedfun closedDigests(from: ZonedDateTime): List<WindowDigest<T>>Returns all WindowDigests that ended starting from the given time (inclusive). The returned WindowDigest are ordered by their start time. mergeIn [jvm]@Synchronizedfun mergeIn(windowDigests: List<WindowDigest<T>>)Merges in the data from the given WindowDigests. The given windowDigests should use the same windowing boundaries as this; if they do not then quantiles reported by this sliding window digest may be incorrect. observe [jvm]@Synchronizedfun observe(value: Double)Adds the given value to all currently open t-openDigests. It is important to note that an observed value is not immediately reflected in calls to Quantile. openDigests [jvm]fun openDigests(gc: Boolean): List<WindowDigest<T>>Returns all WindowDigests that are currently open, creating new windows if necessary. Older openDigests that ended more than 1 minute earlier are discarded if gc is true. quantile [jvm]@Synchronizedfun quantile(quantile: Double): DoubleReturns estimated value for a quantile. The returned value may not include recently observed values due to how sliding windows are approximated. If no data has been observed then NaN is returned. snapshot [jvm]@Synchronizedfun snapshot(quantiles: List<Double>): SnapshotReturns a snapshot of estimated values for quantiles, along with the count of observations and their sum. The returned values may not include recent observations due to how sliding windows are approximated. If no data has been observed then a slice of NaNs of having quantiles.count() is returned and NaN is returned for the sum."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/-sliding-window-digest/","title":"SlidingWindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/SlidingWindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/-sliding-window-digest/#slidingwindowdigest","title":"SlidingWindowDigest","text":"[jvm]\\
@JvmOverloads
constructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/closed-digests/","title":"closedDigests - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/closedDigests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/closed-digests/#closeddigests","title":"closedDigests","text":"[jvm]\\
@Synchronized
fun closedDigests(from: ZonedDateTime): List<WindowDigest<T>>
Returns all WindowDigests that ended starting from the given time (inclusive). The returned WindowDigest are ordered by their start time.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/merge-in/","title":"mergeIn - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/mergeIn
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/merge-in/#mergein","title":"mergeIn","text":"[jvm]\\
@Synchronized
fun mergeIn(windowDigests: List<WindowDigest<T>>)
Merges in the data from the given WindowDigests. The given windowDigests should use the same windowing boundaries as this; if they do not then quantiles reported by this sliding window digest may be incorrect.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/observe/","title":"observe - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/observe
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/observe/#observe","title":"observe","text":"[jvm]\\
@Synchronized
fun observe(value: Double)
Adds the given value to all currently open t-openDigests. It is important to note that an observed value is not immediately reflected in calls to Quantile.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/open-digests/","title":"openDigests - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/openDigests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/open-digests/#opendigests","title":"openDigests","text":"[jvm]\\ fun openDigests(gc: Boolean): List<WindowDigest<T>>
Returns all WindowDigests that are currently open, creating new windows if necessary. Older openDigests that ended more than 1 minute earlier are discarded if gc is true.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\
@Synchronized
fun quantile(quantile: Double): Double
Returns estimated value for a quantile. The returned value may not include recently observed values due to how sliding windows are approximated. If no data has been observed then NaN is returned.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/snapshot/","title":"snapshot - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/snapshot
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\
@Synchronized
fun snapshot(quantiles: List<Double>): Snapshot
Returns a snapshot of estimated values for quantiles, along with the count of observations and their sum. The returned values may not include recent observations due to how sliding windows are approximated. If no data has been observed then a slice of NaNs of having quantiles.count() is returned and NaN is returned for the sum.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/","title":"Snapshot - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\ data class Snapshot(val quantileVals: List<Double>, val count: Long, val sum: Double)
Snapshot is the state of a SlidingWindowDigest at a point in time.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/#constructors","title":"Constructors","text":"Snapshot [jvm]constructor(quantileVals: List<Double>, count: Long, sum: Double)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/#properties","title":"Properties","text":"Name Summary count [jvm]val count: Long quantileVals [jvm]val quantileVals: List<Double> sum [jvm]val sum: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/-snapshot/","title":"Snapshot - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/Snapshot
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\ constructor(quantileVals: List<Double>, count: Long, sum: Double)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/count/#count","title":"count","text":"[jvm]\\ val count: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/quantile-vals/","title":"quantileVals - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/quantileVals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/quantile-vals/#quantilevals","title":"quantileVals","text":"[jvm]\\ val quantileVals: List<Double>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/sum/#sum","title":"sum","text":"[jvm]\\ val sum: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/","title":"TDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/#tdigest","title":"TDigest","text":"interface TDigest<T : TDigest<T>>
TDigest abstract common methods for t-digest implementations
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/#inheritors","title":"Inheritors","text":"FakeDigest VeneurDigest"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/#functions","title":"Functions","text":"Name Summary add [jvm]abstract fun add(value: Double)Adds an observed value to the digest. count [jvm]abstract fun count(): LongReturns the count of values added into the digest. mergeInto [jvm]abstract fun mergeInto(other: T)MergeInto merges the data in this digest into the other digest. The other digest is mutated and must be of the same TDigest type. proto [jvm]abstract fun proto(): DigestDataProto returns a representation of the t-digest that can be later reconstituted into an instance of the same type. quantile [jvm]abstract fun quantile(quantile: Double): DoubleQuantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned. sum [jvm]abstract fun sum(): DoubleReturns the sum of all values added into the digest, or NaN if no values have been added."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/add/#add","title":"add","text":"[jvm]\\ abstract fun add(value: Double)
Adds an observed value to the digest.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/count/#count","title":"count","text":"[jvm]\\ abstract fun count(): Long
Returns the count of values added into the digest.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/merge-into/","title":"mergeInto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/mergeInto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/merge-into/#mergeinto","title":"mergeInto","text":"[jvm]\\ abstract fun mergeInto(other: T)
MergeInto merges the data in this digest into the other digest. The other digest is mutated and must be of the same TDigest type.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/proto/","title":"proto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/proto/#proto","title":"proto","text":"[jvm]\\ abstract fun proto(): DigestData
Proto returns a representation of the t-digest that can be later reconstituted into an instance of the same type.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ abstract fun quantile(quantile: Double): Double
Quantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/sum/#sum","title":"sum","text":"[jvm]\\ abstract fun sum(): Double
Returns the sum of all values added into the digest, or NaN if no values have been added.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/","title":"VeneurDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/#veneurdigest","title":"VeneurDigest","text":"[jvm]\\ class VeneurDigest : TDigest<VeneurDigest>
Wraps an adapted t-digest implementation from Stripe\u2019s Veneur project
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/#constructors","title":"Constructors","text":"VeneurDigest [jvm]constructor()Creates a TDigest backed by a VeneurDigest, using a default compression levelconstructor(digestData: DigestData)Creates a VeneurDigest from a DigestData proto The DigestData proto must have veneur_digest set correctly"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(value: Double)Adds a new observation to the t-digest count [jvm]open override fun count(): LongReturns the count of the number of observations recorded within the t-digest mergeInto [jvm]open override fun mergeInto(other: VeneurDigest)Merges this t-digest into another t-digest mergingDigest [jvm]fun mergingDigest(): MergingDigestReturns the mergingDigest instance proto [jvm]open override fun proto(): DigestDataReturns a representation fo the t-digest that can be later be reconstituted into an instance of the same type quantile [jvm]open override fun quantile(quantile: Double): DoubleReturns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty. sum [jvm]open override fun sum(): DoubleReturns the sum of all values added into the digest, or NaN if no values have been added"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/-veneur-digest/","title":"VeneurDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/VeneurDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/-veneur-digest/#veneurdigest","title":"VeneurDigest","text":"[jvm]\\ constructor()
Creates a TDigest backed by a VeneurDigest, using a default compression level
[jvm]\\ constructor(digestData: DigestData)
Creates a VeneurDigest from a DigestData proto The DigestData proto must have veneur_digest set correctly
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/add/#add","title":"add","text":"[jvm]\\ open override fun add(value: Double)
Adds a new observation to the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/count/#count","title":"count","text":"[jvm]\\ open override fun count(): Long
Returns the count of the number of observations recorded within the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merge-into/","title":"mergeInto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/mergeInto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merge-into/#mergeinto","title":"mergeInto","text":"[jvm]\\ open override fun mergeInto(other: VeneurDigest)
Merges this t-digest into another t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merging-digest/","title":"mergingDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/mergingDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merging-digest/#mergingdigest","title":"mergingDigest","text":"[jvm]\\ fun mergingDigest(): MergingDigest
Returns the mergingDigest instance
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/proto/","title":"proto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/proto/#proto","title":"proto","text":"[jvm]\\ open override fun proto(): DigestData
Returns a representation fo the t-digest that can be later be reconstituted into an instance of the same type
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ open override fun quantile(quantile: Double): Double
Returns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/sum/#sum","title":"sum","text":"[jvm]\\ open override fun sum(): Double
Returns the sum of all values added into the digest, or NaN if no values have been added
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/","title":"Window - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#window","title":"Window","text":"[jvm]\\ data class Window(val start: ZonedDateTime, val end: ZonedDateTime)
Window represents a time range
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#constructors","title":"Constructors","text":"Window [jvm]constructor(start: ZonedDateTime, end: ZonedDateTime)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#properties","title":"Properties","text":"Name Summary end [jvm]val end: ZonedDateTime start [jvm]val start: ZonedDateTime"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#functions","title":"Functions","text":"Name Summary contains [jvm]fun contains(t: ZonedDateTime): BooleanReturns true if the given time t falls within the window\u2019s Start <= t < End."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/-window/","title":"Window - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/Window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/-window/#window","title":"Window","text":"[jvm]\\ constructor(start: ZonedDateTime, end: ZonedDateTime)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/contains/","title":"contains - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/contains
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/contains/#contains","title":"contains","text":"[jvm]\\ fun contains(t: ZonedDateTime): Boolean
Returns true if the given time t falls within the window\u2019s Start <= t < End.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/end/","title":"end - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/end
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/end/#end","title":"end","text":"[jvm]\\ val end: ZonedDateTime
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/start/","title":"start - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/start
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/start/#start","title":"start","text":"[jvm]\\ val start: ZonedDateTime
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/","title":"WindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/#windowdigest","title":"WindowDigest","text":"[jvm]\\ data class WindowDigest<T : TDigest<T>>(val window: Window, val digest: T)
WindowDigest holds a t-digest whose data points are scoped to a specific time window.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/#constructors","title":"Constructors","text":"WindowDigest [jvm]constructor(window: Window, digest: T)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/#properties","title":"Properties","text":"Name Summary digest [jvm]val digest: T window [jvm]val window: Window"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/-window-digest/","title":"WindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest/WindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/-window-digest/#windowdigest","title":"WindowDigest","text":"[jvm]\\ constructor(window: Window, digest: T)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/digest/","title":"digest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest/digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/digest/#digest","title":"digest","text":"[jvm]\\ val digest: T
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/window/","title":"window - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest/window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/window/#window","title":"window","text":"[jvm]\\ val window: Window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/","title":"Windower - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Windower
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/#windower","title":"Windower","text":"[jvm]\\ class Windower(windowSecs: Int, stagger: Int)
Windower contains multiple windows with a specified duration
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/#constructors","title":"Constructors","text":"Windower [jvm]constructor(windowSecs: Int, stagger: Int)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/#functions","title":"Functions","text":"Name Summary windowsContaining [jvm]fun windowsContaining(t: ZonedDateTime): List<Window>Returns all windows that the given time falls into. The returned slice will be ordered by window start time, and the number of windows in the returned slice will the same as the stagger given when the Windower was created."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/-windower/","title":"Windower - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Windower/Windower
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/-windower/#windower","title":"Windower","text":"[jvm]\\ constructor(windowSecs: Int, stagger: Int)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/windows-containing/","title":"windowsContaining - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Windower/windowsContaining
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/windows-containing/#windowscontaining","title":"windowsContaining","text":"[jvm]\\ fun windowsContaining(t: ZonedDateTime): List<Window>
Returns all windows that the given time falls into. The returned slice will be ordered by window start time, and the number of windows in the returned slice will the same as the stagger given when the Windower was created.
"},{"location":"0.x/misk-policy/","title":"misk-policy - Misk","text":"//misk-policy
"},{"location":"0.x/misk-policy/#misk-policy","title":"misk-policy","text":""},{"location":"0.x/misk-policy/#packages","title":"Packages","text":"Name misk.policy.opa"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/","title":"Package-level declarations - Misk","text":"//misk-policy/misk.policy.opa
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/#types","title":"Types","text":"Name Summary Metrics [jvm]data class Metrics(val counter_server_query_cache_hit: Long, val timer_rego_external_resolve_ns: Long, val timer_rego_input_parse_ns: Long, val timer_rego_query_eval_ns: Long, val timer_server_handler_ns: Long) MiskOpaMetrics [jvm]@Singletonclass MiskOpaMetrics@Injectconstructor(metrics: Metrics) : OpaMetricsMaps OpaResponse.metrics into prometheus counters and histograms. OpaApi [jvm]interface OpaApi OpaConfig [jvm]data class OpaConfig@JvmOverloadsconstructor(val baseUrl: String, val unixSocket: String?, val provenance: Boolean = false, val metrics: Boolean = true) : Config OpaMetrics [jvm]interface OpaMetrics OpaModule [jvm]class OpaModule@Injectconstructor(config: OpaConfig) : KAbstractModule OpaPolicyEngine [jvm]interface OpaPolicyEngine OpaRequest [jvm]abstract class OpaRequest OpaResponse [jvm]abstract class OpaResponse PolicyEngineException [jvm]class PolicyEngineException@JvmOverloadsconstructor(message: String, cause: Throwable? = null) : Exception Provenance [jvm]data class Provenance(val version: String?, val build_commit: String?, val build_timestamp: String?, val build_hostname: String?, val revision: String?, val bundles: Map<String, ProvenanceBundle>?) ProvenanceBundle [jvm]data class ProvenanceBundle(val revision: String?) RealOpaPolicyEngine [jvm]class RealOpaPolicyEngine@Injectconstructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig) : OpaPolicyEngineSupport for the Open Policy Engine (OPA). OPA provides a means to decouple policy from business logic. The resulting query response may have arbitrary shapes. Request [jvm]data class Request<T>(val input: T)OPA Request wrapper. Response [jvm]data class Response<T>(val decision_id: String?, val result: T?, val provenance: Provenance?, val metrics: Metrics?)OPA Response wrapper. Every response has this standard shape, made concrete by the expected response type."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/#functions","title":"Functions","text":"Name Summary evaluate [jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/","title":"evaluate - Misk","text":"//misk-policy/misk.policy.opa/evaluate
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#evaluate","title":"evaluate","text":"[jvm]\\ inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): R
Evaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified.[jvm]\\ inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): R
Evaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#return_1","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#parameters_1","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time (the input global field)."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#throws_1","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified.[jvm]\\ inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): R
Evaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#return_2","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#parameters_2","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time. Must be valid JSON."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#throws_2","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/","title":"Metrics - Misk","text":"//misk-policy/misk.policy.opa/Metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/#metrics","title":"Metrics","text":"[jvm]\\ data class Metrics(val counter_server_query_cache_hit: Long, val timer_rego_external_resolve_ns: Long, val timer_rego_input_parse_ns: Long, val timer_rego_query_eval_ns: Long, val timer_server_handler_ns: Long)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/#constructors","title":"Constructors","text":"Metrics [jvm]constructor(counter_server_query_cache_hit: Long, timer_rego_external_resolve_ns: Long, timer_rego_input_parse_ns: Long, timer_rego_query_eval_ns: Long, timer_server_handler_ns: Long)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/#properties","title":"Properties","text":"Name Summary counter_server_query_cache_hit [jvm]val counter_server_query_cache_hit: Long timer_rego_external_resolve_ns [jvm]val timer_rego_external_resolve_ns: Long timer_rego_input_parse_ns [jvm]val timer_rego_input_parse_ns: Long timer_rego_query_eval_ns [jvm]val timer_rego_query_eval_ns: Long timer_server_handler_ns [jvm]val timer_server_handler_ns: Long"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/-metrics/","title":"Metrics - Misk","text":"//misk-policy/misk.policy.opa/Metrics/Metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/-metrics/#metrics","title":"Metrics","text":"[jvm]\\ constructor(counter_server_query_cache_hit: Long, timer_rego_external_resolve_ns: Long, timer_rego_input_parse_ns: Long, timer_rego_query_eval_ns: Long, timer_server_handler_ns: Long)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/counter_server_query_cache_hit/","title":"counter_server_query_cache_hit - Misk","text":"//misk-policy/misk.policy.opa/Metrics/counter_server_query_cache_hit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/counter_server_query_cache_hit/#counter_server_query_cache_hit","title":"counter_server_query_cache_hit","text":"[jvm]\\ val counter_server_query_cache_hit: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_external_resolve_ns/","title":"timer_rego_external_resolve_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_rego_external_resolve_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_external_resolve_ns/#timer_rego_external_resolve_ns","title":"timer_rego_external_resolve_ns","text":"[jvm]\\ val timer_rego_external_resolve_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_input_parse_ns/","title":"timer_rego_input_parse_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_rego_input_parse_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_input_parse_ns/#timer_rego_input_parse_ns","title":"timer_rego_input_parse_ns","text":"[jvm]\\ val timer_rego_input_parse_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_query_eval_ns/","title":"timer_rego_query_eval_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_rego_query_eval_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_query_eval_ns/#timer_rego_query_eval_ns","title":"timer_rego_query_eval_ns","text":"[jvm]\\ val timer_rego_query_eval_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_server_handler_ns/","title":"timer_server_handler_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_server_handler_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_server_handler_ns/#timer_server_handler_ns","title":"timer_server_handler_ns","text":"[jvm]\\ val timer_server_handler_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/","title":"MiskOpaMetrics - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/#miskopametrics","title":"MiskOpaMetrics","text":"[jvm]\\ @Singleton
class MiskOpaMetrics@Injectconstructor(metrics: Metrics) : OpaMetrics
Maps OpaResponse.metrics into prometheus counters and histograms.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/#constructors","title":"Constructors","text":"MiskOpaMetrics [jvm]@Injectconstructor(metrics: Metrics)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/#functions","title":"Functions","text":"Name Summary evaluated [jvm]open override fun evaluated(document: String)Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not. observe [jvm]open override fun observe(document: String, response: OpaResponse)Dispatches OpaResponse.metrics into the prometheus client."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/-misk-opa-metrics/","title":"MiskOpaMetrics - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics/MiskOpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/-misk-opa-metrics/#miskopametrics","title":"MiskOpaMetrics","text":"[jvm]\\
@Inject
constructor(metrics: Metrics)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/evaluated/","title":"evaluated - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics/evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/evaluated/#evaluated","title":"evaluated","text":"[jvm]\\ open override fun evaluated(document: String)
Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/observe/","title":"observe - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics/observe
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/observe/#observe","title":"observe","text":"[jvm]\\ open override fun observe(document: String, response: OpaResponse)
Dispatches OpaResponse.metrics into the prometheus client.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/","title":"OpaApi - Misk","text":"//misk-policy/misk.policy.opa/OpaApi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/#opaapi","title":"OpaApi","text":"[jvm]\\ interface OpaApi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/#functions","title":"Functions","text":"Name Summary queryDocument [jvm]@Headers(value = [\"Content-Type: application/json\"])@POST(value = \"/v1/data/{documentPath}\")abstract fun queryDocument(@Path(value = \"documentPath\", encoded = true)documentPath: String, @Bodyinput: String, @Query(value = \"provenance\")provenance: Boolean, @Query(value = \"metrics\")metrics: Boolean): Call<ResponseBody>"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/query-document/","title":"queryDocument - Misk","text":"//misk-policy/misk.policy.opa/OpaApi/queryDocument
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/query-document/#querydocument","title":"queryDocument","text":"[jvm]\\
@Headers(value = [\"Content-Type: application/json\"])
@POST(value = \"/v1/data/{documentPath}\")
abstract fun queryDocument(@Path(value = \"documentPath\", encoded = true)documentPath: String, @Bodyinput: String, @Query(value = \"provenance\")provenance: Boolean, @Query(value = \"metrics\")metrics: Boolean): Call<ResponseBody>
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/","title":"OpaConfig - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/#opaconfig","title":"OpaConfig","text":"[jvm]\\ data class OpaConfig@JvmOverloadsconstructor(val baseUrl: String, val unixSocket: String?, val provenance: Boolean = false, val metrics: Boolean = true) : Config
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/#constructors","title":"Constructors","text":"OpaConfig [jvm]@JvmOverloadsconstructor(baseUrl: String, unixSocket: String?, provenance: Boolean = false, metrics: Boolean = true)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/#properties","title":"Properties","text":"Name Summary baseUrl [jvm]val baseUrl: String metrics [jvm]val metrics: Boolean = true provenance [jvm]val provenance: Boolean = false unixSocket [jvm]val unixSocket: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/-opa-config/","title":"OpaConfig - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/OpaConfig
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/-opa-config/#opaconfig","title":"OpaConfig","text":"[jvm]\\
@JvmOverloads
constructor(baseUrl: String, unixSocket: String?, provenance: Boolean = false, metrics: Boolean = true)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/base-url/","title":"baseUrl - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/baseUrl
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/base-url/#baseurl","title":"baseUrl","text":"[jvm]\\ val baseUrl: String
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/metrics/","title":"metrics - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/metrics/#metrics","title":"metrics","text":"[jvm]\\ val metrics: Boolean = true
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/provenance/","title":"provenance - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/provenance/#provenance","title":"provenance","text":"[jvm]\\ val provenance: Boolean = false
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/unix-socket/","title":"unixSocket - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/unixSocket
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/unix-socket/#unixsocket","title":"unixSocket","text":"[jvm]\\ val unixSocket: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/","title":"OpaMetrics - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#opametrics","title":"OpaMetrics","text":"interface OpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#inheritors","title":"Inheritors","text":"MiskOpaMetrics"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#types","title":"Types","text":"Name Summary Names [jvm]enum Names : Enum<OpaMetrics.Names>"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#functions","title":"Functions","text":"Name Summary evaluated [jvm]abstract fun evaluated(document: String)Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not. observe [jvm]abstract fun observe(document: String, response: OpaResponse)Dispatches OpaResponse.metrics into a metrics client."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/evaluated/","title":"evaluated - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/evaluated/#evaluated","title":"evaluated","text":"[jvm]\\ abstract fun evaluated(document: String)
Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/observe/","title":"observe - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/observe
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/observe/#observe","title":"observe","text":"[jvm]\\ abstract fun observe(document: String, response: OpaResponse)
Dispatches OpaResponse.metrics into a metrics client.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/","title":"Names - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#names","title":"Names","text":"[jvm]\\ enum Names : Enum<OpaMetrics.Names>
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#entries","title":"Entries","text":"opa_server_query_cache_hit [jvm]opa_server_query_cache_hit opa_rego_external_resolve [jvm]opa_rego_external_resolve opa_rego_input_parse [jvm]opa_rego_input_parse opa_rego_query_eval [jvm]opa_rego_query_eval opa_server_handler [jvm]opa_server_handler opa_rego_evaluated [jvm]opa_rego_evaluated"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<OpaMetrics.Names>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): OpaMetrics.NamesReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<OpaMetrics.Names>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/entries/","title":"entries - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/entries
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<OpaMetrics.Names>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/value-of/","title":"valueOf - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/valueOf
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): OpaMetrics.Names
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/values/","title":"values - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/values
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<OpaMetrics.Names>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_evaluated/","title":"opa_rego_evaluated - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_evaluated/#opa_rego_evaluated","title":"opa_rego_evaluated","text":"[jvm]\\ opa_rego_evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_evaluated/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_external_resolve/","title":"opa_rego_external_resolve - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_external_resolve
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_external_resolve/#opa_rego_external_resolve","title":"opa_rego_external_resolve","text":"[jvm]\\ opa_rego_external_resolve
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_external_resolve/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_input_parse/","title":"opa_rego_input_parse - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_input_parse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_input_parse/#opa_rego_input_parse","title":"opa_rego_input_parse","text":"[jvm]\\ opa_rego_input_parse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_input_parse/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_query_eval/","title":"opa_rego_query_eval - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_query_eval
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_query_eval/#opa_rego_query_eval","title":"opa_rego_query_eval","text":"[jvm]\\ opa_rego_query_eval
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_query_eval/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_handler/","title":"opa_server_handler - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_server_handler
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_handler/#opa_server_handler","title":"opa_server_handler","text":"[jvm]\\ opa_server_handler
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_handler/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_query_cache_hit/","title":"opa_server_query_cache_hit - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_server_query_cache_hit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_query_cache_hit/#opa_server_query_cache_hit","title":"opa_server_query_cache_hit","text":"[jvm]\\ opa_server_query_cache_hit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_query_cache_hit/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/","title":"OpaModule - Misk","text":"//misk-policy/misk.policy.opa/OpaModule
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/#opamodule","title":"OpaModule","text":"[jvm]\\ class OpaModule@Injectconstructor(config: OpaConfig) : KAbstractModule
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/#constructors","title":"Constructors","text":"OpaModule [jvm]@Injectconstructor(config: OpaConfig)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singleton@Named(value = \"opa-moshi\")fun provideMoshi(): Moshi"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/-opa-module/","title":"OpaModule - Misk","text":"//misk-policy/misk.policy.opa/OpaModule/OpaModule
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/-opa-module/#opamodule","title":"OpaModule","text":"[jvm]\\
@Inject
constructor(config: OpaConfig)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/provide-moshi/","title":"provideMoshi - Misk","text":"//misk-policy/misk.policy.opa/OpaModule/provideMoshi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"[jvm]\\
@Provides
@Singleton
@Named(value = \"opa-moshi\")
fun provideMoshi(): Moshi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/","title":"OpaPolicyEngine - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/#opapolicyengine","title":"OpaPolicyEngine","text":"interface OpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/#inheritors","title":"Inheritors","text":"RealOpaPolicyEngine"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/#functions","title":"Functions","text":"Name Summary evaluate [jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support. evaluateNoInput [jvm]abstract fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): R evaluateRawJsonInput [jvm]abstract fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): R evaluateWithInput [jvm]abstract fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): R"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-no-input/","title":"evaluateNoInput - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine/evaluateNoInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-no-input/#evaluatenoinput","title":"evaluateNoInput","text":"[jvm]\\ abstract fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): R
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-raw-json-input/","title":"evaluateRawJsonInput - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine/evaluateRawJsonInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-raw-json-input/#evaluaterawjsoninput","title":"evaluateRawJsonInput","text":"[jvm]\\ abstract fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): R
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-with-input/","title":"evaluateWithInput - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine/evaluateWithInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-with-input/#evaluatewithinput","title":"evaluateWithInput","text":"[jvm]\\ abstract fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): R
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/","title":"OpaRequest - Misk","text":"//misk-policy/misk.policy.opa/OpaRequest
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/#oparequest","title":"OpaRequest","text":"[jvm]\\ abstract class OpaRequest
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/#constructors","title":"Constructors","text":"OpaRequest [jvm]constructor()"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/-opa-request/","title":"OpaRequest - Misk","text":"//misk-policy/misk.policy.opa/OpaRequest/OpaRequest
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/-opa-request/#oparequest","title":"OpaRequest","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/","title":"OpaResponse - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/#oparesponse","title":"OpaResponse","text":"[jvm]\\ abstract class OpaResponse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/#constructors","title":"Constructors","text":"OpaResponse [jvm]constructor()"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/#properties","title":"Properties","text":"Name Summary metrics [jvm]var metrics: Metrics? provenance [jvm]var provenance: Provenance?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/-opa-response/","title":"OpaResponse - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse/OpaResponse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/-opa-response/#oparesponse","title":"OpaResponse","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/metrics/","title":"metrics - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse/metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/metrics/#metrics","title":"metrics","text":"[jvm]\\ var metrics: Metrics?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/provenance/","title":"provenance - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse/provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/provenance/#provenance","title":"provenance","text":"[jvm]\\ var provenance: Provenance?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/","title":"PolicyEngineException - Misk","text":"//misk-policy/misk.policy.opa/PolicyEngineException
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#policyengineexception","title":"PolicyEngineException","text":"[jvm]\\ class PolicyEngineException@JvmOverloadsconstructor(message: String, cause: Throwable? = null) : Exception
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#constructors","title":"Constructors","text":"PolicyEngineException [jvm]@JvmOverloadsconstructor(message: String, cause: Throwable? = null)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/-policy-engine-exception/","title":"PolicyEngineException - Misk","text":"//misk-policy/misk.policy.opa/PolicyEngineException/PolicyEngineException
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/-policy-engine-exception/#policyengineexception","title":"PolicyEngineException","text":"[jvm]\\
@JvmOverloads
constructor(message: String, cause: Throwable? = null)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/","title":"Provenance - Misk","text":"//misk-policy/misk.policy.opa/Provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/#provenance","title":"Provenance","text":"[jvm]\\ data class Provenance(val version: String?, val build_commit: String?, val build_timestamp: String?, val build_hostname: String?, val revision: String?, val bundles: Map<String, ProvenanceBundle>?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/#constructors","title":"Constructors","text":"Provenance [jvm]constructor(version: String?, build_commit: String?, build_timestamp: String?, build_hostname: String?, revision: String?, bundles: Map<String, ProvenanceBundle>?)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/#properties","title":"Properties","text":"Name Summary build_commit [jvm]val build_commit: String? build_hostname [jvm]val build_hostname: String? build_timestamp [jvm]val build_timestamp: String? bundles [jvm]val bundles: Map<String, ProvenanceBundle>? revision [jvm]val revision: String? version [jvm]val version: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/-provenance/","title":"Provenance - Misk","text":"//misk-policy/misk.policy.opa/Provenance/Provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/-provenance/#provenance","title":"Provenance","text":"[jvm]\\ constructor(version: String?, build_commit: String?, build_timestamp: String?, build_hostname: String?, revision: String?, bundles: Map<String, ProvenanceBundle>?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_commit/","title":"build_commit - Misk","text":"//misk-policy/misk.policy.opa/Provenance/build_commit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_commit/#build_commit","title":"build_commit","text":"[jvm]\\ val build_commit: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_hostname/","title":"build_hostname - Misk","text":"//misk-policy/misk.policy.opa/Provenance/build_hostname
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_hostname/#build_hostname","title":"build_hostname","text":"[jvm]\\ val build_hostname: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_timestamp/","title":"build_timestamp - Misk","text":"//misk-policy/misk.policy.opa/Provenance/build_timestamp
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_timestamp/#build_timestamp","title":"build_timestamp","text":"[jvm]\\ val build_timestamp: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/bundles/","title":"bundles - Misk","text":"//misk-policy/misk.policy.opa/Provenance/bundles
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/bundles/#bundles","title":"bundles","text":"[jvm]\\ val bundles: Map<String, ProvenanceBundle>?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/revision/","title":"revision - Misk","text":"//misk-policy/misk.policy.opa/Provenance/revision
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/revision/#revision","title":"revision","text":"[jvm]\\ val revision: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/version/","title":"version - Misk","text":"//misk-policy/misk.policy.opa/Provenance/version
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/version/#version","title":"version","text":"[jvm]\\ val version: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/","title":"ProvenanceBundle - Misk","text":"//misk-policy/misk.policy.opa/ProvenanceBundle
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/#provenancebundle","title":"ProvenanceBundle","text":"[jvm]\\ data class ProvenanceBundle(val revision: String?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/#constructors","title":"Constructors","text":"ProvenanceBundle [jvm]constructor(revision: String?)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/#properties","title":"Properties","text":"Name Summary revision [jvm]val revision: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/-provenance-bundle/","title":"ProvenanceBundle - Misk","text":"//misk-policy/misk.policy.opa/ProvenanceBundle/ProvenanceBundle
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/-provenance-bundle/#provenancebundle","title":"ProvenanceBundle","text":"[jvm]\\ constructor(revision: String?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/revision/","title":"revision - Misk","text":"//misk-policy/misk.policy.opa/ProvenanceBundle/revision
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/revision/#revision","title":"revision","text":"[jvm]\\ val revision: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/","title":"RealOpaPolicyEngine - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/#realopapolicyengine","title":"RealOpaPolicyEngine","text":"[jvm]\\ class RealOpaPolicyEngine@Injectconstructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig) : OpaPolicyEngine
Support for the Open Policy Engine (OPA). OPA provides a means to decouple policy from business logic. The resulting query response may have arbitrary shapes.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/#constructors","title":"Constructors","text":"RealOpaPolicyEngine [jvm]@Injectconstructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/#functions","title":"Functions","text":"Name Summary evaluate [jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support. evaluateNoInput [jvm]open override fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. evaluateRawJsonInput [jvm]open override fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries the automatic JSON serialization doesn\u2019t support. evaluateWithInput [jvm]open override fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/-real-opa-policy-engine/","title":"RealOpaPolicyEngine - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/RealOpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/-real-opa-policy-engine/#realopapolicyengine","title":"RealOpaPolicyEngine","text":"[jvm]\\
@Inject
constructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/","title":"evaluateNoInput - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/evaluateNoInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#evaluatenoinput","title":"evaluateNoInput","text":"[jvm]\\ open override fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): R
Evaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. returnType Shape of response to be demarshelled from OPA"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/","title":"evaluateRawJsonInput - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/evaluateRawJsonInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#evaluaterawjsoninput","title":"evaluateRawJsonInput","text":"[jvm]\\ open override fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): R
Evaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries the automatic JSON serialization doesn\u2019t support.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time. Must be valid JSON. returnType Return shape to be JSONified from OPA."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/","title":"evaluateWithInput - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/evaluateWithInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#evaluatewithinput","title":"evaluateWithInput","text":"[jvm]\\ open override fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): R
Evaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time (the input global field). inputType Input shape to be JSONified for OPA returnType Return shape to be JSONified from OPA"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/","title":"Request - Misk","text":"//misk-policy/misk.policy.opa/Request
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/#request","title":"Request","text":"[jvm]\\ data class Request<T>(val input: T)
OPA Request wrapper.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/#constructors","title":"Constructors","text":"Request [jvm]constructor(input: T)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/#properties","title":"Properties","text":"Name Summary input [jvm]val input: T"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/-request/","title":"Request - Misk","text":"//misk-policy/misk.policy.opa/Request/Request
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/-request/#request","title":"Request","text":"[jvm]\\ constructor(input: T)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/input/","title":"input - Misk","text":"//misk-policy/misk.policy.opa/Request/input
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/input/#input","title":"input","text":"[jvm]\\ val input: T
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/","title":"Response - Misk","text":"//misk-policy/misk.policy.opa/Response
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/#response","title":"Response","text":"[jvm]\\ data class Response<T>(val decision_id: String?, val result: T?, val provenance: Provenance?, val metrics: Metrics?)
OPA Response wrapper. Every response has this standard shape, made concrete by the expected response type.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(decision_id: String?, result: T?, provenance: Provenance?, metrics: Metrics?)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/#properties","title":"Properties","text":"Name Summary decision_id [jvm]val decision_id: String? metrics [jvm]val metrics: Metrics? provenance [jvm]val provenance: Provenance? result [jvm]val result: T?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/-response/","title":"Response - Misk","text":"//misk-policy/misk.policy.opa/Response/Response
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(decision_id: String?, result: T?, provenance: Provenance?, metrics: Metrics?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/decision_id/","title":"decision_id - Misk","text":"//misk-policy/misk.policy.opa/Response/decision_id
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/decision_id/#decision_id","title":"decision_id","text":"[jvm]\\ val decision_id: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/metrics/","title":"metrics - Misk","text":"//misk-policy/misk.policy.opa/Response/metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/metrics/#metrics","title":"metrics","text":"[jvm]\\ val metrics: Metrics?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/provenance/","title":"provenance - Misk","text":"//misk-policy/misk.policy.opa/Response/provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/provenance/#provenance","title":"provenance","text":"[jvm]\\ val provenance: Provenance?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/result/","title":"result - Misk","text":"//misk-policy/misk.policy.opa/Response/result
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/result/#result","title":"result","text":"[jvm]\\ val result: T?
"},{"location":"0.x/misk-prometheus/","title":"misk-prometheus - Misk","text":"//misk-prometheus
"},{"location":"0.x/misk-prometheus/#misk-prometheus","title":"misk-prometheus","text":""},{"location":"0.x/misk-prometheus/#packages","title":"Packages","text":"Name misk.metrics.backends.prometheus"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/","title":"Package-level declarations - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/#types","title":"Types","text":"Name Summary PrometheusConfig [jvm]data class PrometheusConfig(val hostname: String? = null, val http_port: Int = 9102, val max_age_in_seconds: Long? = null) : ConfigConfiguration for exporting metrics to prometheus PrometheusHttpService [jvm]@Singletonclass PrometheusHttpService : AbstractIdleService PrometheusMetricsServiceModule [jvm]class PrometheusMetricsServiceModule(config: PrometheusConfig) : KAbstractModuleExposes prometheus metrics over a dedicated port. Allows internal metrics to be exposed via a k8s ClusterIP address, where they can be scraped by a cluster local Prometheus server without also exposing them to the outside world via the port bound to the service load balancer. If using the prometheus operator, one would generally create a k8s ClusterIP service exporting the metrics port, then a prometheus ServiceMonitor selecting that service via a label."},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/","title":"PrometheusConfig - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/#prometheusconfig","title":"PrometheusConfig","text":"[jvm]\\ data class PrometheusConfig(val hostname: String? = null, val http_port: Int = 9102, val max_age_in_seconds: Long? = null) : Config
Configuration for exporting metrics to prometheus
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/#constructors","title":"Constructors","text":"PrometheusConfig [jvm]@Injectconstructor()constructor(hostname: String? = null, http_port: Int = 9102, max_age_in_seconds: Long? = null)"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/#properties","title":"Properties","text":"Name Summary hostname [jvm]val hostname: String? = null http_port [jvm]val http_port: Int = 9102 max_age_in_seconds [jvm]val max_age_in_seconds: Long? = null"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/-prometheus-config/","title":"PrometheusConfig - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/PrometheusConfig
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/-prometheus-config/#prometheusconfig","title":"PrometheusConfig","text":"[jvm]\\
@Inject
constructor()
constructor(hostname: String? = null, http_port: Int = 9102, max_age_in_seconds: Long? = null)
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/hostname/","title":"hostname - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/hostname
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/hostname/#hostname","title":"hostname","text":"[jvm]\\ val hostname: String? = null
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/http_port/","title":"http_port - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/http_port
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/http_port/#http_port","title":"http_port","text":"[jvm]\\ val http_port: Int = 9102
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/max_age_in_seconds/","title":"max_age_in_seconds - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/max_age_in_seconds
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/max_age_in_seconds/#max_age_in_seconds","title":"max_age_in_seconds","text":"[jvm]\\ val max_age_in_seconds: Long? = null
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-http-service/","title":"PrometheusHttpService - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusHttpService
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-http-service/#prometheushttpservice","title":"PrometheusHttpService","text":"[jvm]\\ @Singleton
class PrometheusHttpService : AbstractIdleService
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-http-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/","title":"PrometheusMetricsServiceModule - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusMetricsServiceModule
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/#prometheusmetricsservicemodule","title":"PrometheusMetricsServiceModule","text":"[jvm]\\ class PrometheusMetricsServiceModule(config: PrometheusConfig) : KAbstractModule
Exposes prometheus metrics over a dedicated port. Allows internal metrics to be exposed via a k8s ClusterIP address, where they can be scraped by a cluster local Prometheus server without also exposing them to the outside world via the port bound to the service load balancer. If using the prometheus operator, one would generally create a k8s ClusterIP service exporting the metrics port, then a prometheus ServiceMonitor selecting that service via a label.
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/#constructors","title":"Constructors","text":"PrometheusMetricsServiceModule [jvm]constructor(config: PrometheusConfig)"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/-prometheus-metrics-service-module/","title":"PrometheusMetricsServiceModule - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusMetricsServiceModule/PrometheusMetricsServiceModule
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/-prometheus-metrics-service-module/#prometheusmetricsservicemodule","title":"PrometheusMetricsServiceModule","text":"[jvm]\\ constructor(config: PrometheusConfig)
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/","title":"misk-rate-limiting-bucket4j-dynamodb-v1 - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/#misk-rate-limiting-bucket4j-dynamodb-v1","title":"misk-rate-limiting-bucket4j-dynamodb-v1","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/#packages","title":"Packages","text":"Name misk.ratelimiting.bucket4j.dynamodb.v1"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/","title":"Package-level declarations - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/#types","title":"Types","text":"Name Summary DynamoDbV1Bucket4jRateLimiterModule [jvm]class DynamoDbV1Bucket4jRateLimiterModule@JvmOverloadsconstructor(tableName: String, prunerPageSize: Int = 1000) : KAbstractModuleConfigures a RateLimiter that uses DynamoDb as a backend. DynamoDbV1BucketPruner [jvm]class DynamoDbV1BucketPruner@JvmOverloadsconstructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000) : Bucket4jPruner"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/","title":"DynamoDbV1BucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#dynamodbv1bucketpruner","title":"DynamoDbV1BucketPruner","text":"[jvm]\\ class DynamoDbV1BucketPruner@JvmOverloadsconstructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000) : Bucket4jPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#constructors","title":"Constructors","text":"DynamoDbV1BucketPruner [jvm]@JvmOverloadsconstructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]open override val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]open override fun prune()"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-dynamo-db-v1-bucket-pruner/","title":"DynamoDbV1BucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/DynamoDbV1BucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-dynamo-db-v1-bucket-pruner/#dynamodbv1bucketpruner","title":"DynamoDbV1BucketPruner","text":"[jvm]\\
@JvmOverloads
constructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/clockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"[jvm]\\ open override val clockTimeMeter: ClockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/prune/","title":"prune - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/prune
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/prune/#prune","title":"prune","text":"[jvm]\\ open override fun prune()
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-companion/","title":"Companion - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/","title":"DynamoDbV1Bucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/#dynamodbv1bucket4jratelimitermodule","title":"DynamoDbV1Bucket4jRateLimiterModule","text":"[jvm]\\ class DynamoDbV1Bucket4jRateLimiterModule@JvmOverloadsconstructor(tableName: String, prunerPageSize: Int = 1000) : KAbstractModule
Configures a RateLimiter that uses DynamoDb as a backend.
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/#constructors","title":"Constructors","text":"DynamoDbV1Bucket4jRateLimiterModule [jvm]@JvmOverloadsconstructor(tableName: String, prunerPageSize: Int = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providedPruner [jvm]@Provides@Singletonfun providedPruner(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimitPruner providedRateLimiter [jvm]@Provides@Singletonfun providedRateLimiter(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimiter"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/-dynamo-db-v1-bucket4j-rate-limiter-module/","title":"DynamoDbV1Bucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule/DynamoDbV1Bucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/-dynamo-db-v1-bucket4j-rate-limiter-module/#dynamodbv1bucket4jratelimitermodule","title":"DynamoDbV1Bucket4jRateLimiterModule","text":"[jvm]\\
@JvmOverloads
constructor(tableName: String, prunerPageSize: Int = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-pruner/","title":"providedPruner - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule/providedPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-pruner/#providedpruner","title":"providedPruner","text":"[jvm]\\
@Provides
@Singleton
fun providedPruner(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimitPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-rate-limiter/","title":"providedRateLimiter - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule/providedRateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-rate-limiter/#providedratelimiter","title":"providedRateLimiter","text":"[jvm]\\
@Provides
@Singleton
fun providedRateLimiter(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/","title":"misk-rate-limiting-bucket4j-mysql - Misk","text":"//misk-rate-limiting-bucket4j-mysql
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/#misk-rate-limiting-bucket4j-mysql","title":"misk-rate-limiting-bucket4j-mysql","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/#packages","title":"Packages","text":"Name misk.ratelimiting.bucket4j.mysql"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/","title":"Package-level declarations - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/#types","title":"Types","text":"Name Summary MySQLBucket4jRateLimiterModule [jvm]class MySQLBucket4jRateLimiterModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000) : KAbstractModule MySQLBucketPruner [jvm]class MySQLBucketPruner@JvmOverloadsconstructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000) : Bucket4jPruner"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/","title":"MySQLBucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#mysqlbucketpruner","title":"MySQLBucketPruner","text":"[jvm]\\ class MySQLBucketPruner@JvmOverloadsconstructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000) : Bucket4jPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#constructors","title":"Constructors","text":"MySQLBucketPruner [jvm]@JvmOverloadsconstructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]open override val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]open override fun prune()Prunes the rate limit table, returning the number of rows pruned."},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-my-s-q-l-bucket-pruner/","title":"MySQLBucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/MySQLBucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-my-s-q-l-bucket-pruner/#mysqlbucketpruner","title":"MySQLBucketPruner","text":"[jvm]\\
@JvmOverloads
constructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/clockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"[jvm]\\ open override val clockTimeMeter: ClockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/prune/","title":"prune - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/prune
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/prune/#prune","title":"prune","text":"[jvm]\\ open override fun prune()
Prunes the rate limit table, returning the number of rows pruned.
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-companion/","title":"Companion - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/","title":"MySQLBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/#mysqlbucket4jratelimitermodule","title":"MySQLBucket4jRateLimiterModule","text":"[jvm]\\ class MySQLBucket4jRateLimiterModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000) : KAbstractModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/#constructors","title":"Constructors","text":"MySQLBucket4jRateLimiterModule [jvm]@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providedPruner [jvm]@Provides@Singletonfun providedPruner(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimitPruner providedRateLimiter [jvm]@Provides@Singletonfun providedRateLimiter(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimiter"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/-my-s-q-l-bucket4j-rate-limiter-module/","title":"MySQLBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule/MySQLBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/-my-s-q-l-bucket4j-rate-limiter-module/#mysqlbucket4jratelimitermodule","title":"MySQLBucket4jRateLimiterModule","text":"[jvm]\\
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-pruner/","title":"providedPruner - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule/providedPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-pruner/#providedpruner","title":"providedPruner","text":"[jvm]\\
@Provides
@Singleton
fun providedPruner(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimitPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-rate-limiter/","title":"providedRateLimiter - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule/providedRateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-rate-limiter/#providedratelimiter","title":"providedRateLimiter","text":"[jvm]\\
@Provides
@Singleton
fun providedRateLimiter(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/","title":"misk-rate-limiting-bucket4j-redis - Misk","text":"//misk-rate-limiting-bucket4j-redis
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/#misk-rate-limiting-bucket4j-redis","title":"misk-rate-limiting-bucket4j-redis","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-redis/#packages","title":"Packages","text":"Name misk.ratelimiting.bucket4j.redis"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/","title":"Package-level declarations - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/#types","title":"Types","text":"Name Summary RedisBucket4jRateLimiterModule [jvm]class RedisBucket4jRateLimiterModule@JvmOverloadsconstructor(additionalTtl: Duration = Duration.ofSeconds(5)) : KAbstractModuleConfigures a RateLimiter that uses Redis as a backend."},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/","title":"RedisBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/RedisBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#redisbucket4jratelimitermodule","title":"RedisBucket4jRateLimiterModule","text":"class RedisBucket4jRateLimiterModule@JvmOverloadsconstructor(additionalTtl: Duration = Duration.ofSeconds(5)) : KAbstractModule
Configures a RateLimiter that uses Redis as a backend.
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#parameters","title":"Parameters","text":"jvm
additionalTtl Additional duration to add to the base TTL of each rate limit bucket, which is the duration of the refill period. This is a performance optimization that enables bucket reuse when a request comes in after the bucket has been refilled, since reuse is cheaper than creating a new bucket"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#constructors","title":"Constructors","text":"RedisBucket4jRateLimiterModule [jvm]@JvmOverloadsconstructor(additionalTtl: Duration = Duration.ofSeconds(5))"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providedRateLimiter [jvm]@Provides@Singletonfun providedRateLimiter(clock: Clock, metricsRegistry: MeterRegistry, unifiedJedis: UnifiedJedis): RateLimiter"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/-redis-bucket4j-rate-limiter-module/","title":"RedisBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/RedisBucket4jRateLimiterModule/RedisBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/-redis-bucket4j-rate-limiter-module/#redisbucket4jratelimitermodule","title":"RedisBucket4jRateLimiterModule","text":"[jvm]\\
@JvmOverloads
constructor(additionalTtl: Duration = Duration.ofSeconds(5))
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/-redis-bucket4j-rate-limiter-module/#parameters","title":"Parameters","text":"jvm
additionalTtl Additional duration to add to the base TTL of each rate limit bucket, which is the duration of the refill period. This is a performance optimization that enables bucket reuse when a request comes in after the bucket has been refilled, since reuse is cheaper than creating a new bucket"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/provided-rate-limiter/","title":"providedRateLimiter - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/RedisBucket4jRateLimiterModule/providedRateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/provided-rate-limiter/#providedratelimiter","title":"providedRateLimiter","text":"[jvm]\\
@Provides
@Singleton
fun providedRateLimiter(clock: Clock, metricsRegistry: MeterRegistry, unifiedJedis: UnifiedJedis): RateLimiter
"},{"location":"0.x/misk-redis/","title":"misk-redis - Misk","text":"//misk-redis
"},{"location":"0.x/misk-redis/#misk-redis","title":"misk-redis","text":""},{"location":"0.x/misk-redis/#packages","title":"Packages","text":"Name misk.redis"},{"location":"0.x/misk-redis/misk-redis/misk.redis/","title":"Package-level declarations - Misk","text":"//misk-redis/misk.redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-redis/misk-redis/misk.redis/#types","title":"Types","text":"Name Summary DeferredRedis [jvm]interface DeferredRedisLike Redis, but returns Suppliers to defer value retrieval. Does not support transactions or pubsub. RealRedis [jvm]class RealRedis(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics) : RedisFor each command, a Jedis instance is retrieved from the pool and returned once the command has been issued. Redis [jvm]interface RedisA Redis client. RedisClientMetrics [jvm]@Singletonclass RedisClientMetrics@Injectconstructor(ticker: Ticker, metrics: Metrics) RedisClusterConfig [jvm]class RedisClusterConfig : LinkedHashMap<String, RedisClusterReplicationGroupConfig> , ConfigTop-level configuration element for all redis clusters RedisClusterModule [jvm]class RedisClusterModule@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModuleConfigures a Redis client that interacts with a Redis cluster. This also installs a ServiceModule for RedisService. RedisClusterReplicationGroupConfig [jvm]data class RedisClusterReplicationGroupConfig@JvmOverloadsconstructor(val configuration_endpoint: RedisNodeConfig, val client_name: String? = null, val max_attempts: Int = DEFAULT_MAX_ATTEMPTS, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)Configuration element for a Redis Cluster RedisConfig [jvm]class RedisConfig : LinkedHashMap<String, RedisReplicationGroupConfig> , Config RedisConnectionException [jvm]class RedisConnectionException(cluster: String, cause: Throwable) : RuntimeException RedisModule [jvm]class RedisModule@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModuleConfigures a Redis client with metrics, this also installs a ServiceModule for RedisService. If other services require a working client connection to Redis before they can be used, specify a dependency like: RedisNodeConfig [jvm]data class RedisNodeConfig(val hostname: String?, val port: Int) RedisReplicationGroupConfig [jvm]data class RedisReplicationGroupConfig@JvmOverloadsconstructor(val writer_endpoint: RedisNodeConfig, val reader_endpoint: RedisNodeConfig, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT) RedisService [jvm]@Singletonclass RedisService : AbstractIdleServiceControls the connection lifecycle for Redis."},{"location":"0.x/misk-redis/misk-redis/misk.redis/#functions","title":"Functions","text":"Name Summary checkHrandFieldCount [jvm]inline fun checkHrandFieldCount(count: Long)Validates count is positive and non-zero. This is to avoid unexpected behaviour due to limitations in Jedis: https://github.com/redis/jedis/issues/3017"},{"location":"0.x/misk-redis/misk-redis/misk.redis/check-hrand-field-count/","title":"checkHrandFieldCount - Misk","text":"//misk-redis/misk.redis/checkHrandFieldCount
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/check-hrand-field-count/#checkhrandfieldcount","title":"checkHrandFieldCount","text":"[jvm]\\ inline fun checkHrandFieldCount(count: Long)
Validates count is positive and non-zero. This is to avoid unexpected behaviour due to limitations in Jedis: https://github.com/redis/jedis/issues/3017
This check can be removed when Jedis v5.x is released with full support for the behaviours for negative counts that are specified by Redis.
https://redis.io/commands/hrandfield/#specification-of-the-behavior-when-count-is-passed
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/","title":"DeferredRedis - Misk","text":"//misk-redis/misk.redis/DeferredRedis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/#deferredredis","title":"DeferredRedis","text":"[jvm]\\ interface DeferredRedis
Like Redis, but returns Suppliers to defer value retrieval. Does not support transactions or pubsub.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/#functions","title":"Functions","text":"Name Summary blmove [jvm]abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): Supplier<ByteString?> brpoplpush [jvm]abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): Supplier<ByteString?> close [jvm]abstract fun close() del [jvm]abstract fun del(vararg keys: String): Supplier<Int>abstract fun del(key: String): Supplier<Boolean> expire [jvm]abstract fun expire(key: String, seconds: Long): Supplier<Boolean> expireAt [jvm]abstract fun expireAt(key: String, timestampSeconds: Long): Supplier<Boolean> get [jvm]abstract operator fun get(key: String): Supplier<ByteString?> getDel [jvm]abstract fun getDel(key: String): Supplier<ByteString?> hdel [jvm]abstract fun hdel(key: String, vararg fields: String): Supplier<Long> hget [jvm]abstract fun hget(key: String, field: String): Supplier<ByteString?> hgetAll [jvm]abstract fun hgetAll(key: String): Supplier<Map<String, ByteString>?> hincrBy [jvm]abstract fun hincrBy(key: String, field: String, increment: Long): Supplier<Long> hlen [jvm]abstract fun hlen(key: String): Supplier<Long> hmget [jvm]abstract fun hmget(key: String, vararg fields: String): Supplier<List<ByteString?>> hrandField [jvm]abstract fun hrandField(key: String, count: Long): Supplier<List<String>> hrandFieldWithValues [jvm]abstract fun hrandFieldWithValues(key: String, count: Long): Supplier<Map<String, ByteString>?> hset [jvm]abstract fun hset(key: String, hash: Map<String, ByteString>): Supplier<Long>abstract fun hset(key: String, field: String, value: ByteString): Supplier<Long> incr [jvm]abstract fun incr(key: String): Supplier<Long> incrBy [jvm]abstract fun incrBy(key: String, increment: Long): Supplier<Long> lmove [jvm]abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): Supplier<ByteString?> lpop [jvm]abstract fun lpop(key: String): Supplier<ByteString?>abstract fun lpop(key: String, count: Int): Supplier<List<ByteString?>> lpush [jvm]abstract fun lpush(key: String, vararg elements: ByteString): Supplier<Long> lrange [jvm]abstract fun lrange(key: String, start: Long, stop: Long): Supplier<List<ByteString?>> lrem [jvm]abstract fun lrem(key: String, count: Long, element: ByteString): Supplier<Long> mget [jvm]abstract fun mget(vararg keys: String): Supplier<List<ByteString?>> mset [jvm]abstract fun mset(vararg keyValues: ByteString): Supplier<Unit> pExpire [jvm]abstract fun pExpire(key: String, milliseconds: Long): Supplier<Boolean> pExpireAt [jvm]abstract fun pExpireAt(key: String, timestampMilliseconds: Long): Supplier<Boolean> rpop [jvm]abstract fun rpop(key: String): Supplier<ByteString?>abstract fun rpop(key: String, count: Int): Supplier<List<ByteString?>> rpoplpush [jvm]abstract fun rpoplpush(sourceKey: String, destinationKey: String): Supplier<ByteString?> rpush [jvm]abstract fun rpush(key: String, vararg elements: ByteString): Supplier<Long> set [jvm]abstract fun set(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Unit> setnx [jvm]abstract fun setnx(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Boolean> zadd [jvm]abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Supplier<Long>abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Supplier<Long> zcard [jvm]abstract fun zcard(key: String): Supplier<Long> zrange [jvm]abstract fun zrange(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<ByteString?>> zrangeWithScores [jvm]abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<Pair<ByteString?, Double>>> zremRangeByRank [jvm]abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Supplier<Long> zscore [jvm]abstract fun zscore(key: String, member: String): Supplier<Double?>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/blmove/","title":"blmove - Misk","text":"//misk-redis/misk.redis/DeferredRedis/blmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/blmove/#blmove","title":"blmove","text":"[jvm]\\ abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/brpoplpush/","title":"brpoplpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/brpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/brpoplpush/#brpoplpush","title":"brpoplpush","text":"[jvm]\\ abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/close/","title":"close - Misk","text":"//misk-redis/misk.redis/DeferredRedis/close
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/close/#close","title":"close","text":"[jvm]\\ abstract fun close()
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/del/","title":"del - Misk","text":"//misk-redis/misk.redis/DeferredRedis/del
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/del/#del","title":"del","text":"[jvm]\\ abstract fun del(key: String): Supplier<Boolean>
abstract fun del(vararg keys: String): Supplier<Int>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire-at/","title":"expireAt - Misk","text":"//misk-redis/misk.redis/DeferredRedis/expireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire-at/#expireat","title":"expireAt","text":"[jvm]\\ abstract fun expireAt(key: String, timestampSeconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire/","title":"expire - Misk","text":"//misk-redis/misk.redis/DeferredRedis/expire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire/#expire","title":"expire","text":"[jvm]\\ abstract fun expire(key: String, seconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get-del/","title":"getDel - Misk","text":"//misk-redis/misk.redis/DeferredRedis/getDel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get-del/#getdel","title":"getDel","text":"[jvm]\\ abstract fun getDel(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get/","title":"get - Misk","text":"//misk-redis/misk.redis/DeferredRedis/get
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get/#get","title":"get","text":"[jvm]\\ abstract operator fun get(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hdel/","title":"hdel - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hdel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hdel/#hdel","title":"hdel","text":"[jvm]\\ abstract fun hdel(key: String, vararg fields: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget-all/","title":"hgetAll - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hgetAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget-all/#hgetall","title":"hgetAll","text":"[jvm]\\ abstract fun hgetAll(key: String): Supplier<Map<String, ByteString>?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget/","title":"hget - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget/#hget","title":"hget","text":"[jvm]\\ abstract fun hget(key: String, field: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hincr-by/","title":"hincrBy - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hincrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hincr-by/#hincrby","title":"hincrBy","text":"[jvm]\\ abstract fun hincrBy(key: String, field: String, increment: Long): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hlen/","title":"hlen - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hlen
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hlen/#hlen","title":"hlen","text":"[jvm]\\ abstract fun hlen(key: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hmget/","title":"hmget - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hmget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hmget/#hmget","title":"hmget","text":"[jvm]\\ abstract fun hmget(key: String, vararg fields: String): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field-with-values/","title":"hrandFieldWithValues - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hrandFieldWithValues
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field-with-values/#hrandfieldwithvalues","title":"hrandFieldWithValues","text":"[jvm]\\ abstract fun hrandFieldWithValues(key: String, count: Long): Supplier<Map<String, ByteString>?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field/","title":"hrandField - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hrandField
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field/#hrandfield","title":"hrandField","text":"[jvm]\\ abstract fun hrandField(key: String, count: Long): Supplier<List<String>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hset/","title":"hset - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hset/#hset","title":"hset","text":"[jvm]\\ abstract fun hset(key: String, field: String, value: ByteString): Supplier<Long>
abstract fun hset(key: String, hash: Map<String, ByteString>): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr-by/","title":"incrBy - Misk","text":"//misk-redis/misk.redis/DeferredRedis/incrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr-by/#incrby","title":"incrBy","text":"[jvm]\\ abstract fun incrBy(key: String, increment: Long): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr/","title":"incr - Misk","text":"//misk-redis/misk.redis/DeferredRedis/incr
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr/#incr","title":"incr","text":"[jvm]\\ abstract fun incr(key: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lmove/","title":"lmove - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lmove/#lmove","title":"lmove","text":"[jvm]\\ abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpop/","title":"lpop - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpop/#lpop","title":"lpop","text":"[jvm]\\ abstract fun lpop(key: String, count: Int): Supplier<List<ByteString?>>
abstract fun lpop(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpush/","title":"lpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpush/#lpush","title":"lpush","text":"[jvm]\\ abstract fun lpush(key: String, vararg elements: ByteString): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrange/","title":"lrange - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrange/#lrange","title":"lrange","text":"[jvm]\\ abstract fun lrange(key: String, start: Long, stop: Long): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrem/","title":"lrem - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lrem
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrem/#lrem","title":"lrem","text":"[jvm]\\ abstract fun lrem(key: String, count: Long, element: ByteString): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mget/","title":"mget - Misk","text":"//misk-redis/misk.redis/DeferredRedis/mget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mget/#mget","title":"mget","text":"[jvm]\\ abstract fun mget(vararg keys: String): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mset/","title":"mset - Misk","text":"//misk-redis/misk.redis/DeferredRedis/mset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mset/#mset","title":"mset","text":"[jvm]\\ abstract fun mset(vararg keyValues: ByteString): Supplier<Unit>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire-at/","title":"pExpireAt - Misk","text":"//misk-redis/misk.redis/DeferredRedis/pExpireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire-at/#pexpireat","title":"pExpireAt","text":"[jvm]\\ abstract fun pExpireAt(key: String, timestampMilliseconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire/","title":"pExpire - Misk","text":"//misk-redis/misk.redis/DeferredRedis/pExpire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire/#pexpire","title":"pExpire","text":"[jvm]\\ abstract fun pExpire(key: String, milliseconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpop/","title":"rpop - Misk","text":"//misk-redis/misk.redis/DeferredRedis/rpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpop/#rpop","title":"rpop","text":"[jvm]\\ abstract fun rpop(key: String, count: Int): Supplier<List<ByteString?>>
abstract fun rpop(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpoplpush/","title":"rpoplpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/rpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpoplpush/#rpoplpush","title":"rpoplpush","text":"[jvm]\\ abstract fun rpoplpush(sourceKey: String, destinationKey: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpush/","title":"rpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/rpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpush/#rpush","title":"rpush","text":"[jvm]\\ abstract fun rpush(key: String, vararg elements: ByteString): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/set/","title":"set - Misk","text":"//misk-redis/misk.redis/DeferredRedis/set
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/set/#set","title":"set","text":"[jvm]\\ abstract fun set(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Unit>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/setnx/","title":"setnx - Misk","text":"//misk-redis/misk.redis/DeferredRedis/setnx
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/setnx/#setnx","title":"setnx","text":"[jvm]\\ abstract fun setnx(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zadd/","title":"zadd - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zadd
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zadd/#zadd","title":"zadd","text":"[jvm]\\ abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Supplier<Long>
abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zcard/","title":"zcard - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zcard
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zcard/#zcard","title":"zcard","text":"[jvm]\\ abstract fun zcard(key: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange-with-scores/","title":"zrangeWithScores - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zrangeWithScores
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange-with-scores/#zrangewithscores","title":"zrangeWithScores","text":"[jvm]\\ abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<Pair<ByteString?, Double>>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange/","title":"zrange - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange/#zrange","title":"zrange","text":"[jvm]\\ abstract fun zrange(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrem-range-by-rank/","title":"zremRangeByRank - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zremRangeByRank
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrem-range-by-rank/#zremrangebyrank","title":"zremRangeByRank","text":"[jvm]\\ abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zscore/","title":"zscore - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zscore
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zscore/#zscore","title":"zscore","text":"[jvm]\\ abstract fun zscore(key: String, member: String): Supplier<Double?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/","title":"RealRedis - Misk","text":"//misk-redis/misk.redis/RealRedis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#realredis","title":"RealRedis","text":"[jvm]\\ class RealRedis(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics) : Redis
For each command, a Jedis instance is retrieved from the pool and returned once the command has been issued.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#constructors","title":"Constructors","text":"RealRedis [jvm]constructor(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#functions","title":"Functions","text":"Name Summary blmove [jvm]open override fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely. brpoplpush [jvm]open override fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely. close [jvm]open override fun close()Closes the connection to Redis. del [jvm]open override fun del(vararg keys: String): IntDeletes multiple keys.[jvm]open override fun del(key: String): BooleanDeletes a single key. expire [jvm]open override fun expire(key: String, seconds: Long): BooleanSet a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology. expireAt [jvm]open override fun expireAt(key: String, timestampSeconds: Long): BooleanexpireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately. flushAll [jvm]open override fun flushAll()Flushes all keys from all databases. get [jvm]open operator override fun get(key: String): ByteString?Retrieves the value for the given key as a ByteString. getDel [jvm]open override fun getDel(key: String): ByteString?Retrieves the value for the given key as a ByteString and deletes the key. hdel [jvm]open override fun hdel(key: String, vararg fields: String): LongDelete one or more hash fields stored at key. Specified fields that do not exist are ignored. hget [jvm]open override fun hget(key: String, field: String): ByteString?Retrieves the value for the given key and field as a ByteString. hgetAll [jvm]open override fun hgetAll(key: String): Map<String, ByteString>?Retrieves all the fields and associated values for the given key. Returns null if nothing found. hincrBy [jvm]open override fun hincrBy(key: String, field: String, increment: Long): LongIncrements the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed. hlen [jvm]open override fun hlen(key: String): LongReturns the number of fields contained in the hash stored at key. hmget [jvm]open override fun hmget(key: String, vararg fields: String): List<ByteString?>Retrieve the values associated to the specified fields. hrandField [jvm]open override fun hrandField(key: String, count: Long): List<String>Throws if count is negative. hrandFieldWithValues [jvm]open override fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?Throws if count is negative. hset [jvm]open override fun hset(key: String, hash: Map<String, ByteString>): LongSets the ByteString values for the given key and fields[jvm]open override fun hset(key: String, field: String, value: ByteString): LongSets the ByteString value for the given key and field incr [jvm]open override fun incr(key: String): LongIncrements the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. incrBy [jvm]open override fun incrBy(key: String, increment: Long): LongIncrements the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. lmove [jvm]open override fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination. lpop [jvm]open override fun lpop(key: String): ByteString?Removes and returns the first element of the list stored at key.[jvm]open override fun lpop(key: String, count: Int): List<ByteString?>Removes and returns the first count elements of the list stored at key. lpush [jvm]open override fun lpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. lrange [jvm]open override fun lrange(key: String, start: Long, stop: Long): List<ByteString?>Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on. lrem [jvm]open override fun lrem(key: String, count: Long, element: ByteString): LongRemoves the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list. mget [jvm]open override fun mget(vararg keys: String): List<ByteString?>Retrieves the values for the given list of keys. mset [jvm]open override fun mset(vararg keyValues: ByteString)Sets the key value pairs. multi [jvm]open override fun multi(): TransactionMarks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC. pExpire [jvm]open override fun pExpire(key: String, milliseconds: Long): BooleanThis command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds. pExpireAt [jvm]open override fun pExpireAt(key: String, timestampMilliseconds: Long): BooleanpExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds. pipelining [jvm]open override fun pipelining(block: DeferredRedis.() -> Unit)Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations. publish [jvm]open override fun publish(channel: String, message: String)Publish a message to a channel. rpop [jvm]open override fun rpop(key: String): ByteString?Removes and returns the last element of the list stored at key.[jvm]open override fun rpop(key: String, count: Int): List<ByteString?>Removes and returns the last count elements of the list stored at key. rpoplpush [jvm]open override fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination. rpush [jvm]open override fun rpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. scan [jvm]open override fun scan(cursor: String, matchPattern: String?, count: Int?): Redis.ScanResultPerforms a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through. set [jvm]open operator override fun set(key: String, value: ByteString)Sets the ByteString value for the given key.[jvm]open operator override fun set(key: String, expiryDuration: Duration, value: ByteString)Sets the ByteString value for a key with an expiration date. setnx [jvm]open override fun setnx(key: String, value: ByteString): Booleanopen override fun setnx(key: String, expiryDuration: Duration, value: ByteString): BooleanSets the ByteString value for the given key if it does not already exist. subscribe [jvm]open override fun subscribe(jedisPubSub: JedisPubSub, channel: String)Subscribe to a redis channel via pubsub. This is blocking! unwatch [jvm]open override fun unwatch(vararg keys: String)Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH. watch [jvm]open override fun watch(vararg keys: String)Marks the given keys to be watched for conditional execution of a transaction. zadd [jvm]open override fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): LongAdds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.[jvm]open override fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): LongAdds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering. zcard [jvm]open override fun zcard(key: String): LongReturns the sorted set cardinality (number of elements) of the sorted set stored at key zrange [jvm]open override fun zrange(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<ByteString?>Returns the specified range of elements in the sorted set stored at key. zrangeWithScores [jvm]open override fun zrangeWithScores(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<Pair<ByteString?, Double>>This is similar to zrange but returns the scores along with the members. zremRangeByRank [jvm]open override fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): LongRemoves all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth. zscore [jvm]open override fun zscore(key: String, member: String): Double?Returns the score of member in the sorted set at key."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-real-redis/","title":"RealRedis - Misk","text":"//misk-redis/misk.redis/RealRedis/RealRedis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-real-redis/#realredis","title":"RealRedis","text":"[jvm]\\ constructor(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/blmove/","title":"blmove - Misk","text":"//misk-redis/misk.redis/RealRedis/blmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/blmove/#blmove","title":"blmove","text":"[jvm]\\ open override fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?
blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely.
This command comes in place of the now deprecated brpoplpush. Doing BLMOVE RIGHT LEFT is equivalent.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See lmove for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/brpoplpush/","title":"brpoplpush - Misk","text":"//misk-redis/misk.redis/RealRedis/brpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/brpoplpush/#brpoplpush","title":"brpoplpush","text":"[jvm]\\ open override fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?
brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See rpoplpush for more information.
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by blmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/close/","title":"close - Misk","text":"//misk-redis/misk.redis/RealRedis/close
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/close/#close","title":"close","text":"[jvm]\\ open override fun close()
Closes the connection to Redis.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/","title":"del - Misk","text":"//misk-redis/misk.redis/RealRedis/del
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#del","title":"del","text":"[jvm]\\ open override fun del(key: String): Boolean
Deletes a single key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#return","title":"Return","text":"false if the key was not deleted, true if the key was deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#parameters","title":"Parameters","text":"jvm
key the key to delete[jvm]\\ open override fun del(vararg keys: String): Int
Deletes multiple keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#return_1","title":"Return","text":"0 if none of the keys were deleted, otherwise a positive integer representing the number of keys that were deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#parameters_1","title":"Parameters","text":"jvm
keys the keys to delete"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire-at/","title":"expireAt - Misk","text":"//misk-redis/misk.redis/RealRedis/expireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire-at/#expireat","title":"expireAt","text":"[jvm]\\ open override fun expireAt(key: String, timestampSeconds: Long): Boolean
expireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately.
Please for the specific semantics of the command refer to the documentation of expire.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire/","title":"expire - Misk","text":"//misk-redis/misk.redis/RealRedis/expire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire/#expire","title":"expire","text":"[jvm]\\ open override fun expire(key: String, seconds: Long): Boolean
Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology.
The timeout will only be cleared by commands that delete or overwrite the contents of the key, including del, set, GETSET and all the *STORE commands. This means that all the operations that conceptually alter the value stored at the key without replacing it with a new one will leave the timeout untouched. For instance, incrementing the value of a key with incr, pushing a new value into a list with LPUSH, or altering the field value of a hash with hset are all operations that will leave the timeout untouched.
The timeout can also be cleared, turning the key back into a persistent key, using the PERSIST command.
If a key is renamed with RENAME, the associated time to live is transferred to the new key name.
If a key is overwritten by RENAME, like in the case of an existing key Key_A that is overwritten by a call like RENAME Key_B Key_A, it does not matter if the original Key_A had a timeout associated or not, the new key Key_A will inherit all the characteristics of Key_B.
Note that calling expire/pExpire with a non-positive timeout or expireAt/pExpireAt with a time in the past will result in the key being deleted rather than expired (accordingly, the emitted key event will be del, not expired).
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/flush-all/","title":"flushAll - Misk","text":"//misk-redis/misk.redis/RealRedis/flushAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/flush-all/#flushall","title":"flushAll","text":"[jvm]\\ open override fun flushAll()
Flushes all keys from all databases.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/","title":"getDel - Misk","text":"//misk-redis/misk.redis/RealRedis/getDel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/#getdel","title":"getDel","text":"[jvm]\\ open override fun getDel(key: String): ByteString?
Retrieves the value for the given key as a ByteString and deletes the key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/","title":"get - Misk","text":"//misk-redis/misk.redis/RealRedis/get
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(key: String): ByteString?
Retrieves the value for the given key as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hdel/","title":"hdel - Misk","text":"//misk-redis/misk.redis/RealRedis/hdel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hdel/#hdel","title":"hdel","text":"[jvm]\\ open override fun hdel(key: String, vararg fields: String): Long
Delete one or more hash fields stored at key. Specified fields that do not exist are ignored.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hdel/#return","title":"Return","text":"The number of fields that were removed from the hash. If the key does not exist, it is treated as an empty hash and 0 is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/","title":"hgetAll - Misk","text":"//misk-redis/misk.redis/RealRedis/hgetAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/#hgetall","title":"hgetAll","text":"[jvm]\\ open override fun hgetAll(key: String): Map<String, ByteString>?
Retrieves all the fields and associated values for the given key. Returns null if nothing found.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/#return","title":"Return","text":"a Map of the fields to their associated values"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/#parameters","title":"Parameters","text":"
jvm
key the key"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/","title":"hget - Misk","text":"//misk-redis/misk.redis/RealRedis/hget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/#hget","title":"hget","text":"[jvm]\\ open override fun hget(key: String, field: String): ByteString?
Retrieves the value for the given key and field as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/#return","title":"Return","text":"a ByteString if the key/field combination was found, null if not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/#parameters","title":"Parameters","text":"jvm
key the key field the field"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/","title":"hincrBy - Misk","text":"//misk-redis/misk.redis/RealRedis/hincrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/#hincrby","title":"hincrBy","text":"[jvm]\\ open override fun hincrBy(key: String, field: String, increment: Long): Long
Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/#return","title":"Return","text":"the value at field after the increment operation.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/#parameters","title":"Parameters","text":"jvm
key the key. field the field."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hlen/","title":"hlen - Misk","text":"//misk-redis/misk.redis/RealRedis/hlen
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hlen/#hlen","title":"hlen","text":"[jvm]\\ open override fun hlen(key: String): Long
Returns the number of fields contained in the hash stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/","title":"hmget - Misk","text":"//misk-redis/misk.redis/RealRedis/hmget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/#hmget","title":"hmget","text":"[jvm]\\ open override fun hmget(key: String, vararg fields: String): List<ByteString?>
Retrieve the values associated to the specified fields.
If some specified fields do not exist, nil values are returned. Non-existing keys are considered like empty hashes.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/#return","title":"Return","text":"a List of the values for the specific fields requested, in the same order of the request. Null for missing fields"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/#parameters","title":"Parameters","text":"
jvm
key the key fields the specific fields to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field-with-values/","title":"hrandFieldWithValues - Misk","text":"//misk-redis/misk.redis/RealRedis/hrandFieldWithValues
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field-with-values/#hrandfieldwithvalues","title":"hrandFieldWithValues","text":"[jvm]\\ open override fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?
Throws if count is negative.
See misk.redis.Redis.hrandFieldWithValues.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field/","title":"hrandField - Misk","text":"//misk-redis/misk.redis/RealRedis/hrandField
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field/#hrandfield","title":"hrandField","text":"[jvm]\\ open override fun hrandField(key: String, count: Long): List<String>
Throws if count is negative.
See misk.redis.Redis.hrandField.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/","title":"hset - Misk","text":"//misk-redis/misk.redis/RealRedis/hset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#hset","title":"hset","text":"[jvm]\\ open override fun hset(key: String, field: String, value: ByteString): Long
Sets the ByteString value for the given key and field
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#return","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#parameters","title":"Parameters","text":"jvm
key the key field the field value the value to set[jvm]\\ open override fun hset(key: String, hash: Map<String, ByteString>): Long
Sets the ByteString values for the given key and fields
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#return_1","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#parameters_1","title":"Parameters","text":"jvm
key the key hash the map of fields to ByteString value"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr-by/","title":"incrBy - Misk","text":"//misk-redis/misk.redis/RealRedis/incrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr-by/#incrby","title":"incrBy","text":"[jvm]\\ open override fun incrBy(key: String, increment: Long): Long
Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
See incr for extra information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr/","title":"incr - Misk","text":"//misk-redis/misk.redis/RealRedis/incr
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr/#incr","title":"incr","text":"[jvm]\\ open override fun incr(key: String): Long
Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
Note: this is a string operation because Redis does not have a dedicated integer type. The string stored at the key is interpreted as a base-10 64 bit signed integer to execute the operation.
Redis stores integers in their integer representation, so for string values that actually hold an integer, there is no overhead for storing the string representation of the integer.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lmove/","title":"lmove - Misk","text":"//misk-redis/misk.redis/RealRedis/lmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lmove/#lmove","title":"lmove","text":"[jvm]\\ open override fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?
Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing LMOVE source destination RIGHT LEFT results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the first/last element from the list and pushing it as first/last element of the list, so it can be considered as a list rotation command (or a no-op if from is the same as to).
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
This command comes in place of the now deprecated RPOPLPUSH. Doing LMOVE RIGHT LEFT is equivalent.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpop/","title":"lpop - Misk","text":"//misk-redis/misk.redis/RealRedis/lpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpop/#lpop","title":"lpop","text":"[jvm]\\ open override fun lpop(key: String, count: Int): List<ByteString?>
Removes and returns the first count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ open override fun lpop(key: String): ByteString?
Removes and returns the first element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpush/","title":"lpush - Misk","text":"//misk-redis/misk.redis/RealRedis/lpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpush/#lpush","title":"lpush","text":"[jvm]\\ open override fun lpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
//misk-redis/misk.redis/RealRedis/lrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lrange/#lrange","title":"lrange","text":"[jvm]\\ open override fun lrange(key: String, start: Long, stop: Long): List<ByteString?>
Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.
These offsets can also be negative numbers indicating offsets starting at the end of the list. For example, -1 is the last element of the list, -2 the penultimate, and so on.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lrem/","title":"lrem - Misk","text":"//misk-redis/misk.redis/RealRedis/lrem
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lrem/#lrem","title":"lrem","text":"[jvm]\\ open override fun lrem(key: String, count: Long, element: ByteString): Long
Removes the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list.
Note that non-existing keys are treated like empty lists, so when key does not exist, the command will always return 0.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/","title":"mget - Misk","text":"//misk-redis/misk.redis/RealRedis/mget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/#mget","title":"mget","text":"[jvm]\\ open override fun mget(vararg keys: String): List<ByteString?>
Retrieves the values for the given list of keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/#return","title":"Return","text":"a list of String in the same order as the specified list of keys. For each key, a value will be returned if a key was found, otherwise null is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/#parameters","title":"Parameters","text":"jvm
keys the keys to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mset/","title":"mset - Misk","text":"//misk-redis/misk.redis/RealRedis/mset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mset/#mset","title":"mset","text":"[jvm]\\ open override fun mset(vararg keyValues: ByteString)
Sets the key value pairs.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mset/#parameters","title":"Parameters","text":"jvm
keyValues the list of keys and values in alternating order."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/multi/","title":"multi - Misk","text":"//misk-redis/misk.redis/RealRedis/multi
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/multi/#multi","title":"multi","text":"[jvm]\\ open override fun multi(): Transaction
Marks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire-at/","title":"pExpireAt - Misk","text":"//misk-redis/misk.redis/RealRedis/pExpireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire-at/#pexpireat","title":"pExpireAt","text":"[jvm]\\ open override fun pExpireAt(key: String, timestampMilliseconds: Long): Boolean
pExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire/","title":"pExpire - Misk","text":"//misk-redis/misk.redis/RealRedis/pExpire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire/#pexpire","title":"pExpire","text":"[jvm]\\ open override fun pExpire(key: String, milliseconds: Long): Boolean
This command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/pipelining/","title":"pipelining - Misk","text":"//misk-redis/misk.redis/RealRedis/pipelining
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/pipelining/#pipelining","title":"pipelining","text":"[jvm]\\ open override fun pipelining(block: DeferredRedis.() -> Unit)
Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations.
See Redis pipelining for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/publish/","title":"publish - Misk","text":"//misk-redis/misk.redis/RealRedis/publish
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/publish/#publish","title":"publish","text":"[jvm]\\ open override fun publish(channel: String, message: String)
Publish a message to a channel.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpop/","title":"rpop - Misk","text":"//misk-redis/misk.redis/RealRedis/rpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpop/#rpop","title":"rpop","text":"[jvm]\\ open override fun rpop(key: String, count: Int): List<ByteString?>
Removes and returns the last count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ open override fun rpop(key: String): ByteString?
Removes and returns the last element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpoplpush/","title":"rpoplpush - Misk","text":"//misk-redis/misk.redis/RealRedis/rpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpoplpush/#rpoplpush","title":"rpoplpush","text":"[jvm]\\ open override fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?
Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing rpoplpush results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the last element from the list and pushing it as first element of the list, so it can be considered as a list rotation command.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by lmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpush/","title":"rpush - Misk","text":"//misk-redis/misk.redis/RealRedis/rpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpush/#rpush","title":"rpush","text":"[jvm]\\ open override fun rpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
//misk-redis/misk.redis/RealRedis/scan
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/scan/#scan","title":"scan","text":"[jvm]\\ open override fun scan(cursor: String, matchPattern: String?, count: Int?): Redis.ScanResult
Performs a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/scan/#return","title":"Return","text":"A ScanResult containing the next cursor and the current batch of keys. If the returned cursor is \"0\", then there are no more keys left in the iteration.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/scan/#parameters","title":"Parameters","text":"jvm
cursor The scan cursor. This should first be \"0\". Then subsequent cursor values will be taken from the returned ScanResults. matchPattern A glob-like match pattern to filter keys by. If this is not provided, then all keys will be scanned. count A hinted desired batch size to be returned in each ScanResult. Note that this is just a hint and there are no guarantees on the actual size of each ScanResult."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/","title":"set - Misk","text":"//misk-redis/misk.redis/RealRedis/set
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/#set","title":"set","text":"[jvm]\\ open operator override fun set(key: String, value: ByteString)
Sets the ByteString value for the given key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ open operator override fun set(key: String, expiryDuration: Duration, value: ByteString)
Sets the ByteString value for a key with an expiration date.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/","title":"setnx - Misk","text":"//misk-redis/misk.redis/RealRedis/setnx
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/#setnx","title":"setnx","text":"[jvm]\\ open override fun setnx(key: String, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ open override fun setnx(key: String, expiryDuration: Duration, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/subscribe/","title":"subscribe - Misk","text":"//misk-redis/misk.redis/RealRedis/subscribe
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ open override fun subscribe(jedisPubSub: JedisPubSub, channel: String)
Subscribe to a redis channel via pubsub. This is blocking!
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/unwatch/","title":"unwatch - Misk","text":"//misk-redis/misk.redis/RealRedis/unwatch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open override fun unwatch(vararg keys: String)
Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/watch/","title":"watch - Misk","text":"//misk-redis/misk.redis/RealRedis/watch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(vararg keys: String)
Marks the given keys to be watched for conditional execution of a transaction.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zadd/","title":"zadd - Misk","text":"//misk-redis/misk.redis/RealRedis/zadd
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zadd/#zadd","title":"zadd","text":"[jvm]\\ open override fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Long
Adds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions.
[jvm]\\ open override fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Long
Adds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zcard/","title":"zcard - Misk","text":"//misk-redis/misk.redis/RealRedis/zcard
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zcard/#zcard","title":"zcard","text":"[jvm]\\ open override fun zcard(key: String): Long
Returns the sorted set cardinality (number of elements) of the sorted set stored at key
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange-with-scores/","title":"zrangeWithScores - Misk","text":"//misk-redis/misk.redis/RealRedis/zrangeWithScores
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange-with-scores/#zrangewithscores","title":"zrangeWithScores","text":"[jvm]\\ open override fun zrangeWithScores(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<Pair<ByteString?, Double>>
This is similar to zrange but returns the scores along with the members.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange/","title":"zrange - Misk","text":"//misk-redis/misk.redis/RealRedis/zrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange/#zrange","title":"zrange","text":"[jvm]\\ open override fun zrange(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<ByteString?>
Returns the specified range of elements in the sorted set stored at key.
ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order. Currently only index and score type range queries are supported. See ZRangeType for different types of range queries.
You can specify the start and stop of the range you want to filter by. Depending on the type you will have to use the appropriate type of ZRangeMarker.
The order of elements is from the lowest to the highest score. Elements with the same score are ordered lexicographically.
Setting reverse reverses the ordering, so elements are ordered from highest to lowest score, and score ties are resolved by reverse lexicographical ordering.
The limit argument can be used to obtain a sub-range from the matching elements. See ZRangeLimit for more info.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrem-range-by-rank/","title":"zremRangeByRank - Misk","text":"//misk-redis/misk.redis/RealRedis/zremRangeByRank
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrem-range-by-rank/#zremrangebyrank","title":"zremRangeByRank","text":"[jvm]\\ open override fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Long
Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zscore/","title":"zscore - Misk","text":"//misk-redis/misk.redis/RealRedis/zscore
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zscore/#zscore","title":"zscore","text":"[jvm]\\ open override fun zscore(key: String, member: String): Double?
Returns the score of member in the sorted set at key.
If member does not exist in the sorted set, or key does not exist, nil is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/","title":"Companion - Misk","text":"//misk-redis/misk.redis/RealRedis/Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/#properties","title":"Properties","text":"Name Summary charset [jvm]val charset: Charset"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/charset/","title":"charset - Misk","text":"//misk-redis/misk.redis/RealRedis/Companion/charset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/charset/#charset","title":"charset","text":"[jvm]\\ val charset: Charset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/","title":"Redis - Misk","text":"//misk-redis/misk.redis/Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#redis","title":"Redis","text":"interface Redis
A Redis client.
Note: special care must be taken if your Redis is running in cluster mode, as keys must belong to the same slot in a single command operation like lmove. You can control which hash slot a key belongs to a certain degree by making use of {hashtags} in the key name.
See the Redis Cluster Spec for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#inheritors","title":"Inheritors","text":"RealRedis"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#types","title":"Types","text":"Name Summary ScanResult [jvm]data class ScanResult(val cursor: String, val keys: List<String>) ZAddOptions [jvm]enum ZAddOptions : Enum<Redis.ZAddOptions> Options for ZADD. Not all options are compatible with one another. See the ZADD command documentation for more information. ZRangeIndexMarker [jvm]data class ZRangeIndexMarker(val intValue: Int) : Redis.ZRangeMarkerTo be used when ZRangeType is ZRangeType.INDEX. The intValue should be an integer specifying the index (start or stop) ZRangeLimit [jvm]data class ZRangeLimit(val offset: Int, val count: Int)The limit argument in zrange and zrangeWithScores can be used to obtain a sub-range from the matching elements similar to SELECT LIMIT offset, count in SQL. A negative count returns all elements from the offset. Keep in mind that if is large, the sorted set needs to be traversed for elements before getting to the elements to return, which can add up to O(N) time complexity. ZRangeMarker [jvm]abstract class ZRangeMarker(val value: Any, val included: Boolean) ZRangeRankMarker [jvm]data class ZRangeRankMarker(val longValue: Long) : Redis.ZRangeMarker ZRangeScoreMarker [jvm]data class ZRangeScoreMarker@JvmOverloadsconstructor(val doubleValue: Double, val isIncluded: Boolean = true) : Redis.ZRangeMarkerTo be used when ZRangeType is ZRangeType.SCORE. The doubleValue should be a double specifying the score (start or stop) By default the range is included. Set isIncluded to false in order to exclude the start or stop. ZRangeType [jvm]enum ZRangeType : Enum<Redis.ZRangeType> Different types of range queries."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#functions","title":"Functions","text":"Name Summary blmove [jvm]abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely. brpoplpush [jvm]abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely. close [jvm]abstract fun close()Closes the client, so it may not be used further. del [jvm]abstract fun del(vararg keys: String): IntDeletes multiple keys.[jvm]abstract fun del(key: String): BooleanDeletes a single key. expire [jvm]abstract fun expire(key: String, seconds: Long): BooleanSet a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology. expireAt [jvm]abstract fun expireAt(key: String, timestampSeconds: Long): BooleanexpireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately. flushAll [jvm]abstract fun flushAll()Flushes all keys from all databases. get [jvm]abstract operator fun get(key: String): ByteString?Retrieves the value for the given key as a ByteString. getDel [jvm]abstract fun getDel(key: String): ByteString?Retrieves the value for the given key as a ByteString and deletes the key. hdel [jvm]abstract fun hdel(key: String, vararg fields: String): LongDelete one or more hash fields stored at key. Specified fields that do not exist are ignored. hget [jvm]abstract fun hget(key: String, field: String): ByteString?Retrieves the value for the given key and field as a ByteString. hgetAll [jvm]abstract fun hgetAll(key: String): Map<String, ByteString>?Retrieves all the fields and associated values for the given key. Returns null if nothing found. hincrBy [jvm]abstract fun hincrBy(key: String, field: String, increment: Long): LongIncrements the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed. hlen [jvm]abstract fun hlen(key: String): LongReturns the number of fields contained in the hash stored at key. hmget [jvm]abstract fun hmget(key: String, vararg fields: String): List<ByteString?>Retrieve the values associated to the specified fields. hrandField [jvm]abstract fun hrandField(key: String, count: Long): List<String>Like hrandFieldWithValues but only returns the fields of the hash stored at key. hrandFieldWithValues [jvm]abstract fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?Randomly selects count fields and values from the hash stored at key. hset [jvm]abstract fun hset(key: String, hash: Map<String, ByteString>): LongSets the ByteString values for the given key and fields[jvm]abstract fun hset(key: String, field: String, value: ByteString): LongSets the ByteString value for the given key and field incr [jvm]abstract fun incr(key: String): LongIncrements the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. incrBy [jvm]abstract fun incrBy(key: String, increment: Long): LongIncrements the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. lmove [jvm]abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination. lpop [jvm]abstract fun lpop(key: String): ByteString?Removes and returns the first element of the list stored at key.[jvm]abstract fun lpop(key: String, count: Int): List<ByteString?>Removes and returns the first count elements of the list stored at key. lpush [jvm]abstract fun lpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. lrange [jvm]abstract fun lrange(key: String, start: Long, stop: Long): List<ByteString?>Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on. lrem [jvm]abstract fun lrem(key: String, count: Long, element: ByteString): LongRemoves the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list. mget [jvm]abstract fun mget(vararg keys: String): List<ByteString?>Retrieves the values for the given list of keys. mset [jvm]abstract fun mset(vararg keyValues: ByteString)Sets the key value pairs. multi [jvm]abstract fun multi(): TransactionMarks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC. pExpire [jvm]abstract fun pExpire(key: String, milliseconds: Long): BooleanThis command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds. pExpireAt [jvm]abstract fun pExpireAt(key: String, timestampMilliseconds: Long): BooleanpExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds. pipelining [jvm]abstract fun pipelining(block: DeferredRedis.() -> Unit)Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations. publish [jvm]abstract fun publish(channel: String, message: String)Publish a message to a channel. rpop [jvm]abstract fun rpop(key: String): ByteString?Removes and returns the last element of the list stored at key.[jvm]abstract fun rpop(key: String, count: Int): List<ByteString?>Removes and returns the last count elements of the list stored at key. rpoplpush [jvm]abstract fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination. rpush [jvm]abstract fun rpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. scan [jvm]abstract fun scan(cursor: String, matchPattern: String? = null, count: Int? = null): Redis.ScanResultPerforms a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through. set [jvm]abstract operator fun set(key: String, value: ByteString)Sets the ByteString value for the given key.[jvm]abstract operator fun set(key: String, expiryDuration: Duration, value: ByteString)Sets the ByteString value for a key with an expiration date. setnx [jvm]abstract fun setnx(key: String, value: ByteString): Booleanabstract fun setnx(key: String, expiryDuration: Duration, value: ByteString): BooleanSets the ByteString value for the given key if it does not already exist. subscribe [jvm]abstract fun subscribe(jedisPubSub: JedisPubSub, channel: String)Subscribe to a redis channel via pubsub. This is blocking! unwatch [jvm]abstract fun unwatch(vararg keys: String)Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH. watch [jvm]abstract fun watch(vararg keys: String)Marks the given keys to be watched for conditional execution of a transaction. zadd [jvm]abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): LongAdds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.[jvm]abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): LongAdds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering. zcard [jvm]abstract fun zcard(key: String): LongReturns the sorted set cardinality (number of elements) of the sorted set stored at key zrange [jvm]abstract fun zrange(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<ByteString?>Returns the specified range of elements in the sorted set stored at key. zrangeWithScores [jvm]abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<Pair<ByteString?, Double>>This is similar to zrange but returns the scores along with the members. zremRangeByRank [jvm]abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): LongRemoves all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth. zscore [jvm]abstract fun zscore(key: String, member: String): Double?Returns the score of member in the sorted set at key."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/blmove/","title":"blmove - Misk","text":"//misk-redis/misk.redis/Redis/blmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/blmove/#blmove","title":"blmove","text":"[jvm]\\ abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?
blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely.
This command comes in place of the now deprecated brpoplpush. Doing BLMOVE RIGHT LEFT is equivalent.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See lmove for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/brpoplpush/","title":"brpoplpush - Misk","text":"//misk-redis/misk.redis/Redis/brpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/brpoplpush/#brpoplpush","title":"brpoplpush","text":"[jvm]\\ abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?
brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See rpoplpush for more information.
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by blmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/close/","title":"close - Misk","text":"//misk-redis/misk.redis/Redis/close
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/close/#close","title":"close","text":"[jvm]\\ abstract fun close()
Closes the client, so it may not be used further.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/","title":"del - Misk","text":"//misk-redis/misk.redis/Redis/del
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#del","title":"del","text":"[jvm]\\ abstract fun del(key: String): Boolean
Deletes a single key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#return","title":"Return","text":"false if the key was not deleted, true if the key was deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#parameters","title":"Parameters","text":"jvm
key the key to delete[jvm]\\ abstract fun del(vararg keys: String): Int
Deletes multiple keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#return_1","title":"Return","text":"0 if none of the keys were deleted, otherwise a positive integer representing the number of keys that were deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#parameters_1","title":"Parameters","text":"jvm
keys the keys to delete"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire-at/","title":"expireAt - Misk","text":"//misk-redis/misk.redis/Redis/expireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire-at/#expireat","title":"expireAt","text":"[jvm]\\ abstract fun expireAt(key: String, timestampSeconds: Long): Boolean
expireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately.
Please for the specific semantics of the command refer to the documentation of expire.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire/","title":"expire - Misk","text":"//misk-redis/misk.redis/Redis/expire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire/#expire","title":"expire","text":"[jvm]\\ abstract fun expire(key: String, seconds: Long): Boolean
Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology.
The timeout will only be cleared by commands that delete or overwrite the contents of the key, including del, set, GETSET and all the *STORE commands. This means that all the operations that conceptually alter the value stored at the key without replacing it with a new one will leave the timeout untouched. For instance, incrementing the value of a key with incr, pushing a new value into a list with LPUSH, or altering the field value of a hash with hset are all operations that will leave the timeout untouched.
The timeout can also be cleared, turning the key back into a persistent key, using the PERSIST command.
If a key is renamed with RENAME, the associated time to live is transferred to the new key name.
If a key is overwritten by RENAME, like in the case of an existing key Key_A that is overwritten by a call like RENAME Key_B Key_A, it does not matter if the original Key_A had a timeout associated or not, the new key Key_A will inherit all the characteristics of Key_B.
Note that calling expire/pExpire with a non-positive timeout or expireAt/pExpireAt with a time in the past will result in the key being deleted rather than expired (accordingly, the emitted key event will be del, not expired).
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/flush-all/","title":"flushAll - Misk","text":"//misk-redis/misk.redis/Redis/flushAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/flush-all/#flushall","title":"flushAll","text":"[jvm]\\ abstract fun flushAll()
Flushes all keys from all databases.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/","title":"getDel - Misk","text":"//misk-redis/misk.redis/Redis/getDel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/#getdel","title":"getDel","text":"[jvm]\\ abstract fun getDel(key: String): ByteString?
Retrieves the value for the given key as a ByteString and deletes the key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/","title":"get - Misk","text":"//misk-redis/misk.redis/Redis/get
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/#get","title":"get","text":"[jvm]\\ abstract operator fun get(key: String): ByteString?
Retrieves the value for the given key as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hdel/","title":"hdel - Misk","text":"//misk-redis/misk.redis/Redis/hdel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hdel/#hdel","title":"hdel","text":"[jvm]\\ abstract fun hdel(key: String, vararg fields: String): Long
Delete one or more hash fields stored at key. Specified fields that do not exist are ignored.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hdel/#return","title":"Return","text":"The number of fields that were removed from the hash. If the key does not exist, it is treated as an empty hash and 0 is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/","title":"hgetAll - Misk","text":"//misk-redis/misk.redis/Redis/hgetAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/#hgetall","title":"hgetAll","text":"[jvm]\\ abstract fun hgetAll(key: String): Map<String, ByteString>?
Retrieves all the fields and associated values for the given key. Returns null if nothing found.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/#return","title":"Return","text":"a Map of the fields to their associated values"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/#parameters","title":"Parameters","text":"
jvm
key the key"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/","title":"hget - Misk","text":"//misk-redis/misk.redis/Redis/hget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/#hget","title":"hget","text":"[jvm]\\ abstract fun hget(key: String, field: String): ByteString?
Retrieves the value for the given key and field as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/#return","title":"Return","text":"a ByteString if the key/field combination was found, null if not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/#parameters","title":"Parameters","text":"jvm
key the key field the field"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/","title":"hincrBy - Misk","text":"//misk-redis/misk.redis/Redis/hincrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/#hincrby","title":"hincrBy","text":"[jvm]\\ abstract fun hincrBy(key: String, field: String, increment: Long): Long
Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/#return","title":"Return","text":"the value at field after the increment operation.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/#parameters","title":"Parameters","text":"jvm
key the key. field the field."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hlen/","title":"hlen - Misk","text":"//misk-redis/misk.redis/Redis/hlen
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hlen/#hlen","title":"hlen","text":"[jvm]\\ abstract fun hlen(key: String): Long
Returns the number of fields contained in the hash stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/","title":"hmget - Misk","text":"//misk-redis/misk.redis/Redis/hmget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/#hmget","title":"hmget","text":"[jvm]\\ abstract fun hmget(key: String, vararg fields: String): List<ByteString?>
Retrieve the values associated to the specified fields.
If some specified fields do not exist, nil values are returned. Non-existing keys are considered like empty hashes.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/#return","title":"Return","text":"a List of the values for the specific fields requested, in the same order of the request. Null for missing fields"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/#parameters","title":"Parameters","text":"
jvm
key the key fields the specific fields to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field-with-values/","title":"hrandFieldWithValues - Misk","text":"//misk-redis/misk.redis/Redis/hrandFieldWithValues
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field-with-values/#hrandfieldwithvalues","title":"hrandFieldWithValues","text":"[jvm]\\ abstract fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?
Randomly selects count fields and values from the hash stored at key.
NB: Implementations using Jedis 4 or seeking to emulate Jedis should use checkHrandFieldCount to avoid surprising behaviour like retrieving a result map which is smaller than requested by a completely random factor.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field/","title":"hrandField - Misk","text":"//misk-redis/misk.redis/Redis/hrandField
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field/#hrandfield","title":"hrandField","text":"[jvm]\\ abstract fun hrandField(key: String, count: Long): List<String>
Like hrandFieldWithValues but only returns the fields of the hash stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/","title":"hset - Misk","text":"//misk-redis/misk.redis/Redis/hset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#hset","title":"hset","text":"[jvm]\\ abstract fun hset(key: String, field: String, value: ByteString): Long
Sets the ByteString value for the given key and field
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#return","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#parameters","title":"Parameters","text":"jvm
key the key field the field value the value to set[jvm]\\ abstract fun hset(key: String, hash: Map<String, ByteString>): Long
Sets the ByteString values for the given key and fields
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#return_1","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#parameters_1","title":"Parameters","text":"jvm
key the key hash the map of fields to ByteString value"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr-by/","title":"incrBy - Misk","text":"//misk-redis/misk.redis/Redis/incrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr-by/#incrby","title":"incrBy","text":"[jvm]\\ abstract fun incrBy(key: String, increment: Long): Long
Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
See incr for extra information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr/","title":"incr - Misk","text":"//misk-redis/misk.redis/Redis/incr
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr/#incr","title":"incr","text":"[jvm]\\ abstract fun incr(key: String): Long
Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
Note: this is a string operation because Redis does not have a dedicated integer type. The string stored at the key is interpreted as a base-10 64 bit signed integer to execute the operation.
Redis stores integers in their integer representation, so for string values that actually hold an integer, there is no overhead for storing the string representation of the integer.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lmove/","title":"lmove - Misk","text":"//misk-redis/misk.redis/Redis/lmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lmove/#lmove","title":"lmove","text":"[jvm]\\ abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?
Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing LMOVE source destination RIGHT LEFT results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the first/last element from the list and pushing it as first/last element of the list, so it can be considered as a list rotation command (or a no-op if from is the same as to).
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
This command comes in place of the now deprecated RPOPLPUSH. Doing LMOVE RIGHT LEFT is equivalent.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpop/","title":"lpop - Misk","text":"//misk-redis/misk.redis/Redis/lpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpop/#lpop","title":"lpop","text":"[jvm]\\ abstract fun lpop(key: String, count: Int): List<ByteString?>
Removes and returns the first count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ abstract fun lpop(key: String): ByteString?
Removes and returns the first element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpush/","title":"lpush - Misk","text":"//misk-redis/misk.redis/Redis/lpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpush/#lpush","title":"lpush","text":"[jvm]\\ abstract fun lpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
//misk-redis/misk.redis/Redis/lrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lrange/#lrange","title":"lrange","text":"[jvm]\\ abstract fun lrange(key: String, start: Long, stop: Long): List<ByteString?>
Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.
These offsets can also be negative numbers indicating offsets starting at the end of the list. For example, -1 is the last element of the list, -2 the penultimate, and so on.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lrem/","title":"lrem - Misk","text":"//misk-redis/misk.redis/Redis/lrem
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lrem/#lrem","title":"lrem","text":"[jvm]\\ abstract fun lrem(key: String, count: Long, element: ByteString): Long
Removes the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list.
Note that non-existing keys are treated like empty lists, so when key does not exist, the command will always return 0.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/","title":"mget - Misk","text":"//misk-redis/misk.redis/Redis/mget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/#mget","title":"mget","text":"[jvm]\\ abstract fun mget(vararg keys: String): List<ByteString?>
Retrieves the values for the given list of keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/#return","title":"Return","text":"a list of String in the same order as the specified list of keys. For each key, a value will be returned if a key was found, otherwise null is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/#parameters","title":"Parameters","text":"jvm
keys the keys to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mset/","title":"mset - Misk","text":"//misk-redis/misk.redis/Redis/mset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mset/#mset","title":"mset","text":"[jvm]\\ abstract fun mset(vararg keyValues: ByteString)
Sets the key value pairs.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mset/#parameters","title":"Parameters","text":"jvm
keyValues the list of keys and values in alternating order."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/multi/","title":"multi - Misk","text":"//misk-redis/misk.redis/Redis/multi
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/multi/#multi","title":"multi","text":"[jvm]\\ abstract fun multi(): Transaction
Marks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire-at/","title":"pExpireAt - Misk","text":"//misk-redis/misk.redis/Redis/pExpireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire-at/#pexpireat","title":"pExpireAt","text":"[jvm]\\ abstract fun pExpireAt(key: String, timestampMilliseconds: Long): Boolean
pExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire/","title":"pExpire - Misk","text":"//misk-redis/misk.redis/Redis/pExpire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire/#pexpire","title":"pExpire","text":"[jvm]\\ abstract fun pExpire(key: String, milliseconds: Long): Boolean
This command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/pipelining/","title":"pipelining - Misk","text":"//misk-redis/misk.redis/Redis/pipelining
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/pipelining/#pipelining","title":"pipelining","text":"[jvm]\\ abstract fun pipelining(block: DeferredRedis.() -> Unit)
Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations.
See Redis pipelining for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/publish/","title":"publish - Misk","text":"//misk-redis/misk.redis/Redis/publish
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/publish/#publish","title":"publish","text":"[jvm]\\ abstract fun publish(channel: String, message: String)
Publish a message to a channel.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpop/","title":"rpop - Misk","text":"//misk-redis/misk.redis/Redis/rpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpop/#rpop","title":"rpop","text":"[jvm]\\ abstract fun rpop(key: String, count: Int): List<ByteString?>
Removes and returns the last count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ abstract fun rpop(key: String): ByteString?
Removes and returns the last element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpoplpush/","title":"rpoplpush - Misk","text":"//misk-redis/misk.redis/Redis/rpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpoplpush/#rpoplpush","title":"rpoplpush","text":"[jvm]\\ abstract fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?
Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing rpoplpush results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the last element from the list and pushing it as first element of the list, so it can be considered as a list rotation command.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by lmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpush/","title":"rpush - Misk","text":"//misk-redis/misk.redis/Redis/rpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpush/#rpush","title":"rpush","text":"[jvm]\\ abstract fun rpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
//misk-redis/misk.redis/Redis/scan
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/scan/#scan","title":"scan","text":"[jvm]\\ abstract fun scan(cursor: String, matchPattern: String? = null, count: Int? = null): Redis.ScanResult
Performs a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/scan/#return","title":"Return","text":"A ScanResult containing the next cursor and the current batch of keys. If the returned cursor is \"0\", then there are no more keys left in the iteration.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/scan/#parameters","title":"Parameters","text":"jvm
cursor The scan cursor. This should first be \"0\". Then subsequent cursor values will be taken from the returned ScanResults. matchPattern A glob-like match pattern to filter keys by. If this is not provided, then all keys will be scanned. count A hinted desired batch size to be returned in each ScanResult. Note that this is just a hint and there are no guarantees on the actual size of each ScanResult."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/","title":"set - Misk","text":"//misk-redis/misk.redis/Redis/set
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/#set","title":"set","text":"[jvm]\\ abstract operator fun set(key: String, value: ByteString)
Sets the ByteString value for the given key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ abstract operator fun set(key: String, expiryDuration: Duration, value: ByteString)
Sets the ByteString value for a key with an expiration date.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/","title":"setnx - Misk","text":"//misk-redis/misk.redis/Redis/setnx
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/#setnx","title":"setnx","text":"[jvm]\\ abstract fun setnx(key: String, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ abstract fun setnx(key: String, expiryDuration: Duration, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/subscribe/","title":"subscribe - Misk","text":"//misk-redis/misk.redis/Redis/subscribe
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ abstract fun subscribe(jedisPubSub: JedisPubSub, channel: String)
Subscribe to a redis channel via pubsub. This is blocking!
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/unwatch/","title":"unwatch - Misk","text":"//misk-redis/misk.redis/Redis/unwatch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ abstract fun unwatch(vararg keys: String)
Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/watch/","title":"watch - Misk","text":"//misk-redis/misk.redis/Redis/watch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/watch/#watch","title":"watch","text":"[jvm]\\ abstract fun watch(vararg keys: String)
Marks the given keys to be watched for conditional execution of a transaction.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zadd/","title":"zadd - Misk","text":"//misk-redis/misk.redis/Redis/zadd
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zadd/#zadd","title":"zadd","text":"[jvm]\\ abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Long
Adds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions.
[jvm]\\ abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Long
Adds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zcard/","title":"zcard - Misk","text":"//misk-redis/misk.redis/Redis/zcard
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zcard/#zcard","title":"zcard","text":"[jvm]\\ abstract fun zcard(key: String): Long
Returns the sorted set cardinality (number of elements) of the sorted set stored at key
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange-with-scores/","title":"zrangeWithScores - Misk","text":"//misk-redis/misk.redis/Redis/zrangeWithScores
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange-with-scores/#zrangewithscores","title":"zrangeWithScores","text":"[jvm]\\ abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<Pair<ByteString?, Double>>
This is similar to zrange but returns the scores along with the members.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange/","title":"zrange - Misk","text":"//misk-redis/misk.redis/Redis/zrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange/#zrange","title":"zrange","text":"[jvm]\\ abstract fun zrange(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<ByteString?>
Returns the specified range of elements in the sorted set stored at key.
ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order. Currently only index and score type range queries are supported. See ZRangeType for different types of range queries.
You can specify the start and stop of the range you want to filter by. Depending on the type you will have to use the appropriate type of ZRangeMarker.
The order of elements is from the lowest to the highest score. Elements with the same score are ordered lexicographically.
Setting reverse reverses the ordering, so elements are ordered from highest to lowest score, and score ties are resolved by reverse lexicographical ordering.
The limit argument can be used to obtain a sub-range from the matching elements. See ZRangeLimit for more info.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrem-range-by-rank/","title":"zremRangeByRank - Misk","text":"//misk-redis/misk.redis/Redis/zremRangeByRank
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrem-range-by-rank/#zremrangebyrank","title":"zremRangeByRank","text":"[jvm]\\ abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Long
Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zscore/","title":"zscore - Misk","text":"//misk-redis/misk.redis/Redis/zscore
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zscore/#zscore","title":"zscore","text":"[jvm]\\ abstract fun zscore(key: String, member: String): Double?
Returns the score of member in the sorted set at key.
If member does not exist in the sorted set, or key does not exist, nil is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/","title":"ScanResult - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/#scanresult","title":"ScanResult","text":"[jvm]\\ data class ScanResult(val cursor: String, val keys: List<String>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/#constructors","title":"Constructors","text":"ScanResult [jvm]constructor(cursor: String, keys: List<String>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/#properties","title":"Properties","text":"Name Summary cursor [jvm]val cursor: String keys [jvm]val keys: List<String>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/-scan-result/","title":"ScanResult - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult/ScanResult
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/-scan-result/#scanresult","title":"ScanResult","text":"[jvm]\\ constructor(cursor: String, keys: List<String>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/cursor/","title":"cursor - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult/cursor
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/cursor/#cursor","title":"cursor","text":"[jvm]\\ val cursor: String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/keys/","title":"keys - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult/keys
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/keys/#keys","title":"keys","text":"[jvm]\\ val keys: List<String>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/","title":"ZAddOptions - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#zaddoptions","title":"ZAddOptions","text":"[jvm]\\ enum ZAddOptions : Enum<Redis.ZAddOptions>
Options for ZADD. Not all options are compatible with one another. See the ZADD command documentation for more information.
Note: misk-redis does not currently support the INCR option.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#entries","title":"Entries","text":"XX [jvm]XXOnly update elements that already exist. Don\u2019t add new elements. NX [jvm]NXOnly add new elements. Don\u2019t update already existing elements. LT [jvm]LTOnly update existing elements if the new score is less than the current score. This flag doesn\u2019t prevent adding new elements. GT [jvm]GTOnly update existing elements if the new score is greater than the current score. This flag doesn\u2019t prevent adding new elements. CH [jvm]CHModify the return value from the number of new elements added, to the total number of elements changed (CH is an abbreviation of changed). Changed elements are new elements added and elements already existing for which the score was updated. So elements specified in the command line having the same score as they had in the past are not counted. Note: normally the return value of ZADD only counts the number of new elements added."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Redis.ZAddOptions>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): Redis.ZAddOptionsReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Redis.ZAddOptions>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/entries/","title":"entries - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/entries
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Redis.ZAddOptions>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/value-of/","title":"valueOf - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/valueOf
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Redis.ZAddOptions
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/values/","title":"values - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/values
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Redis.ZAddOptions>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-c-h/","title":"CH - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/CH
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-c-h/#ch","title":"CH","text":"[jvm]\\ CH
Modify the return value from the number of new elements added, to the total number of elements changed (CH is an abbreviation of changed). Changed elements are new elements added and elements already existing for which the score was updated. So elements specified in the command line having the same score as they had in the past are not counted. Note: normally the return value of ZADD only counts the number of new elements added.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-c-h/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/","title":"Companion - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/#functions","title":"Functions","text":"Name Summary getZAddParams [jvm]fun getZAddParams(options: Array<out Redis.ZAddOptions>): ZAddParams"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/get-z-add-params/","title":"getZAddParams - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/Companion/getZAddParams
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/get-z-add-params/#getzaddparams","title":"getZAddParams","text":"[jvm]\\ fun getZAddParams(options: Array<out Redis.ZAddOptions>): ZAddParams
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-g-t/","title":"GT - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/GT
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-g-t/#gt","title":"GT","text":"[jvm]\\ GT
Only update existing elements if the new score is greater than the current score. This flag doesn\u2019t prevent adding new elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-g-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-l-t/","title":"LT - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/LT
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-l-t/#lt","title":"LT","text":"[jvm]\\ LT
Only update existing elements if the new score is less than the current score. This flag doesn\u2019t prevent adding new elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-l-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-n-x/","title":"NX - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/NX
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-n-x/#nx","title":"NX","text":"[jvm]\\ NX
Only add new elements. Don\u2019t update already existing elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-n-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-x-x/","title":"XX - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/XX
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-x-x/#xx","title":"XX","text":"[jvm]\\ XX
Only update elements that already exist. Don\u2019t add new elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-x-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/","title":"ZRangeIndexMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeIndexMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/#zrangeindexmarker","title":"ZRangeIndexMarker","text":"[jvm]\\ data class ZRangeIndexMarker(val intValue: Int) : Redis.ZRangeMarker
To be used when ZRangeType is ZRangeType.INDEX. The intValue should be an integer specifying the index (start or stop)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/#constructors","title":"Constructors","text":"ZRangeIndexMarker [jvm]constructor(intValue: Int)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/#properties","title":"Properties","text":"Name Summary included [jvm]val included: Boolean intValue [jvm]val intValue: Int value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/-z-range-index-marker/","title":"ZRangeIndexMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeIndexMarker/ZRangeIndexMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/-z-range-index-marker/#zrangeindexmarker","title":"ZRangeIndexMarker","text":"[jvm]\\ constructor(intValue: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/int-value/","title":"intValue - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeIndexMarker/intValue
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/int-value/#intvalue","title":"intValue","text":"[jvm]\\ val intValue: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/","title":"ZRangeLimit - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeLimit
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/#zrangelimit","title":"ZRangeLimit","text":"[jvm]\\ data class ZRangeLimit(val offset: Int, val count: Int)
The limit argument in zrange and zrangeWithScores can be used to obtain a sub-range from the matching elements similar to SELECT LIMIT offset, count in SQL. A negative count returns all elements from the offset. Keep in mind that if is large, the sorted set needs to be traversed for elements before getting to the elements to return, which can add up to O(N) time complexity."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/#constructors","title":"Constructors","text":"ZRangeLimit [jvm]constructor(offset: Int, count: Int)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/#properties","title":"Properties","text":"Name Summary count [jvm]val count: Int offset [jvm]val offset: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/-z-range-limit/","title":"ZRangeLimit - Misk","text":"
//misk-redis/misk.redis/Redis/ZRangeLimit/ZRangeLimit
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/-z-range-limit/#zrangelimit","title":"ZRangeLimit","text":"[jvm]\\ constructor(offset: Int, count: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/count/","title":"count - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeLimit/count
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/count/#count","title":"count","text":"[jvm]\\ val count: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/offset/","title":"offset - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeLimit/offset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/offset/#offset","title":"offset","text":"[jvm]\\ val offset: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/","title":"ZRangeMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#zrangemarker","title":"ZRangeMarker","text":"abstract class ZRangeMarker(val value: Any, val included: Boolean)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#inheritors","title":"Inheritors","text":"ZRangeRankMarker ZRangeIndexMarker ZRangeScoreMarker"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#constructors","title":"Constructors","text":"ZRangeMarker [jvm]constructor(value: Any, included: Boolean)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#properties","title":"Properties","text":"Name Summary included [jvm]val included: Boolean value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/-z-range-marker/","title":"ZRangeMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker/ZRangeMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/-z-range-marker/#zrangemarker","title":"ZRangeMarker","text":"[jvm]\\ constructor(value: Any, included: Boolean)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/included/","title":"included - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker/included
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/included/#included","title":"included","text":"[jvm]\\ val included: Boolean
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/value/","title":"value - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker/value
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/value/#value","title":"value","text":"[jvm]\\ val value: Any
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/","title":"ZRangeRankMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeRankMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/#zrangerankmarker","title":"ZRangeRankMarker","text":"[jvm]\\ data class ZRangeRankMarker(val longValue: Long) : Redis.ZRangeMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/#constructors","title":"Constructors","text":"ZRangeRankMarker [jvm]constructor(longValue: Long)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/#properties","title":"Properties","text":"Name Summary included [jvm]val included: Boolean longValue [jvm]val longValue: Long value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/-z-range-rank-marker/","title":"ZRangeRankMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeRankMarker/ZRangeRankMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/-z-range-rank-marker/#zrangerankmarker","title":"ZRangeRankMarker","text":"[jvm]\\ constructor(longValue: Long)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/long-value/","title":"longValue - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeRankMarker/longValue
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/long-value/#longvalue","title":"longValue","text":"[jvm]\\ val longValue: Long
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/","title":"ZRangeScoreMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#zrangescoremarker","title":"ZRangeScoreMarker","text":"[jvm]\\ data class ZRangeScoreMarker@JvmOverloadsconstructor(val doubleValue: Double, val isIncluded: Boolean = true) : Redis.ZRangeMarker
To be used when ZRangeType is ZRangeType.SCORE. The doubleValue should be a double specifying the score (start or stop) By default the range is included. Set isIncluded to false in order to exclude the start or stop.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#constructors","title":"Constructors","text":"ZRangeScoreMarker [jvm]@JvmOverloadsconstructor(doubleValue: Double, isIncluded: Boolean = true)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#properties","title":"Properties","text":"Name Summary doubleValue [jvm]val doubleValue: Double included [jvm]val included: Boolean isIncluded [jvm]val isIncluded: Boolean = true value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/-z-range-score-marker/","title":"ZRangeScoreMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/ZRangeScoreMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/-z-range-score-marker/#zrangescoremarker","title":"ZRangeScoreMarker","text":"[jvm]\\
@JvmOverloads
constructor(doubleValue: Double, isIncluded: Boolean = true)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/double-value/","title":"doubleValue - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/doubleValue
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/double-value/#doublevalue","title":"doubleValue","text":"[jvm]\\ val doubleValue: Double
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/is-included/","title":"isIncluded - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/isIncluded
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/is-included/#isincluded","title":"isIncluded","text":"[jvm]\\ val isIncluded: Boolean = true
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/to-string/","title":"toString - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/toString
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/","title":"ZRangeType - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#zrangetype","title":"ZRangeType","text":"[jvm]\\ enum ZRangeType : Enum<Redis.ZRangeType>
Different types of range queries.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#entries","title":"Entries","text":"INDEX [jvm]INDEXThe and arguments represent zero-based indexes. These arguments specify an inclusive range. SCORE [jvm]SCOREreturns the range of elements from the sorted set having scores equal or between and"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Redis.ZRangeType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): Redis.ZRangeTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Redis.ZRangeType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/entries/","title":"entries - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/entries
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Redis.ZRangeType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/value-of/","title":"valueOf - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/valueOf
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Redis.ZRangeType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/values/","title":"values - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/values
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Redis.ZRangeType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-i-n-d-e-x/","title":"INDEX - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/INDEX
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-i-n-d-e-x/#index","title":"INDEX","text":"[jvm]\\ INDEX
The and arguments represent zero-based indexes. These arguments specify an inclusive range.
The indexes can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set and so on.
Out of range indexes do not produce an error. If is greater than either the end index of the sorted set or , an empty list is returned. If is greater than the end index of the sorted set, Redis will use the last element of the sorted set.
Use ZRangeIndexMarker to specify the start and stop for this type.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-i-n-d-e-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-s-c-o-r-e/","title":"SCORE - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/SCORE
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-s-c-o-r-e/#score","title":"SCORE","text":"[jvm]\\ SCORE
returns the range of elements from the sorted set having scores equal or between and
and can be -inf and +inf, denoting the negative and positive infinities, respectively. This means that you are not required to know the highest or lowest score in the sorted set to get all elements from or up to a certain score.
By default, the score intervals specified by and are closed (inclusive). It is possible to specify an open interval.
Use ZRangeScoreMarker to specify the start and stop for this type.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-s-c-o-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/","title":"RedisClientMetrics - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#redisclientmetrics","title":"RedisClientMetrics","text":"[jvm]\\ @Singleton
class RedisClientMetrics@Injectconstructor(ticker: Ticker, metrics: Metrics)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#constructors","title":"Constructors","text":"RedisClientMetrics [jvm]@Injectconstructor(ticker: Ticker, metrics: Metrics)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#functions","title":"Functions","text":"Name Summary timed [jvm]fun <T> timed(commandName: String, block: () -> T): T"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-redis-client-metrics/","title":"RedisClientMetrics - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics/RedisClientMetrics
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-redis-client-metrics/#redisclientmetrics","title":"RedisClientMetrics","text":"[jvm]\\
@Inject
constructor(ticker: Ticker, metrics: Metrics)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/timed/","title":"timed - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics/timed
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/timed/#timed","title":"timed","text":"[jvm]\\ fun <T> timed(commandName: String, block: () -> T): T
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-companion/","title":"Companion - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics/Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/","title":"RedisClusterConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#redisclusterconfig","title":"RedisClusterConfig","text":"[jvm]\\ class RedisClusterConfig : LinkedHashMap<String, RedisClusterReplicationGroupConfig> , Config
Top-level configuration element for all redis clusters
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#constructors","title":"Constructors","text":"RedisClusterConfig [jvm]constructor()constructor(m: Map<String, RedisClusterReplicationGroupConfig>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#properties","title":"Properties","text":"Name Summary entries [jvm]open override val entries: MutableSet<MutableMap.MutableEntry<String, RedisClusterReplicationGroupConfig>> keys [jvm]open override val keys: MutableSet<String> size [jvm]open override val size: Int values [jvm]open override val values: MutableCollection<RedisClusterReplicationGroupConfig>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() clone [jvm]open override fun clone(): Any compute [jvm]open override fun compute(p0: String, p1: BiFunction<in String, in RedisClusterReplicationGroupConfig?, out RedisClusterReplicationGroupConfig?>): RedisClusterReplicationGroupConfig? computeIfAbsent [jvm]open override fun computeIfAbsent(p0: String, p1: Function<in String, out RedisClusterReplicationGroupConfig>): RedisClusterReplicationGroupConfig computeIfPresent [jvm]open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in RedisClusterReplicationGroupConfig, out RedisClusterReplicationGroupConfig?>): RedisClusterReplicationGroupConfig? containsKey [jvm]open override fun containsKey(key: String): Boolean containsValue [jvm]open override fun containsValue(value: RedisClusterReplicationGroupConfig): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean forEach [jvm]open override fun forEach(p0: BiConsumer<in String, in RedisClusterReplicationGroupConfig>) get [jvm]open operator override fun get(key: String): RedisClusterReplicationGroupConfig? getOrDefault [jvm]open override fun getOrDefault(key: String, defaultValue: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig hashCode [jvm]open override fun hashCode(): Int isEmpty [jvm]open override fun isEmpty(): Boolean merge [jvm]open override fun merge(p0: String, p1: RedisClusterReplicationGroupConfig, p2: BiFunction<in RedisClusterReplicationGroupConfig, in RedisClusterReplicationGroupConfig, out RedisClusterReplicationGroupConfig?>): RedisClusterReplicationGroupConfig? put [jvm]open override fun put(key: String, value: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig? putAll [jvm]open override fun putAll(from: Map<out String, RedisClusterReplicationGroupConfig>) putIfAbsent [jvm]open override fun putIfAbsent(p0: String, p1: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig? remove [jvm]open override fun remove(key: String): RedisClusterReplicationGroupConfig?open override fun remove(key: String, value: RedisClusterReplicationGroupConfig): Boolean replace [jvm]open override fun replace(p0: String, p1: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig?open override fun replace(p0: String, p1: RedisClusterReplicationGroupConfig, p2: RedisClusterReplicationGroupConfig): Boolean replaceAll [jvm]open override fun replaceAll(p0: BiFunction<in String, in RedisClusterReplicationGroupConfig, out RedisClusterReplicationGroupConfig>) toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/-redis-cluster-config/","title":"RedisClusterConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterConfig/RedisClusterConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/-redis-cluster-config/#redisclusterconfig","title":"RedisClusterConfig","text":"[jvm]\\ constructor()
constructor(m: Map<String, RedisClusterReplicationGroupConfig>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/","title":"RedisClusterModule - Misk","text":"//misk-redis/misk.redis/RedisClusterModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/#redisclustermodule","title":"RedisClusterModule","text":"[jvm]\\ class RedisClusterModule@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModule
Configures a Redis client that interacts with a Redis cluster. This also installs a ServiceModule for RedisService.
To use this, install a RedisClusterModule and add a corresponding RedisClusterConfig to your application\u2019s config YAML.
If other services require a working client connection to Redis before they can be used, specify a dependency like:
install(ServiceModule<MyService>()\n .dependsOn(keyOf<RedisService>())\n)\nredisClusterConfig: Only one replication group config is supported; this module will use the first configuration it finds. An empty RedisReplicationGroupConfig.redis_auth_password is only permitted in fake environments. See Deployment.
This initiates a JedisCluster which automatically discovers the topology of the Redis cluster, and routes commands to the appropriate node based on the hash slot of the key.
Note: This has some limitations regarding multi-key operations that involve keys belonging to different slots. Some unsupported functions in JedisCluster were addressed in this custom wrapper (e.g. mset, mget and del) but not the atomic operations such as rpoplpush, lmove, brpoplpush etc. as it is not recommended. For more information, refer to the following links:
https://redis.io/docs/reference/cluster-spec/ https://redis.com/blog/redis-clustering-best-practices-with-keys/
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/#constructors","title":"Constructors","text":"RedisClusterModule [jvm]@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/-redis-cluster-module/","title":"RedisClusterModule - Misk","text":"//misk-redis/misk.redis/RedisClusterModule/RedisClusterModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/-redis-cluster-module/#redisclustermodule","title":"RedisClusterModule","text":"[jvm]\\
@JvmOverloads
constructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/","title":"RedisClusterReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/#redisclusterreplicationgroupconfig","title":"RedisClusterReplicationGroupConfig","text":"[jvm]\\ data class RedisClusterReplicationGroupConfig@JvmOverloadsconstructor(val configuration_endpoint: RedisNodeConfig, val client_name: String? = null, val max_attempts: Int = DEFAULT_MAX_ATTEMPTS, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
Configuration element for a Redis Cluster
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/#constructors","title":"Constructors","text":"RedisClusterReplicationGroupConfig [jvm]@JvmOverloadsconstructor(configuration_endpoint: RedisNodeConfig, client_name: String? = null, max_attempts: Int = DEFAULT_MAX_ATTEMPTS, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/#properties","title":"Properties","text":"Name Summary client_name [jvm]val client_name: String? = nullAn optional parameter to identify the client application. configuration_endpoint [jvm]val configuration_endpoint: RedisNodeConfigThe endpoint of a node in the cluster that can be used to discover the rest of the cluster. max_attempts [jvm]val max_attempts: IntThe maximum number of attempts in case of failure. redis_auth_password [jvm]val redis_auth_password: StringThe password to use for the connection to the cluster. timeout_ms [jvm]val timeout_ms: IntThe connection and socket timeout in milliseconds."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/-redis-cluster-replication-group-config/","title":"RedisClusterReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/RedisClusterReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/-redis-cluster-replication-group-config/#redisclusterreplicationgroupconfig","title":"RedisClusterReplicationGroupConfig","text":"[jvm]\\
@JvmOverloads
constructor(configuration_endpoint: RedisNodeConfig, client_name: String? = null, max_attempts: Int = DEFAULT_MAX_ATTEMPTS, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/client_name/","title":"client_name - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/client_name
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/client_name/#client_name","title":"client_name","text":"[jvm]\\ val client_name: String? = null
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/configuration_endpoint/","title":"configuration_endpoint - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/configuration_endpoint
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/configuration_endpoint/#configuration_endpoint","title":"configuration_endpoint","text":"[jvm]\\ val configuration_endpoint: RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/max_attempts/","title":"max_attempts - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/max_attempts
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/max_attempts/#max_attempts","title":"max_attempts","text":"[jvm]\\ val max_attempts: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/redis_auth_password/","title":"redis_auth_password - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/redis_auth_password
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/redis_auth_password/#redis_auth_password","title":"redis_auth_password","text":"[jvm]\\ val redis_auth_password: String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/timeout_ms/","title":"timeout_ms - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/timeout_ms
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/timeout_ms/#timeout_ms","title":"timeout_ms","text":"[jvm]\\ val timeout_ms: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/","title":"RedisConfig - Misk","text":"//misk-redis/misk.redis/RedisConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#redisconfig","title":"RedisConfig","text":"[jvm]\\ class RedisConfig : LinkedHashMap<String, RedisReplicationGroupConfig> , Config
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#constructors","title":"Constructors","text":"RedisConfig [jvm]constructor()constructor(m: Map<String, RedisReplicationGroupConfig>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#properties","title":"Properties","text":"Name Summary entries [jvm]open override val entries: MutableSet<MutableMap.MutableEntry<String, RedisReplicationGroupConfig>> keys [jvm]open override val keys: MutableSet<String> size [jvm]open override val size: Int values [jvm]open override val values: MutableCollection<RedisReplicationGroupConfig>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() clone [jvm]open override fun clone(): Any compute [jvm]open override fun compute(p0: String, p1: BiFunction<in String, in RedisReplicationGroupConfig?, out RedisReplicationGroupConfig?>): RedisReplicationGroupConfig? computeIfAbsent [jvm]open override fun computeIfAbsent(p0: String, p1: Function<in String, out RedisReplicationGroupConfig>): RedisReplicationGroupConfig computeIfPresent [jvm]open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in RedisReplicationGroupConfig, out RedisReplicationGroupConfig?>): RedisReplicationGroupConfig? containsKey [jvm]open override fun containsKey(key: String): Boolean containsValue [jvm]open override fun containsValue(value: RedisReplicationGroupConfig): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean forEach [jvm]open override fun forEach(p0: BiConsumer<in String, in RedisReplicationGroupConfig>) get [jvm]open operator override fun get(key: String): RedisReplicationGroupConfig? getOrDefault [jvm]open override fun getOrDefault(key: String, defaultValue: RedisReplicationGroupConfig): RedisReplicationGroupConfig hashCode [jvm]open override fun hashCode(): Int isEmpty [jvm]open override fun isEmpty(): Boolean merge [jvm]open override fun merge(p0: String, p1: RedisReplicationGroupConfig, p2: BiFunction<in RedisReplicationGroupConfig, in RedisReplicationGroupConfig, out RedisReplicationGroupConfig?>): RedisReplicationGroupConfig? put [jvm]open override fun put(key: String, value: RedisReplicationGroupConfig): RedisReplicationGroupConfig? putAll [jvm]open override fun putAll(from: Map<out String, RedisReplicationGroupConfig>) putIfAbsent [jvm]open override fun putIfAbsent(p0: String, p1: RedisReplicationGroupConfig): RedisReplicationGroupConfig? remove [jvm]open override fun remove(key: String): RedisReplicationGroupConfig?open override fun remove(key: String, value: RedisReplicationGroupConfig): Boolean replace [jvm]open override fun replace(p0: String, p1: RedisReplicationGroupConfig): RedisReplicationGroupConfig?open override fun replace(p0: String, p1: RedisReplicationGroupConfig, p2: RedisReplicationGroupConfig): Boolean replaceAll [jvm]open override fun replaceAll(p0: BiFunction<in String, in RedisReplicationGroupConfig, out RedisReplicationGroupConfig>) toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/-redis-config/","title":"RedisConfig - Misk","text":"//misk-redis/misk.redis/RedisConfig/RedisConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/-redis-config/#redisconfig","title":"RedisConfig","text":"[jvm]\\ constructor()
constructor(m: Map<String, RedisReplicationGroupConfig>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/","title":"RedisConnectionException - Misk","text":"//misk-redis/misk.redis/RedisConnectionException
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#redisconnectionexception","title":"RedisConnectionException","text":"[jvm]\\ class RedisConnectionException(cluster: String, cause: Throwable) : RuntimeException
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#constructors","title":"Constructors","text":"RedisConnectionException [jvm]constructor(cluster: String, cause: Throwable)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/-redis-connection-exception/","title":"RedisConnectionException - Misk","text":"//misk-redis/misk.redis/RedisConnectionException/RedisConnectionException
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/-redis-connection-exception/#redisconnectionexception","title":"RedisConnectionException","text":"[jvm]\\ constructor(cluster: String, cause: Throwable)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/","title":"RedisModule - Misk","text":"//misk-redis/misk.redis/RedisModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/#redismodule","title":"RedisModule","text":"[jvm]\\ class RedisModule@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModule
Configures a Redis client with metrics, this also installs a ServiceModule for RedisService. If other services require a working client connection to Redis before they can be used, specify a dependency like:
install(ServiceModule<MyService>()\n .dependsOn(keyOf<RedisService>())\n)\nYou must pass in configuration for your Redis client.
redisConfig: Only one replication group config is supported; this module will use the first configuration it finds. An empty RedisReplicationGroupConfig.redis_auth_password is only permitted in fake environments. See Deployment.
connectionPoolConfig: Misk-redis is backed by a JedisPooled, you may not want to use the ConnectionPoolConfig defaults! Be sure to understand them!
See: https://github.com/xetorthio/jedis/wiki/Getting-started#using-jedis-in-a-multithreaded-environment
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/#constructors","title":"Constructors","text":"RedisModule [jvm]@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/-redis-module/","title":"RedisModule - Misk","text":"//misk-redis/misk.redis/RedisModule/RedisModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/-redis-module/#redismodule","title":"RedisModule","text":"[jvm]\\
@JvmOverloads
constructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/","title":"RedisNodeConfig - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/#redisnodeconfig","title":"RedisNodeConfig","text":"[jvm]\\ data class RedisNodeConfig(val hostname: String?, val port: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/#constructors","title":"Constructors","text":"RedisNodeConfig [jvm]constructor(hostname: String?, port: Int)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/#properties","title":"Properties","text":"Name Summary hostname [jvm]val hostname: String? port [jvm]val port: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/-redis-node-config/","title":"RedisNodeConfig - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig/RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/-redis-node-config/#redisnodeconfig","title":"RedisNodeConfig","text":"[jvm]\\ constructor(hostname: String?, port: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/hostname/","title":"hostname - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig/hostname
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/hostname/#hostname","title":"hostname","text":"[jvm]\\ val hostname: String?
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/port/","title":"port - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig/port
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/port/#port","title":"port","text":"[jvm]\\ val port: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/","title":"RedisReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/#redisreplicationgroupconfig","title":"RedisReplicationGroupConfig","text":"[jvm]\\ data class RedisReplicationGroupConfig@JvmOverloadsconstructor(val writer_endpoint: RedisNodeConfig, val reader_endpoint: RedisNodeConfig, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/#constructors","title":"Constructors","text":"RedisReplicationGroupConfig [jvm]@JvmOverloadsconstructor(writer_endpoint: RedisNodeConfig, reader_endpoint: RedisNodeConfig, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/#properties","title":"Properties","text":"Name Summary reader_endpoint [jvm]val reader_endpoint: RedisNodeConfig redis_auth_password [jvm]val redis_auth_password: String timeout_ms [jvm]val timeout_ms: Int writer_endpoint [jvm]val writer_endpoint: RedisNodeConfig"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/-redis-replication-group-config/","title":"RedisReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/RedisReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/-redis-replication-group-config/#redisreplicationgroupconfig","title":"RedisReplicationGroupConfig","text":"[jvm]\\
@JvmOverloads
constructor(writer_endpoint: RedisNodeConfig, reader_endpoint: RedisNodeConfig, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/reader_endpoint/","title":"reader_endpoint - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/reader_endpoint
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/reader_endpoint/#reader_endpoint","title":"reader_endpoint","text":"[jvm]\\ val reader_endpoint: RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/redis_auth_password/","title":"redis_auth_password - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/redis_auth_password
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/redis_auth_password/#redis_auth_password","title":"redis_auth_password","text":"[jvm]\\ val redis_auth_password: String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/timeout_ms/","title":"timeout_ms - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/timeout_ms
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/timeout_ms/#timeout_ms","title":"timeout_ms","text":"[jvm]\\ val timeout_ms: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/writer_endpoint/","title":"writer_endpoint - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/writer_endpoint
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/writer_endpoint/#writer_endpoint","title":"writer_endpoint","text":"[jvm]\\ val writer_endpoint: RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-service/","title":"RedisService - Misk","text":"//misk-redis/misk.redis/RedisService
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-service/#redisservice","title":"RedisService","text":"[jvm]\\ @Singleton
class RedisService : AbstractIdleService
Controls the connection lifecycle for Redis.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-schema-migrator-gradle-plugin/","title":"misk-schema-migrator-gradle-plugin - Misk","text":"//misk-schema-migrator-gradle-plugin
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/#misk-schema-migrator-gradle-plugin","title":"misk-schema-migrator-gradle-plugin","text":""},{"location":"0.x/misk-schema-migrator-gradle-plugin/#packages","title":"Packages","text":"Name misk.gradle.schemamigrator"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/","title":"Package-level declarations - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/#types","title":"Types","text":"Name Summary SchemaMigratorDatabase [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])annotation class SchemaMigratorDatabase SchemaMigratorExtension [jvm]abstract class SchemaMigratorExtension@Injectconstructor(objects: ObjectFactory) SchemaMigratorModule [jvm]class SchemaMigratorModule(database: String, dbType: String, username: String, password: String, schemaDir: File) : KAbstractModule SchemaMigratorPlugin [jvm]class SchemaMigratorPlugin : Plugin<Project> SchemaMigratorTask [jvm]abstract class SchemaMigratorTask : DefaultTask"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-database/","title":"SchemaMigratorDatabase - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorDatabase
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-database/#schemamigratordatabase","title":"SchemaMigratorDatabase","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])
annotation class SchemaMigratorDatabase
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/","title":"SchemaMigratorExtension - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/#schemamigratorextension","title":"SchemaMigratorExtension","text":"[jvm]\\ abstract class SchemaMigratorExtension@Injectconstructor(objects: ObjectFactory)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/#constructors","title":"Constructors","text":"SchemaMigratorExtension [jvm]@Injectconstructor(objects: ObjectFactory)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/#properties","title":"Properties","text":"Name Summary database [jvm]@get:Inputabstract val database: Property<String> databaseType [jvm]@get:Inputval databaseType: Property<String> migrationsDir [jvm]@get:InputDirectoryabstract val migrationsDir: DirectoryProperty password [jvm]@get:Inputabstract val password: Property<String> username [jvm]@get:Inputabstract val username: Property<String>"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/-schema-migrator-extension/","title":"SchemaMigratorExtension - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/SchemaMigratorExtension
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/-schema-migrator-extension/#schemamigratorextension","title":"SchemaMigratorExtension","text":"[jvm]\\
@Inject
constructor(objects: ObjectFactory)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database-type/","title":"databaseType - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/databaseType
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database-type/#databasetype","title":"databaseType","text":"[jvm]\\
@get:Input
val databaseType: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database/","title":"database - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/database
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database/#database","title":"database","text":"[jvm]\\
@get:Input
abstract val database: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/migrations-dir/","title":"migrationsDir - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/migrationsDir
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/migrations-dir/#migrationsdir","title":"migrationsDir","text":"[jvm]\\
@get:InputDirectory
abstract val migrationsDir: DirectoryProperty
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/password/","title":"password - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/password
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/password/#password","title":"password","text":"[jvm]\\
@get:Input
abstract val password: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/username/","title":"username - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/username
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/username/#username","title":"username","text":"[jvm]\\
@get:Input
abstract val username: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/","title":"SchemaMigratorModule - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorModule
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/#schemamigratormodule","title":"SchemaMigratorModule","text":"[jvm]\\ class SchemaMigratorModule(database: String, dbType: String, username: String, password: String, schemaDir: File) : KAbstractModule
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/#constructors","title":"Constructors","text":"SchemaMigratorModule [jvm]constructor(database: String, dbType: String, username: String, password: String, schemaDir: File)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/-schema-migrator-module/","title":"SchemaMigratorModule - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorModule/SchemaMigratorModule
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/-schema-migrator-module/#schemamigratormodule","title":"SchemaMigratorModule","text":"[jvm]\\ constructor(database: String, dbType: String, username: String, password: String, schemaDir: File)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/","title":"SchemaMigratorPlugin - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorPlugin
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/#schemamigratorplugin","title":"SchemaMigratorPlugin","text":"[jvm]\\ class SchemaMigratorPlugin : Plugin<Project>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/#constructors","title":"Constructors","text":"SchemaMigratorPlugin [jvm]constructor()"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/#functions","title":"Functions","text":"Name Summary apply [jvm]open override fun apply(project: Project)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/-schema-migrator-plugin/","title":"SchemaMigratorPlugin - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorPlugin/SchemaMigratorPlugin
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/-schema-migrator-plugin/#schemamigratorplugin","title":"SchemaMigratorPlugin","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/apply/","title":"apply - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorPlugin/apply
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/apply/#apply","title":"apply","text":"[jvm]\\ open override fun apply(project: Project)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/","title":"SchemaMigratorTask - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#schemamigratortask","title":"SchemaMigratorTask","text":"[jvm]\\ abstract class SchemaMigratorTask : DefaultTask
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#constructors","title":"Constructors","text":"SchemaMigratorTask [jvm]constructor()"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#properties","title":"Properties","text":"Name Summary database [jvm]@get:Inputabstract val database: Property<String> databaseType [jvm]@get:Inputabstract val databaseType: Property<String> enabled [jvm]@get:Internalvar enabled: Boolean hasCustomActions [jvm]val hasCustomActions: Boolean impliesSubProjects [jvm]var impliesSubProjects: Boolean migrationsDir [jvm]@get:PathSensitive(value = PathSensitivity.RELATIVE)@get:InputDirectoryabstract val migrationsDir: DirectoryProperty password [jvm]@get:Inputabstract val password: Property<String> state [jvm]val state: TaskStateInternal timeout [jvm]val timeout: Property<Duration> username [jvm]@get:Inputabstract val username: Property<String>"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#functions","title":"Functions","text":"Name Summary acceptServiceReferences [jvm]open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>) appendParallelSafeAction [jvm]open override fun appendParallelSafeAction(action: Action<in Task>) compareTo [jvm]open operator override fun compareTo(other: Task): Int configure [jvm]open override fun configure(closure: Closure<Any>): Task dependsOn [jvm]open override fun dependsOn(vararg paths: Any): Task doFirst [jvm]open override fun doFirst(action: Closure<Any>): Taskopen override fun doFirst(action: Action<in Task>): Taskopen override fun doFirst(actionName: String, action: Action<in Task>): Task doLast [jvm]open override fun doLast(action: Closure<Any>): Taskopen override fun doLast(action: Action<in Task>): Taskopen override fun doLast(actionName: String, action: Action<in Task>): Task doNotTrackState [jvm]open override fun doNotTrackState(reasonNotToTrackState: String) finalizedBy [jvm]open override fun finalizedBy(vararg paths: Any): Task getActions [jvm]open override fun getActions(): MutableList<Action<in Task>> getAnt [jvm]open override fun getAnt(): AntBuilder getAsDynamicObject [jvm]@Internalopen override fun getAsDynamicObject(): DynamicObject getDependsOn [jvm]open override fun getDependsOn(): MutableSet<Any> getDescription [jvm]open override fun getDescription(): String? getDestroyables [jvm]open override fun getDestroyables(): TaskDestroyables getDidWork [jvm]open override fun getDidWork(): Boolean getExtensions [jvm]open override fun getExtensions(): ExtensionContainer getFinalizedBy [jvm]open override fun getFinalizedBy(): TaskDependency getGroup [jvm]open override fun getGroup(): String? getIdentityPath [jvm]open override fun getIdentityPath(): Path getInputs [jvm]open override fun getInputs(): TaskInputsInternal getLifecycleDependencies [jvm]@Internalopen override fun getLifecycleDependencies(): TaskDependencyInternal getLocalState [jvm]open override fun getLocalState(): TaskLocalState getLogger [jvm]open override fun getLogger(): Logger getLogging [jvm]open override fun getLogging(): LoggingManager getMustRunAfter [jvm]open override fun getMustRunAfter(): TaskDependency getName [jvm]open override fun getName(): String getOnlyIf [jvm]open override fun getOnlyIf(): Spec<in TaskInternal> getOutputs [jvm]open override fun getOutputs(): TaskOutputsInternal getPath [jvm]open override fun getPath(): String getProject [jvm]open override fun getProject(): Project getReasonNotToTrackState [jvm]open override fun getReasonNotToTrackState(): Optional<String> getReasonTaskIsIncompatibleWithConfigurationCache [jvm]open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String> getRequiredServices [jvm]open override fun getRequiredServices(): TaskRequiredServices getSharedResources [jvm]open override fun getSharedResources(): MutableList<ResourceLock> getShouldRunAfter [jvm]open override fun getShouldRunAfter(): TaskDependency getStandardOutputCapture [jvm]open override fun getStandardOutputCapture(): StandardOutputCapture getTaskActions [jvm]open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction> getTaskDependencies [jvm]open override fun getTaskDependencies(): TaskDependencyInternal getTaskIdentity [jvm]open override fun getTaskIdentity(): TaskIdentity<*> getTemporaryDir [jvm]open override fun getTemporaryDir(): File getTemporaryDirFactory [jvm]open override fun getTemporaryDirFactory(): Factory<File> hasProperty [jvm]open override fun hasProperty(propertyName: String): Boolean hasTaskActions [jvm]open override fun hasTaskActions(): Boolean isCompatibleWithConfigurationCache [jvm]open override fun isCompatibleWithConfigurationCache(): Boolean migrateSchemas [jvm]fun migrateSchemas() mustRunAfter [jvm]open override fun mustRunAfter(vararg paths: Any): Task notCompatibleWithConfigurationCache [jvm]open override fun notCompatibleWithConfigurationCache(reason: String) onlyIf [jvm]open override fun onlyIf(onlyIfClosure: Closure<Any>)open override fun onlyIf(spec: Spec<in Task>)open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>) prependParallelSafeAction [jvm]open override fun prependParallelSafeAction(action: Action<in Task>) property [jvm]open override fun property(propertyName: String): Any? setActions [jvm]open override fun setActions(replacements: MutableList<Action<in Task>>) setDependsOn [jvm]open override fun setDependsOn(dependsOn: MutableIterable<*>) setDescription [jvm]open override fun setDescription(description: String?) setDidWork [jvm]open override fun setDidWork(didWork: Boolean) setFinalizedBy [jvm]open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>) setGroup [jvm]open override fun setGroup(group: String?) setMustRunAfter [jvm]open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>) setOnlyIf [jvm]open override fun setOnlyIf(onlyIfClosure: Closure<Any>)open override fun setOnlyIf(spec: Spec<in Task>)open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>) setProperty [jvm]open override fun setProperty(name: String, value: Any) setShouldRunAfter [jvm]open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>) shouldRunAfter [jvm]open override fun shouldRunAfter(vararg paths: Any): TaskDependency usesService [jvm]open override fun usesService(service: Provider<out BuildService<*>>)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/-schema-migrator-task/","title":"SchemaMigratorTask - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/SchemaMigratorTask
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/-schema-migrator-task/#schemamigratortask","title":"SchemaMigratorTask","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database-type/","title":"databaseType - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/databaseType
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database-type/#databasetype","title":"databaseType","text":"[jvm]\\
@get:Input
abstract val databaseType: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database/","title":"database - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/database
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database/#database","title":"database","text":"[jvm]\\
@get:Input
abstract val database: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrate-schemas/","title":"migrateSchemas - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/migrateSchemas
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrate-schemas/#migrateschemas","title":"migrateSchemas","text":"[jvm]\\ fun migrateSchemas()
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrations-dir/","title":"migrationsDir - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/migrationsDir
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrations-dir/#migrationsdir","title":"migrationsDir","text":"[jvm]\\
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:InputDirectory
abstract val migrationsDir: DirectoryProperty
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/password/","title":"password - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/password
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/password/#password","title":"password","text":"[jvm]\\
@get:Input
abstract val password: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/username/","title":"username - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/username
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/username/#username","title":"username","text":"[jvm]\\
@get:Input
abstract val username: Property<String>
"},{"location":"0.x/misk-service/","title":"misk-service - Misk","text":"//misk-service
"},{"location":"0.x/misk-service/#misk-service","title":"misk-service","text":""},{"location":"0.x/misk-service/#packages","title":"Packages","text":"Name misk"},{"location":"0.x/misk-service/misk-service/misk/","title":"Package-level declarations - Misk","text":"//misk-service/misk
"},{"location":"0.x/misk-service/misk-service/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-service/misk-service/misk/#types","title":"Types","text":"Name Summary DelegatingService [jvm]interface DelegatingService : ServiceInterface to retrieve the underlying Service of a wrapper Service ReadyService [jvm]@Singletonclass ReadyService@Injectconstructor : AbstractIdleServiceThis is a symbolic service that\u2019s useful to define the relationship, generally, between services which process traffic (Jetty, SQS, Kinesis, Cron, Tasks, etc.) and services which are required to do work (Database, Redis, GCP, Feature Flags). ServiceManagerConfig [jvm]data class ServiceManagerConfig@JvmOverloadsconstructor(val debug_service_graph: Boolean = false) : Config ServiceManagerModule [jvm]class ServiceManagerModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule ServiceModule [jvm]class ServiceModule(val key: Key<out Service>, val dependsOn: List<Key<out Service>> = listOf(), val enhancedBy: List<Key<out Service>> = listOf()) : KAbstractModuleServices in Misk can depend on other services."},{"location":"0.x/misk-service/misk-service/misk/#functions","title":"Functions","text":"Name Summary ServiceModule [jvm]inline fun <T : Service> ServiceModule(qualifier: KClass<out Annotation>? = null): ServiceModuleReturns a ServiceModule and hooks up service dependencies and enhancements."},{"location":"0.x/misk-service/misk-service/misk/-service-module/","title":"ServiceModule - Misk","text":"//misk-service/misk/ServiceModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#servicemodule","title":"ServiceModule","text":"[jvm]\\ inline fun <T : Service> ServiceModule(qualifier: KClass<out Annotation>? = null): ServiceModule
Returns a ServiceModule and hooks up service dependencies and enhancements.
Here\u2019s how:
Guice.createInjector(object : KAbstractModule() {\n override fun configure() {\n install(ServiceModule<MyService>()\n .dependsOn<MyServiceDependency>())\n install(ServiceModule<MyServiceDependency>())\n }\n}\nDependencies and services may be optionally annotated:
Guice.createInjector(object : KAbstractModule() {\n override fun configure() {\n install(ServiceModule<MyService>(MyAnnotation::class)\n .dependsOn<MyServiceDependency>(AnotherAnnotation::class))\n install(ServiceModule<MyServiceDependency>(AnotherAnnotation::class))\n }\n}\n//misk-service/misk/DelegatingService
"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/#delegatingservice","title":"DelegatingService","text":"[jvm]\\ interface DelegatingService : Service
Interface to retrieve the underlying Service of a wrapper Service
"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/#properties","title":"Properties","text":"Name Summary service [jvm]abstract val service: Service"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/service/","title":"service - Misk","text":"//misk-service/misk/DelegatingService/service
"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/service/#service","title":"service","text":"[jvm]\\ abstract val service: Service
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/","title":"ReadyService - Misk","text":"//misk-service/misk/ReadyService
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/#readyservice","title":"ReadyService","text":"[jvm]\\ @Singleton
class ReadyService@Injectconstructor : AbstractIdleService
This is a symbolic service that\u2019s useful to define the relationship, generally, between services which process traffic (Jetty, SQS, Kinesis, Cron, Tasks, etc.) and services which are required to do work (Database, Redis, GCP, Feature Flags).
By having the former depend on ReadyService and the latter enhanced by ReadyService we can force, for example, JettyService to stop before our feature flag service without having to intertwine our dependency graph.
Example
install(\n ServiceModule<TransacterService>(qualifier)\n .enhancedBy<SchemaMigratorService>(qualifier)\n // ReadyService won't run until TransacterService is complete\n .enhancedBy<ReadyService>()\n .dependsOn<DataSourceService>(qualifier)\n)\n//misk-service/misk/ReadyService/ReadyService
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/-ready-service/#readyservice","title":"ReadyService","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/-companion/","title":"Companion - Misk","text":"//misk-service/misk/ReadyService/Companion
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/","title":"ServiceManagerConfig - Misk","text":"//misk-service/misk/ServiceManagerConfig
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/#servicemanagerconfig","title":"ServiceManagerConfig","text":"[jvm]\\ data class ServiceManagerConfig@JvmOverloadsconstructor(val debug_service_graph: Boolean = false) : Config
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/#constructors","title":"Constructors","text":"ServiceManagerConfig [jvm]@JvmOverloadsconstructor(debug_service_graph: Boolean = false)"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/#properties","title":"Properties","text":"Name Summary debug_service_graph [jvm]val debug_service_graph: Boolean = falseIf true, writes the full graph of ServiceModule services and their dependencies to info-level logs."},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/-service-manager-config/","title":"ServiceManagerConfig - Misk","text":"//misk-service/misk/ServiceManagerConfig/ServiceManagerConfig
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/-service-manager-config/#servicemanagerconfig","title":"ServiceManagerConfig","text":"[jvm]\\
@JvmOverloads
constructor(debug_service_graph: Boolean = false)
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/debug_service_graph/","title":"debug_service_graph - Misk","text":"//misk-service/misk/ServiceManagerConfig/debug_service_graph
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/debug_service_graph/#debug_service_graph","title":"debug_service_graph","text":"[jvm]\\ val debug_service_graph: Boolean = false
If true, writes the full graph of ServiceModule services and their dependencies to info-level logs.
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/","title":"ServiceManagerModule - Misk","text":"//misk-service/misk/ServiceManagerModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#servicemanagermodule","title":"ServiceManagerModule","text":"[jvm]\\ class ServiceManagerModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#constructors","title":"Constructors","text":"ServiceManagerModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-service-manager-module/","title":"ServiceManagerModule - Misk","text":"//misk-service/misk/ServiceManagerModule/ServiceManagerModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-service-manager-module/#servicemanagermodule","title":"ServiceManagerModule","text":"[jvm]\\
@JvmOverloads
constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-companion/","title":"Companion - Misk","text":"//misk-service/misk/ServiceManagerModule/Companion
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/","title":"ServiceModule - Misk","text":"//misk-service/misk/ServiceModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#servicemodule","title":"ServiceModule","text":"[jvm]\\ class ServiceModule(val key: Key<out Service>, val dependsOn: List<Key<out Service>> = listOf(), val enhancedBy: List<Key<out Service>> = listOf()) : KAbstractModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#misk-services","title":"Misk Services","text":"Services in Misk can depend on other services.
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#dependencies","title":"Dependencies","text":"Suppose we have a DatabaseService and a MovieService, with the MovieService depending on the DatabaseService.
DatabaseService\n depended on by MovieService\nWhen you install a service via this module, start-up and shut-down of its dependencies are handled automatically, so that a service can only run when the services it depends on are running. In the example above, the MovieService doesn\u2019t enter the STARTING state until the DatabaseService has entered the RUNNING state. Conversely, the MovieService must enter the TERMINATED state before the DatabaseService enters the STOPPING state.
Dependencies can have their own dependencies, so there\u2019s an entire graph to manage of what starts and stops when.
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#enhancements","title":"Enhancements","text":"Some services exist to enhance the behavior of another service.
For example, a DatabaseService may manage a generic connection to a MySQL database, and the SchemaMigrationService may create tables specific to the application.
We treat such enhancements as implementation details of the enhanced service: they depend on the service, but downstream dependencies like the MovieService don\u2019t need to know that they exist.
DatabaseService\n enhanced by SchemaMigrationService\n depended on by MovieService\nIn the above service graph we start the DatabaseService first, the SchemaMigrationService second, and finally the MovieService. The MovieService doesn\u2019t need to express a dependency on the SchemaMigrationService, that happens automatically for enhancements.
Instead of using the regular service multi-bindings you might be used to, in the configure block of a Guice KAbstractModule, you would set up the above relationship as follows:
override fun configure() {\n install(ServiceModule<SchemaMigrationService())\n install(ServiceModule<DatabaseService>()\n .enhancedBy<SchemaMigrationService>())\n install(ServiceModule<MoviesService>()\n .dependsOn<DatabaseService>())\n}\nBindings are hooked up for a ServiceManager provider, which decorates the service with its dependencies and enhancements to defer its start up and shut down until its dependent services are ready.
This service will stall in the STARTING state until all upstream services are RUNNING. Symmetrically it stalls in the STOPPING state until all dependent services are TERMINATED.
//misk-service/misk/ServiceModule/ServiceModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/-service-module/#servicemodule","title":"ServiceModule","text":"[jvm]\\ constructor(key: Key<out Service>, dependsOn: List<Key<out Service>> = listOf(), enhancedBy: List<Key<out Service>> = listOf())
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/depends-on/","title":"dependsOn - Misk","text":"//misk-service/misk/ServiceModule/dependsOn
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/depends-on/#dependson","title":"dependsOn","text":"[jvm]\\ fun dependsOn(upstream: Key<out Service>): ServiceModule
@JvmOverloads
inline fun <T : Service> dependsOn(qualifier: KClass<out Annotation>? = null): ServiceModule
val dependsOn: List<Key<out Service>>
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/enhanced-by/","title":"enhancedBy - Misk","text":"//misk-service/misk/ServiceModule/enhancedBy
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/enhanced-by/#enhancedby","title":"enhancedBy","text":"[jvm]\\ fun enhancedBy(enhancement: Key<out Service>): ServiceModule
@JvmOverloads
inline fun <T : Service> enhancedBy(qualifier: KClass<out Annotation>? = null): ServiceModule
val enhancedBy: List<Key<out Service>>
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/key/","title":"key - Misk","text":"//misk-service/misk/ServiceModule/key
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/key/#key","title":"key","text":"[jvm]\\ val key: Key<out Service>
"},{"location":"0.x/misk-slack/","title":"misk-slack - Misk","text":"//misk-slack
"},{"location":"0.x/misk-slack/#misk-slack","title":"misk-slack","text":""},{"location":"0.x/misk-slack/#packages","title":"Packages","text":"Name misk.slack misk.slack.webapi misk.slack.webapi.helpers misk.slack.webapi.interceptors misk.slack.webapi.slashcommands"},{"location":"0.x/misk-slack/misk-slack/misk.slack/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack/#types","title":"Types","text":"Name Summary RealSlackClient [jvm]class RealSlackClient@Injectconstructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig) : SlackClient SlackClient [jvm]open class SlackClient@InjectconstructorDummy client that does nothing if SlackModule is not installed . SlackConfig [jvm]data class SlackConfig@JvmOverloadsconstructor(val baseUrl: String = \"https://hooks.slack.com/", val webhook_path: Secret<String>, val default_channel: String?) SlackModule [jvm]class SlackModule(config: SlackConfig) : KAbstractModuleInstalls the Slack webhook client. This should be installed once per service and enables imported libraries to post to Slack using the service level config. SlackWebhookApi [jvm]interface SlackWebhookApi SlackWebhookRequest [jvm]@JsonClass(generateAdapter = true)data class SlackWebhookRequest(val channel: String, val username: String, val text: String, val icon_emoji: String) SlackWebhookResponse [jvm]@JsonClass(generateAdapter = true)enum SlackWebhookResponse : Enum<SlackWebhookResponse>"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\ class RealSlackClient@Injectconstructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig) : SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#constructors","title":"Constructors","text":"RealSlackClient [jvm]@Injectconstructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#functions","title":"Functions","text":"Name Summary postMessage [jvm]open override fun postMessage(username: String, iconEmoji: String, message: String, channel: String?): SlackWebhookResponse?Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. Does not throw on IO exceptions."},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack/RealSlackClient/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\
@Inject
constructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack/RealSlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\ open override fun postMessage(username: String, iconEmoji: String, message: String, channel: String?): SlackWebhookResponse?
Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. Does not throw on IO exceptions.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/","title":"Companion - Misk","text":"//misk-slack/misk.slack/RealSlackClient/Companion
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/logger/","title":"logger - Misk","text":"//misk-slack/misk.slack/RealSlackClient/Companion/logger
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/","title":"SlackClient - Misk","text":"//misk-slack/misk.slack/SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#slackclient","title":"SlackClient","text":"open class SlackClient@Injectconstructor
Dummy client that does nothing if SlackModule is not installed .
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#inheritors","title":"Inheritors","text":"RealSlackClient"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#constructors","title":"Constructors","text":"SlackClient [jvm]@Injectconstructor()"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#functions","title":"Functions","text":"Name Summary postMessage [jvm]@JvmOverloadsopen fun postMessage(username: String, iconEmoji: String, message: String, channel: String? = null): SlackWebhookResponse?Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. If the service has not configured a slack module, this method is a no-op. Does not throw on IO exceptions."},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/-slack-client/","title":"SlackClient - Misk","text":"//misk-slack/misk.slack/SlackClient/SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/-slack-client/#slackclient","title":"SlackClient","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack/SlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\
@JvmOverloads
open fun postMessage(username: String, iconEmoji: String, message: String, channel: String? = null): SlackWebhookResponse?
Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. If the service has not configured a slack module, this method is a no-op. Does not throw on IO exceptions.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\ data class SlackConfig@JvmOverloadsconstructor(val baseUrl: String = \"https://hooks.slack.com/", val webhook_path: Secret<String>, val default_channel: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/#constructors","title":"Constructors","text":"SlackConfig [jvm]@JvmOverloadsconstructor(baseUrl: String = \"https://hooks.slack.com/", webhook_path: Secret<String>, default_channel: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/#properties","title":"Properties","text":"Name Summary baseUrl [jvm]val baseUrl: String default_channel [jvm]val default_channel: String?The channel to post to if the caller doesn\u2019t specify one. A service that always posts to one channel should specify this, but a service that operates on other services can instead specify a channel for each message. webhook_path [jvm]val webhook_path: Secret<String>The full webhook path, i.e. /services/\u2026"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack/SlackConfig/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\
@JvmOverloads
constructor(baseUrl: String = \"https://hooks.slack.com/", webhook_path: Secret<String>, default_channel: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/base-url/","title":"baseUrl - Misk","text":"//misk-slack/misk.slack/SlackConfig/baseUrl
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/base-url/#baseurl","title":"baseUrl","text":"[jvm]\\ val baseUrl: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/default_channel/","title":"default_channel - Misk","text":"//misk-slack/misk.slack/SlackConfig/default_channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/default_channel/#default_channel","title":"default_channel","text":"[jvm]\\ val default_channel: String?
The channel to post to if the caller doesn\u2019t specify one. A service that always posts to one channel should specify this, but a service that operates on other services can instead specify a channel for each message.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/webhook_path/","title":"webhook_path - Misk","text":"//misk-slack/misk.slack/SlackConfig/webhook_path
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/webhook_path/#webhook_path","title":"webhook_path","text":"[jvm]\\ val webhook_path: Secret<String>
The full webhook path, i.e. /services/\u2026
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/","title":"SlackModule - Misk","text":"//misk-slack/misk.slack/SlackModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/#slackmodule","title":"SlackModule","text":"[jvm]\\ class SlackModule(config: SlackConfig) : KAbstractModule
Installs the Slack webhook client. This should be installed once per service and enables imported libraries to post to Slack using the service level config.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/#constructors","title":"Constructors","text":"SlackModule [jvm]constructor(config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singleton@Named(value = \"misk-slack\")fun provideMoshi(): Moshi provideSlackWebhookApi [jvm]@Provides@Singletonfun provideSlackWebhookApi(httpClientFactory: HttpClientFactory, @Named(value = \"misk-slack\")moshi: Moshi): SlackWebhookApi"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/-slack-module/","title":"SlackModule - Misk","text":"//misk-slack/misk.slack/SlackModule/SlackModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/-slack-module/#slackmodule","title":"SlackModule","text":"[jvm]\\ constructor(config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-moshi/","title":"provideMoshi - Misk","text":"//misk-slack/misk.slack/SlackModule/provideMoshi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"[jvm]\\
@Provides
@Singleton
@Named(value = \"misk-slack\")
fun provideMoshi(): Moshi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-slack-webhook-api/","title":"provideSlackWebhookApi - Misk","text":"//misk-slack/misk.slack/SlackModule/provideSlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-slack-webhook-api/#provideslackwebhookapi","title":"provideSlackWebhookApi","text":"[jvm]\\
@Provides
@Singleton
fun provideSlackWebhookApi(httpClientFactory: HttpClientFactory, @Named(value = \"misk-slack\")moshi: Moshi): SlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/","title":"SlackWebhookApi - Misk","text":"//misk-slack/misk.slack/SlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/#slackwebhookapi","title":"SlackWebhookApi","text":"[jvm]\\ interface SlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/#functions","title":"Functions","text":"Name Summary post [jvm]@POSTabstract fun post(@Urlurl: String, @Bodyrequest: SlackWebhookRequest): Call<Void>"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/post/","title":"post - Misk","text":"//misk-slack/misk.slack/SlackWebhookApi/post
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/post/#post","title":"post","text":"[jvm]\\
@POST
abstract fun post(@Urlurl: String, @Bodyrequest: SlackWebhookRequest): Call<Void>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/","title":"SlackWebhookRequest - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/#slackwebhookrequest","title":"SlackWebhookRequest","text":"[jvm]\\ @JsonClass(generateAdapter = true)
data class SlackWebhookRequest(val channel: String, val username: String, val text: String, val icon_emoji: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/#constructors","title":"Constructors","text":"SlackWebhookRequest [jvm]constructor(channel: String, username: String, text: String, icon_emoji: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/#properties","title":"Properties","text":"Name Summary channel [jvm]val channel: String icon_emoji [jvm]val icon_emoji: String text [jvm]val text: String username [jvm]val username: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/-slack-webhook-request/","title":"SlackWebhookRequest - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/SlackWebhookRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/-slack-webhook-request/#slackwebhookrequest","title":"SlackWebhookRequest","text":"[jvm]\\ constructor(channel: String, username: String, text: String, icon_emoji: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/channel/#channel","title":"channel","text":"[jvm]\\ val channel: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/icon_emoji/","title":"icon_emoji - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/icon_emoji
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/icon_emoji/#icon_emoji","title":"icon_emoji","text":"[jvm]\\ val icon_emoji: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/text/","title":"text - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/username/","title":"username - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/username
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/username/#username","title":"username","text":"[jvm]\\ val username: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/","title":"SlackWebhookResponse - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#slackwebhookresponse","title":"SlackWebhookResponse","text":"[jvm]\\ @JsonClass(generateAdapter = true)
enum SlackWebhookResponse : Enum<SlackWebhookResponse>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#entries","title":"Entries","text":"ok [jvm]ok invalid_payload [jvm]invalid_payload user_not_found [jvm]user_not_found channel_not_found [jvm]channel_not_found channel_is_archived [jvm]channel_is_archived action_prohibited [jvm]action_prohibited missing_text_or_fallback_or_attachments [jvm]missing_text_or_fallback_or_attachments"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<SlackWebhookResponse>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): SlackWebhookResponseReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<SlackWebhookResponse>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/entries/","title":"entries - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/entries
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<SlackWebhookResponse>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/value-of/","title":"valueOf - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/valueOf
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): SlackWebhookResponse
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/values/","title":"values - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<SlackWebhookResponse>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/action_prohibited/","title":"action_prohibited - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/action_prohibited
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/action_prohibited/#action_prohibited","title":"action_prohibited","text":"[jvm]\\ action_prohibited
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/action_prohibited/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_is_archived/","title":"channel_is_archived - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/channel_is_archived
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_is_archived/#channel_is_archived","title":"channel_is_archived","text":"[jvm]\\ channel_is_archived
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_is_archived/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_not_found/","title":"channel_not_found - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/channel_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_not_found/#channel_not_found","title":"channel_not_found","text":"[jvm]\\ channel_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_not_found/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/invalid_payload/","title":"invalid_payload - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/invalid_payload
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/invalid_payload/#invalid_payload","title":"invalid_payload","text":"[jvm]\\ invalid_payload
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/invalid_payload/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/missing_text_or_fallback_or_attachments/","title":"missing_text_or_fallback_or_attachments - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/missing_text_or_fallback_or_attachments
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/missing_text_or_fallback_or_attachments/#missing_text_or_fallback_or_attachments","title":"missing_text_or_fallback_or_attachments","text":"[jvm]\\ missing_text_or_fallback_or_attachments
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/missing_text_or_fallback_or_attachments/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/ok/","title":"ok - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/ok/#ok","title":"ok","text":"[jvm]\\ ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/ok/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/user_not_found/","title":"user_not_found - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/user_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/user_not_found/#user_not_found","title":"user_not_found","text":"[jvm]\\ user_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/user_not_found/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack.webapi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/#types","title":"Types","text":"Name Summary RealSlackClient [jvm]class RealSlackClient@Injectconstructor(slackApi: SlackApi) : SlackClient RealSlackClientModule [jvm]class RealSlackClientModule(config: SlackConfig) : KAbstractModule SlackApi [jvm]interface SlackApi SlackClient [jvm]interface SlackClient SlackConfig [jvm]data class SlackConfig@JvmOverloadsconstructor(val url: String = \"https://hooks.slack.com/", val bearer_token: Secret<String>, val signing_secret: Secret<String>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/#functions","title":"Functions","text":"Name Summary checkSuccessful [jvm]fun Response<PostMessageResponse>.checkSuccessful()"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/check-successful/","title":"checkSuccessful - Misk","text":"//misk-slack/misk.slack.webapi/checkSuccessful
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/check-successful/#checksuccessful","title":"checkSuccessful","text":"[jvm]\\ fun Response<PostMessageResponse>.checkSuccessful()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\ class RealSlackClient@Injectconstructor(slackApi: SlackApi) : SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/#constructors","title":"Constructors","text":"RealSlackClient [jvm]@Injectconstructor(slackApi: SlackApi)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/#functions","title":"Functions","text":"Name Summary getUserByEmail [jvm]open override fun getUserByEmail(email: String): GetUserResponse postConfirmation [jvm]open override fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse postMessage [jvm]open override fun postMessage(request: PostMessageRequest): PostMessageResponse"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\
@Inject
constructor(slackApi: SlackApi)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/get-user-by-email/","title":"getUserByEmail - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/getUserByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/get-user-by-email/#getuserbyemail","title":"getUserByEmail","text":"[jvm]\\ open override fun getUserByEmail(email: String): GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-confirmation/","title":"postConfirmation - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/postConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-confirmation/#postconfirmation","title":"postConfirmation","text":"[jvm]\\ open override fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\ open override fun postMessage(request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/","title":"RealSlackClientModule - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClientModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/#realslackclientmodule","title":"RealSlackClientModule","text":"[jvm]\\ class RealSlackClientModule(config: SlackConfig) : KAbstractModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/#constructors","title":"Constructors","text":"RealSlackClientModule [jvm]constructor(config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/-real-slack-client-module/","title":"RealSlackClientModule - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClientModule/RealSlackClientModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/-real-slack-client-module/#realslackclientmodule","title":"RealSlackClientModule","text":"[jvm]\\ constructor(config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/","title":"SlackApi - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/#slackapi","title":"SlackApi","text":"[jvm]\\ interface SlackApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/#functions","title":"Functions","text":"Name Summary getUserByEmail [jvm]@GET(value = \"/api/users.lookupByEmail\")@Headers(value = [\"accept: application/json\"])abstract fun getUserByEmail(@Query(value = \"email\")email: String): Call<GetUserResponse>Calls Slack to fetch user for given email. postConfirmation [jvm]@POST@Headers(value = [\"accept: application/json\"])abstract fun postConfirmation(@Urlurl: String, @BodyconfirmationMessageJson: PostMessageRequest): Call<PostMessageResponse>Calls Slack and asks it to post a confirmation message to the dynamic URL sent from Slack. https://api.slack.com/interactivity/handling#message_responses postMessage [jvm]@POST(value = \"/api/chat.postMessage\")@Headers(value = [\"accept: application/json\"])abstract fun postMessage(@BodypostMessageJson: PostMessageRequest): Call<PostMessageResponse>Calls Slack and asks it to post message. https://api.slack.com/methods/chat.postMessage"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/get-user-by-email/","title":"getUserByEmail - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi/getUserByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/get-user-by-email/#getuserbyemail","title":"getUserByEmail","text":"[jvm]\\
@GET(value = \"/api/users.lookupByEmail\")
@Headers(value = [\"accept: application/json\"])
abstract fun getUserByEmail(@Query(value = \"email\")email: String): Call<GetUserResponse>
Calls Slack to fetch user for given email.
https://api.slack.com/methods/users.lookupByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-confirmation/","title":"postConfirmation - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi/postConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-confirmation/#postconfirmation","title":"postConfirmation","text":"[jvm]\\
@POST
@Headers(value = [\"accept: application/json\"])
abstract fun postConfirmation(@Urlurl: String, @BodyconfirmationMessageJson: PostMessageRequest): Call<PostMessageResponse>
Calls Slack and asks it to post a confirmation message to the dynamic URL sent from Slack. https://api.slack.com/interactivity/handling#message_responses
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-message/#postmessage","title":"postMessage","text":"[jvm]\\
@POST(value = \"/api/chat.postMessage\")
@Headers(value = [\"accept: application/json\"])
abstract fun postMessage(@BodypostMessageJson: PostMessageRequest): Call<PostMessageResponse>
Calls Slack and asks it to post message. https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/","title":"SlackClient - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/#slackclient","title":"SlackClient","text":"interface SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/#inheritors","title":"Inheritors","text":"RealSlackClient"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/#functions","title":"Functions","text":"Name Summary getUserByEmail [jvm]abstract fun getUserByEmail(mail: String): GetUserResponse postConfirmation [jvm]abstract fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse postMessage [jvm]abstract fun postMessage(request: PostMessageRequest): PostMessageResponse"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/get-user-by-email/","title":"getUserByEmail - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient/getUserByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/get-user-by-email/#getuserbyemail","title":"getUserByEmail","text":"[jvm]\\ abstract fun getUserByEmail(mail: String): GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-confirmation/","title":"postConfirmation - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient/postConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-confirmation/#postconfirmation","title":"postConfirmation","text":"[jvm]\\ abstract fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\ abstract fun postMessage(request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\ data class SlackConfig@JvmOverloadsconstructor(val url: String = \"https://hooks.slack.com/", val bearer_token: Secret<String>, val signing_secret: Secret<String>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/#constructors","title":"Constructors","text":"SlackConfig [jvm]@JvmOverloadsconstructor(url: String = \"https://hooks.slack.com/", bearer_token: Secret<String>, signing_secret: Secret<String>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/#properties","title":"Properties","text":"Name Summary bearer_token [jvm]val bearer_token: Secret<String> signing_secret [jvm]val signing_secret: Secret<String> url [jvm]val url: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String = \"https://hooks.slack.com/", bearer_token: Secret<String>, signing_secret: Secret<String>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/bearer_token/","title":"bearer_token - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/bearer_token
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/bearer_token/#bearer_token","title":"bearer_token","text":"[jvm]\\ val bearer_token: Secret<String>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/signing_secret/","title":"signing_secret - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/signing_secret
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/signing_secret/#signing_secret","title":"signing_secret","text":"[jvm]\\ val signing_secret: Secret<String>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/url/","title":"url - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/url/#url","title":"url","text":"[jvm]\\ val url: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/","title":"Index","text":"//misk-slack/misk.slack.webapi.helpers
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#types","title":"Types","text":"Name Summary Actions [jvm]data class Actions(val type: String, val block_id: String, val action_id: String, val text: Text, val value: String, val action_ts: String) Block [jvm]data class Block@JvmOverloadsconstructor(val type: String, val replace_original: Boolean? = null, val block_id: String? = null, val text: Text? = null, val accessory: ButtonLinkAndValue? = null, val elements: List<ButtonLinkAndValue>? = null)An envelope that contains text or elements. ButtonLinkAndValue [jvm]data class ButtonLinkAndValue@JvmOverloadsconstructor(val type: String, val text: Text, val value: String? = null, val url: String? = null, val action_id: String? = null)https://api.slack.com/reference/block-kit/block-elements#button ButtonPress [jvm]data class ButtonPress(val type: String, val user: User, val api_app_id: String, val token: String, val container: Container, val trigger_id: String, val team: Team, val enterprise: Id, val is_enterprise_install: Boolean, val channel: Id, val message: Message, val state: Values, val response_url: String, val actions: List<Actions>)Message received from Slack upon button press. Container [jvm]data class Container(val type: String, val message_ts: String, val channel_id: String, val is_ephemeral: Boolean) EnterpriseUser [jvm]data class EnterpriseUser@JvmOverloadsconstructor(val enterprise_id: String? = null, val enterprise_name: String? = null, val id: String? = null, val is_admin: Boolean? = null, val is_owner: Boolean? = null, val teams: Array<String>? = null)An object containing info related to an Enterprise Grid user. GetUserResponse [jvm]data class GetUserResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val user: UserData? = null)Message received from slack after posting a message Id [jvm]data class Id(val id: String, val name: String) Message [jvm]data class Message(val bot_id: String, val type: String, val text: String, val user: String, val ts: String, val app_id: String, val blocks: List<Block>, val team: String) MrkdwnBuilder [jvm]class MrkdwnBuilderMrkdwn is Slack\u2019s weird thing that isn\u2019t Markdown. This class attempts to implement proper escaping and formatting. PostMessageRequest [jvm]data class PostMessageRequest@JvmOverloadsconstructor(val channel: String, val response_type: String? = \"in_channel\", val blocks: List<Any>)Message posted to /api/chat.postMessage PostMessageResponse [jvm]data class PostMessageResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val channel: String? = null, val ts: String? = null, val message: Message? = null)Message received from slack after posting a message SlashCommand [jvm]data class SlashCommand(val command: String, val text: String, val response_url: String, val trigger_id: String, val user_id: String, val user_name: String, val channel_id: String, val api_app_id: String)Payload received from Slack when user invokes slash command SlashInteractionResponse [jvm]data class SlashInteractionResponse@JvmOverloadsconstructor(val response_type: String? = \"in_channel\", val text: String)Response sent back to Slack while slash commands are being handled. Team [jvm]data class Team(val id: String, val domain: String, val enterprise_id: String, val enterprise_name: String) Text [jvm]data class Text@JvmOverloadsconstructor(val type: String, val text: String? = null, val emoji: Boolean? = null)https://api.slack.com/reference/block-kit/composition-objects#text User [jvm]data class User(val id: String, val username: String, val name: String, val team_id: String) UserData [jvm]data class UserData@JvmOverloadsconstructor(val always_active: Boolean? = null, val color: String? = null, val deleted: Boolean? = null, val enterprise_user: EnterpriseUser? = null, val has_2fa: Boolean? = null, val id: String? = null, val is_admin: Boolean? = null, val is_app_user: Boolean? = null, val is_bot: Boolean? = null, val is_email_confirmed: Boolean? = null, val is_invited_user: Boolean? = null, val is_owner: Boolean? = null, val is_primary_owner: Boolean? = null, val is_restricted: Boolean? = null, val is_stranger: Boolean? = null, val is_ultra_restricted: Boolean? = null, val locale: String? = null, val name: String? = null, val profile: UserProfile? = null, val real_name: String? = null, val team_id: String? = null, val two_factor_type: String? = null, val tz: String? = null, val tz_label: String? = null, val tz_offset: Int? = null, val updated: Int? = null)A user object contains information about a Slack workspace user. The composition of user objects can vary greatly depending on the API being used, or the context of each Slack workspace. Data that has not been supplied may not be present at all, may be null, or may contain an empty string. UserProfile [jvm]data class UserProfile@JvmOverloadsconstructor(val avatar_hash: String? = null, val display_name: String? = null, val display_name_normalized: String? = null, val email: String? = null, val fields: UserProfileFields? = null, val first_name: String? = null, val image_24: String? = null, val image_32: String? = null, val image_48: String? = null, val image_72: String? = null, val image_192: String? = null, val image_512: String? = null, val last_name: String? = null, val phone: String? = null, val pronouns: String? = null, val real_name: String? = null, val real_name_normalized: String? = null, val skype: String? = null, val start_date: String? = null, val status_emoji: String? = null, val status_expiration: Int? = null, val status_text: String? = null, val team: String? = null, val title: String? = null)A user object contains information about a Slack workspace user. UserProfileFields [jvm]data class UserProfileFields@JvmOverloadsconstructor(val display_name: String?, val email: String?, val first_name: String?, val last_name: String?, val phone: String?, val pronouns: String?, val real_name: String?, val start_date: String?, val title: String?)The following fields are the default fields of a user\u2019s workspace profile. Values [jvm]data class Values(val text: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#properties","title":"Properties","text":"Name Summary zwsp [jvm]val zwsp: StringInserting a zero-width space is enough to prevent Slack from attempting to link a string like :smile: as an emoji."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#functions","title":"Functions","text":"Name Summary buildMrkdwn [jvm]fun buildMrkdwn(builderAction: MrkdwnBuilder.() -> Unit): String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/build-mrkdwn/","title":"buildMrkdwn - Misk","text":"//misk-slack/misk.slack.webapi.helpers/buildMrkdwn
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/build-mrkdwn/#buildmrkdwn","title":"buildMrkdwn","text":"[jvm]\\ fun buildMrkdwn(builderAction: MrkdwnBuilder.() -> Unit): String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/zwsp/","title":"zwsp - Misk","text":"//misk-slack/misk.slack.webapi.helpers/zwsp
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/zwsp/#zwsp","title":"zwsp","text":"[jvm]\\ val zwsp: String
Inserting a zero-width space is enough to prevent Slack from attempting to link a string like :smile: as an emoji.
https://en.wikipedia.org/wiki/Zero-width_space
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/","title":"Actions - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/#actions","title":"Actions","text":"[jvm]\\ data class Actions(val type: String, val block_id: String, val action_id: String, val text: Text, val value: String, val action_ts: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/#constructors","title":"Constructors","text":"Actions [jvm]constructor(type: String, block_id: String, action_id: String, text: Text, value: String, action_ts: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/#properties","title":"Properties","text":"Name Summary action_id [jvm]val action_id: String action_ts [jvm]val action_ts: String block_id [jvm]val block_id: String text [jvm]val text: Text type [jvm]val type: String value [jvm]val value: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/-actions/","title":"Actions - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/Actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/-actions/#actions","title":"Actions","text":"[jvm]\\ constructor(type: String, block_id: String, action_id: String, text: Text, value: String, action_ts: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_id/","title":"action_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/action_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_id/#action_id","title":"action_id","text":"[jvm]\\ val action_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_ts/","title":"action_ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/action_ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_ts/#action_ts","title":"action_ts","text":"[jvm]\\ val action_ts: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/block_id/","title":"block_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/block_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/block_id/#block_id","title":"block_id","text":"[jvm]\\ val block_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/text/#text","title":"text","text":"[jvm]\\ val text: Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/value/","title":"value - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/value
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/","title":"Block - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/#block","title":"Block","text":"[jvm]\\ data class Block@JvmOverloadsconstructor(val type: String, val replace_original: Boolean? = null, val block_id: String? = null, val text: Text? = null, val accessory: ButtonLinkAndValue? = null, val elements: List<ButtonLinkAndValue>? = null)
An envelope that contains text or elements.
https://api.slack.com/reference/block-kit/blocks
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/#constructors","title":"Constructors","text":"Block [jvm]@JvmOverloadsconstructor(type: String, replace_original: Boolean? = null, block_id: String? = null, text: Text? = null, accessory: ButtonLinkAndValue? = null, elements: List<ButtonLinkAndValue>? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/#properties","title":"Properties","text":"Name Summary accessory [jvm]val accessory: ButtonLinkAndValue? = null block_id [jvm]val block_id: String? = null elements [jvm]val elements: List<ButtonLinkAndValue>? = null replace_original [jvm]val replace_original: Boolean? = null text [jvm]val text: Text? = null type [jvm]val type: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/-block/","title":"Block - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/Block
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/-block/#block","title":"Block","text":"[jvm]\\
@JvmOverloads
constructor(type: String, replace_original: Boolean? = null, block_id: String? = null, text: Text? = null, accessory: ButtonLinkAndValue? = null, elements: List<ButtonLinkAndValue>? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/accessory/","title":"accessory - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/accessory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/accessory/#accessory","title":"accessory","text":"[jvm]\\ val accessory: ButtonLinkAndValue? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/block_id/","title":"block_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/block_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/block_id/#block_id","title":"block_id","text":"[jvm]\\ val block_id: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/elements/","title":"elements - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/elements
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/elements/#elements","title":"elements","text":"[jvm]\\ val elements: List<ButtonLinkAndValue>? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/replace_original/","title":"replace_original - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/replace_original
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/replace_original/#replace_original","title":"replace_original","text":"[jvm]\\ val replace_original: Boolean? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/text/#text","title":"text","text":"[jvm]\\ val text: Text? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/","title":"ButtonLinkAndValue - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/#buttonlinkandvalue","title":"ButtonLinkAndValue","text":"[jvm]\\ data class ButtonLinkAndValue@JvmOverloadsconstructor(val type: String, val text: Text, val value: String? = null, val url: String? = null, val action_id: String? = null)
https://api.slack.com/reference/block-kit/block-elements#button
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/#constructors","title":"Constructors","text":"ButtonLinkAndValue [jvm]@JvmOverloadsconstructor(type: String, text: Text, value: String? = null, url: String? = null, action_id: String? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/#properties","title":"Properties","text":"Name Summary action_id [jvm]val action_id: String? = null text [jvm]val text: Text type [jvm]val type: String url [jvm]val url: String? = null value [jvm]val value: String? = null"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/-button-link-and-value/","title":"ButtonLinkAndValue - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/ButtonLinkAndValue
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/-button-link-and-value/#buttonlinkandvalue","title":"ButtonLinkAndValue","text":"[jvm]\\
@JvmOverloads
constructor(type: String, text: Text, value: String? = null, url: String? = null, action_id: String? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/action_id/","title":"action_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/action_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/action_id/#action_id","title":"action_id","text":"[jvm]\\ val action_id: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/text/#text","title":"text","text":"[jvm]\\ val text: Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/url/","title":"url - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/value/","title":"value - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/value
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/value/#value","title":"value","text":"[jvm]\\ val value: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/","title":"ButtonPress - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/#buttonpress","title":"ButtonPress","text":"[jvm]\\ data class ButtonPress(val type: String, val user: User, val api_app_id: String, val token: String, val container: Container, val trigger_id: String, val team: Team, val enterprise: Id, val is_enterprise_install: Boolean, val channel: Id, val message: Message, val state: Values, val response_url: String, val actions: List<Actions>)
Message received from Slack upon button press.
https://api.slack.com/reference/interaction-payloads/block-actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/#constructors","title":"Constructors","text":"ButtonPress [jvm]constructor(type: String, user: User, api_app_id: String, token: String, container: Container, trigger_id: String, team: Team, enterprise: Id, is_enterprise_install: Boolean, channel: Id, message: Message, state: Values, response_url: String, actions: List<Actions>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/#properties","title":"Properties","text":"Name Summary actions [jvm]val actions: List<Actions> api_app_id [jvm]val api_app_id: String channel [jvm]val channel: Id container [jvm]val container: Container enterprise [jvm]val enterprise: Id is_enterprise_install [jvm]val is_enterprise_install: Boolean message [jvm]val message: Message response_url [jvm]val response_url: String state [jvm]val state: Values team [jvm]val team: Team token [jvm]val token: String trigger_id [jvm]val trigger_id: String type [jvm]val type: String user [jvm]val user: User"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/-button-press/","title":"ButtonPress - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/ButtonPress
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/-button-press/#buttonpress","title":"ButtonPress","text":"[jvm]\\ constructor(type: String, user: User, api_app_id: String, token: String, container: Container, trigger_id: String, team: Team, enterprise: Id, is_enterprise_install: Boolean, channel: Id, message: Message, state: Values, response_url: String, actions: List<Actions>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/actions/","title":"actions - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/actions/#actions","title":"actions","text":"[jvm]\\ val actions: List<Actions>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/api_app_id/","title":"api_app_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/api_app_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/api_app_id/#api_app_id","title":"api_app_id","text":"[jvm]\\ val api_app_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/channel/#channel","title":"channel","text":"[jvm]\\ val channel: Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/container/","title":"container - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/container/#container","title":"container","text":"[jvm]\\ val container: Container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/enterprise/","title":"enterprise - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/enterprise
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/enterprise/#enterprise","title":"enterprise","text":"[jvm]\\ val enterprise: Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/is_enterprise_install/","title":"is_enterprise_install - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/is_enterprise_install
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/is_enterprise_install/#is_enterprise_install","title":"is_enterprise_install","text":"[jvm]\\ val is_enterprise_install: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/message/","title":"message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/message/#message","title":"message","text":"[jvm]\\ val message: Message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/response_url/","title":"response_url - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/response_url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/response_url/#response_url","title":"response_url","text":"[jvm]\\ val response_url: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/state/","title":"state - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/state
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/state/#state","title":"state","text":"[jvm]\\ val state: Values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/team/","title":"team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/team/#team","title":"team","text":"[jvm]\\ val team: Team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/token/","title":"token - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/token
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/token/#token","title":"token","text":"[jvm]\\ val token: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/trigger_id/","title":"trigger_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/trigger_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/trigger_id/#trigger_id","title":"trigger_id","text":"[jvm]\\ val trigger_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/user/","title":"user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/user/#user","title":"user","text":"[jvm]\\ val user: User
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/","title":"Container - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/#container","title":"Container","text":"[jvm]\\ data class Container(val type: String, val message_ts: String, val channel_id: String, val is_ephemeral: Boolean)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/#constructors","title":"Constructors","text":"Container [jvm]constructor(type: String, message_ts: String, channel_id: String, is_ephemeral: Boolean)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/#properties","title":"Properties","text":"Name Summary channel_id [jvm]val channel_id: String is_ephemeral [jvm]val is_ephemeral: Boolean message_ts [jvm]val message_ts: String type [jvm]val type: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/-container/","title":"Container - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/Container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/-container/#container","title":"Container","text":"[jvm]\\ constructor(type: String, message_ts: String, channel_id: String, is_ephemeral: Boolean)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/channel_id/","title":"channel_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/channel_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/channel_id/#channel_id","title":"channel_id","text":"[jvm]\\ val channel_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/is_ephemeral/","title":"is_ephemeral - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/is_ephemeral
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/is_ephemeral/#is_ephemeral","title":"is_ephemeral","text":"[jvm]\\ val is_ephemeral: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/message_ts/","title":"message_ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/message_ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/message_ts/#message_ts","title":"message_ts","text":"[jvm]\\ val message_ts: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/","title":"EnterpriseUser - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/#enterpriseuser","title":"EnterpriseUser","text":"[jvm]\\ data class EnterpriseUser@JvmOverloadsconstructor(val enterprise_id: String? = null, val enterprise_name: String? = null, val id: String? = null, val is_admin: Boolean? = null, val is_owner: Boolean? = null, val teams: Array<String>? = null)
An object containing info related to an Enterprise Grid user.
https://api.slack.com/enterprise/grid
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/#constructors","title":"Constructors","text":"EnterpriseUser [jvm]@JvmOverloadsconstructor(enterprise_id: String? = null, enterprise_name: String? = null, id: String? = null, is_admin: Boolean? = null, is_owner: Boolean? = null, teams: Array<String>? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/#properties","title":"Properties","text":"Name Summary enterprise_id [jvm]val enterprise_id: String? = nullA unique ID for the Enterprise Grid organization this user belongs to. enterprise_name [jvm]val enterprise_name: String? = nullA display name for the Enterprise Grid organization. id [jvm]val id: String? = nullThis user\u2019s ID - some Grid users have a kind of dual identity \u2014 a local, workspace-centric user ID as well as a Grid-wise user ID, called the Enterprise user ID. In most cases these IDs can be used interchangeably, but when it is provided, we strongly recommend using this Enterprise user id over the root level user id field. is_admin [jvm]val is_admin: Boolean? = nullIndicates whether the user is an Admin of the Enterprise Grid organization. is_owner [jvm]val is_owner: Boolean? = nullIndicates whether the user is an Owner of the Enterprise Grid organization. teams [jvm]val teams: Array<String>? = nullAn array of workspace IDs that are in the Enterprise Grid organization."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/-enterprise-user/","title":"EnterpriseUser - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/EnterpriseUser
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/-enterprise-user/#enterpriseuser","title":"EnterpriseUser","text":"[jvm]\\
@JvmOverloads
constructor(enterprise_id: String? = null, enterprise_name: String? = null, id: String? = null, is_admin: Boolean? = null, is_owner: Boolean? = null, teams: Array<String>? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_id/","title":"enterprise_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/enterprise_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_id/#enterprise_id","title":"enterprise_id","text":"[jvm]\\ val enterprise_id: String? = null
A unique ID for the Enterprise Grid organization this user belongs to.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_name/","title":"enterprise_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/enterprise_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_name/#enterprise_name","title":"enterprise_name","text":"[jvm]\\ val enterprise_name: String? = null
A display name for the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/id/#id","title":"id","text":"[jvm]\\ val id: String? = null
This user\u2019s ID - some Grid users have a kind of dual identity \u2014 a local, workspace-centric user ID as well as a Grid-wise user ID, called the Enterprise user ID. In most cases these IDs can be used interchangeably, but when it is provided, we strongly recommend using this Enterprise user id over the root level user id field.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_admin/","title":"is_admin - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/is_admin
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_admin/#is_admin","title":"is_admin","text":"[jvm]\\ val is_admin: Boolean? = null
Indicates whether the user is an Admin of the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_owner/","title":"is_owner - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/is_owner
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_owner/#is_owner","title":"is_owner","text":"[jvm]\\ val is_owner: Boolean? = null
Indicates whether the user is an Owner of the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/teams/","title":"teams - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/teams
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/teams/#teams","title":"teams","text":"[jvm]\\ val teams: Array<String>? = null
An array of workspace IDs that are in the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/","title":"GetUserResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/#getuserresponse","title":"GetUserResponse","text":"[jvm]\\ data class GetUserResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val user: UserData? = null)
Message received from slack after posting a message
https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/#constructors","title":"Constructors","text":"GetUserResponse [jvm]@JvmOverloadsconstructor(ok: Boolean, error: String? = null, user: UserData? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/#properties","title":"Properties","text":"Name Summary error [jvm]val error: String? = null ok [jvm]val ok: Boolean user [jvm]val user: UserData? = null"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/-get-user-response/","title":"GetUserResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/-get-user-response/#getuserresponse","title":"GetUserResponse","text":"[jvm]\\
@JvmOverloads
constructor(ok: Boolean, error: String? = null, user: UserData? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/error/","title":"error - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/error
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/error/#error","title":"error","text":"[jvm]\\ val error: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/ok/","title":"ok - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/ok/#ok","title":"ok","text":"[jvm]\\ val ok: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/user/","title":"user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/user/#user","title":"user","text":"[jvm]\\ val user: UserData? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/","title":"Id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/#id","title":"Id","text":"[jvm]\\ data class Id(val id: String, val name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/#constructors","title":"Constructors","text":"Id [jvm]constructor(id: String, name: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/#properties","title":"Properties","text":"Name Summary id [jvm]val id: String name [jvm]val name: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/-id/","title":"Id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id/Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/-id/#id","title":"Id","text":"[jvm]\\ constructor(id: String, name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/name/","title":"name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id/name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/","title":"Message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/#message","title":"Message","text":"[jvm]\\ data class Message(val bot_id: String, val type: String, val text: String, val user: String, val ts: String, val app_id: String, val blocks: List<Block>, val team: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/#constructors","title":"Constructors","text":"Message [jvm]constructor(bot_id: String, type: String, text: String, user: String, ts: String, app_id: String, blocks: List<Block>, team: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/#properties","title":"Properties","text":"Name Summary app_id [jvm]val app_id: String blocks [jvm]val blocks: List<Block> bot_id [jvm]val bot_id: String team [jvm]val team: String text [jvm]val text: String ts [jvm]val ts: String type [jvm]val type: String user [jvm]val user: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/-message/","title":"Message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/Message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/-message/#message","title":"Message","text":"[jvm]\\ constructor(bot_id: String, type: String, text: String, user: String, ts: String, app_id: String, blocks: List<Block>, team: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/app_id/","title":"app_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/app_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/app_id/#app_id","title":"app_id","text":"[jvm]\\ val app_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/blocks/","title":"blocks - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/blocks
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/blocks/#blocks","title":"blocks","text":"[jvm]\\ val blocks: List<Block>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/bot_id/","title":"bot_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/bot_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/bot_id/#bot_id","title":"bot_id","text":"[jvm]\\ val bot_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/team/","title":"team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/team/#team","title":"team","text":"[jvm]\\ val team: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/ts/","title":"ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/ts/#ts","title":"ts","text":"[jvm]\\ val ts: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/user/","title":"user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/user/#user","title":"user","text":"[jvm]\\ val user: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/","title":"MrkdwnBuilder - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/#mrkdwnbuilder","title":"MrkdwnBuilder","text":"[jvm]\\ class MrkdwnBuilder
Mrkdwn is Slack\u2019s weird thing that isn\u2019t Markdown. This class attempts to implement proper escaping and formatting.
SlackApi.postMessage and SlackApi.postConfirmation can both post JSON with markdown formatting. SlackJson.TextJson allows you to set the type as plain text or markdown.
Note that the Mrkdwn docs aren\u2019t particularly helpful here.
Note that this implementation is more conservative about encoding than strictly necessary. For example, it escapes things like the colon at the end of Notice:, even though colons only really need to be escaped when they signal an emoji (:smile:).
https://api.slack.com/reference/surfaces/formatting#basics
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/#constructors","title":"Constructors","text":"MrkdwnBuilder [jvm]constructor()"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/#functions","title":"Functions","text":"Name Summary append [jvm]fun append(s: String) appendBlockquotePrefix [jvm]fun appendBlockquotePrefix() appendLink [jvm]fun appendLink(url: String, label: String) build [jvm]fun build(): String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/-mrkdwn-builder/","title":"MrkdwnBuilder - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/MrkdwnBuilder
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/-mrkdwn-builder/#mrkdwnbuilder","title":"MrkdwnBuilder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-blockquote-prefix/","title":"appendBlockquotePrefix - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/appendBlockquotePrefix
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-blockquote-prefix/#appendblockquoteprefix","title":"appendBlockquotePrefix","text":"[jvm]\\ fun appendBlockquotePrefix()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-link/","title":"appendLink - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/appendLink
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-link/#appendlink","title":"appendLink","text":"[jvm]\\ fun appendLink(url: String, label: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append/","title":"append - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/append
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append/#append","title":"append","text":"[jvm]\\ fun append(s: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/build/","title":"build - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/build
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/build/#build","title":"build","text":"[jvm]\\ fun build(): String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/","title":"PostMessageRequest - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/#postmessagerequest","title":"PostMessageRequest","text":"[jvm]\\ data class PostMessageRequest@JvmOverloadsconstructor(val channel: String, val response_type: String? = \"in_channel\", val blocks: List<Any>)
Message posted to /api/chat.postMessage
https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/#constructors","title":"Constructors","text":"PostMessageRequest [jvm]@JvmOverloadsconstructor(channel: String, response_type: String? = \"in_channel\", blocks: List<Any>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/#properties","title":"Properties","text":"Name Summary blocks [jvm]val blocks: List<Any> channel [jvm]val channel: String response_type [jvm]val response_type: String?"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/-post-message-request/","title":"PostMessageRequest - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/PostMessageRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/-post-message-request/#postmessagerequest","title":"PostMessageRequest","text":"[jvm]\\
@JvmOverloads
constructor(channel: String, response_type: String? = \"in_channel\", blocks: List<Any>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/blocks/","title":"blocks - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/blocks
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/blocks/#blocks","title":"blocks","text":"[jvm]\\ val blocks: List<Any>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/channel/#channel","title":"channel","text":"[jvm]\\ val channel: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/response_type/","title":"response_type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/response_type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/response_type/#response_type","title":"response_type","text":"[jvm]\\ val response_type: String?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/","title":"PostMessageResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/#postmessageresponse","title":"PostMessageResponse","text":"[jvm]\\ data class PostMessageResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val channel: String? = null, val ts: String? = null, val message: Message? = null)
Message received from slack after posting a message
https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/#constructors","title":"Constructors","text":"PostMessageResponse [jvm]@JvmOverloadsconstructor(ok: Boolean, error: String? = null, channel: String? = null, ts: String? = null, message: Message? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/#properties","title":"Properties","text":"Name Summary channel [jvm]val channel: String? = null error [jvm]val error: String? = null message [jvm]val message: Message? = null ok [jvm]val ok: Boolean ts [jvm]val ts: String? = null"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/-post-message-response/","title":"PostMessageResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/-post-message-response/#postmessageresponse","title":"PostMessageResponse","text":"[jvm]\\
@JvmOverloads
constructor(ok: Boolean, error: String? = null, channel: String? = null, ts: String? = null, message: Message? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/channel/#channel","title":"channel","text":"[jvm]\\ val channel: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/error/","title":"error - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/error
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/error/#error","title":"error","text":"[jvm]\\ val error: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/message/","title":"message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/message/#message","title":"message","text":"[jvm]\\ val message: Message? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ok/","title":"ok - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ok/#ok","title":"ok","text":"[jvm]\\ val ok: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ts/","title":"ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ts/#ts","title":"ts","text":"[jvm]\\ val ts: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/","title":"SlashCommand - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/#slashcommand","title":"SlashCommand","text":"[jvm]\\ data class SlashCommand(val command: String, val text: String, val response_url: String, val trigger_id: String, val user_id: String, val user_name: String, val channel_id: String, val api_app_id: String)
Payload received from Slack when user invokes slash command
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/#constructors","title":"Constructors","text":"SlashCommand [jvm]constructor(command: String, text: String, response_url: String, trigger_id: String, user_id: String, user_name: String, channel_id: String, api_app_id: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/#properties","title":"Properties","text":"Name Summary api_app_id [jvm]val api_app_id: String channel_id [jvm]val channel_id: String command [jvm]val command: String response_url [jvm]val response_url: String text [jvm]val text: String trigger_id [jvm]val trigger_id: String user_id [jvm]val user_id: String user_name [jvm]val user_name: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/-slash-command/","title":"SlashCommand - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/SlashCommand
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/-slash-command/#slashcommand","title":"SlashCommand","text":"[jvm]\\ constructor(command: String, text: String, response_url: String, trigger_id: String, user_id: String, user_name: String, channel_id: String, api_app_id: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/api_app_id/","title":"api_app_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/api_app_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/api_app_id/#api_app_id","title":"api_app_id","text":"[jvm]\\ val api_app_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/channel_id/","title":"channel_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/channel_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/channel_id/#channel_id","title":"channel_id","text":"[jvm]\\ val channel_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/command/","title":"command - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/command
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/command/#command","title":"command","text":"[jvm]\\ val command: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/response_url/","title":"response_url - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/response_url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/response_url/#response_url","title":"response_url","text":"[jvm]\\ val response_url: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/trigger_id/","title":"trigger_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/trigger_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/trigger_id/#trigger_id","title":"trigger_id","text":"[jvm]\\ val trigger_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_id/","title":"user_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/user_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_id/#user_id","title":"user_id","text":"[jvm]\\ val user_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_name/","title":"user_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/user_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_name/#user_name","title":"user_name","text":"[jvm]\\ val user_name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/","title":"SlashInteractionResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/#slashinteractionresponse","title":"SlashInteractionResponse","text":"[jvm]\\ data class SlashInteractionResponse@JvmOverloadsconstructor(val response_type: String? = \"in_channel\", val text: String)
Response sent back to Slack while slash commands are being handled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/#constructors","title":"Constructors","text":"SlashInteractionResponse [jvm]@JvmOverloadsconstructor(response_type: String? = \"in_channel\", text: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/#properties","title":"Properties","text":"Name Summary response_type [jvm]val response_type: String? text [jvm]val text: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/-slash-interaction-response/","title":"SlashInteractionResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse/SlashInteractionResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/-slash-interaction-response/#slashinteractionresponse","title":"SlashInteractionResponse","text":"[jvm]\\
@JvmOverloads
constructor(response_type: String? = \"in_channel\", text: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/response_type/","title":"response_type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse/response_type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/response_type/#response_type","title":"response_type","text":"[jvm]\\ val response_type: String?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/","title":"Team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/#team","title":"Team","text":"[jvm]\\ data class Team(val id: String, val domain: String, val enterprise_id: String, val enterprise_name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/#constructors","title":"Constructors","text":"Team [jvm]constructor(id: String, domain: String, enterprise_id: String, enterprise_name: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/#properties","title":"Properties","text":"Name Summary domain [jvm]val domain: String enterprise_id [jvm]val enterprise_id: String enterprise_name [jvm]val enterprise_name: String id [jvm]val id: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/-team/","title":"Team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/Team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/-team/#team","title":"Team","text":"[jvm]\\ constructor(id: String, domain: String, enterprise_id: String, enterprise_name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/domain/","title":"domain - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/domain
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/domain/#domain","title":"domain","text":"[jvm]\\ val domain: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_id/","title":"enterprise_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/enterprise_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_id/#enterprise_id","title":"enterprise_id","text":"[jvm]\\ val enterprise_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_name/","title":"enterprise_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/enterprise_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_name/#enterprise_name","title":"enterprise_name","text":"[jvm]\\ val enterprise_name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/","title":"Text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/#text","title":"Text","text":"[jvm]\\ data class Text@JvmOverloadsconstructor(val type: String, val text: String? = null, val emoji: Boolean? = null)
https://api.slack.com/reference/block-kit/composition-objects#text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/#constructors","title":"Constructors","text":"Text [jvm]@JvmOverloadsconstructor(type: String, text: String? = null, emoji: Boolean? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/#properties","title":"Properties","text":"Name Summary emoji [jvm]val emoji: Boolean? = nullThis must be null if type is \"mrkdwn\". text [jvm]val text: String? = null type [jvm]val type: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/-text/","title":"Text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/-text/#text","title":"Text","text":"[jvm]\\
@JvmOverloads
constructor(type: String, text: String? = null, emoji: Boolean? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/emoji/","title":"emoji - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/emoji
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/emoji/#emoji","title":"emoji","text":"[jvm]\\ val emoji: Boolean? = null
This must be null if type is \"mrkdwn\".
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/text/#text","title":"text","text":"[jvm]\\ val text: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/","title":"User - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/#user","title":"User","text":"[jvm]\\ data class User(val id: String, val username: String, val name: String, val team_id: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/#constructors","title":"Constructors","text":"User [jvm]constructor(id: String, username: String, name: String, team_id: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/#properties","title":"Properties","text":"Name Summary id [jvm]val id: String name [jvm]val name: String team_id [jvm]val team_id: String username [jvm]val username: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/-user/","title":"User - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/User
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/-user/#user","title":"User","text":"[jvm]\\ constructor(id: String, username: String, name: String, team_id: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/name/","title":"name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/team_id/","title":"team_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/team_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/team_id/#team_id","title":"team_id","text":"[jvm]\\ val team_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/username/","title":"username - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/username
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/username/#username","title":"username","text":"[jvm]\\ val username: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/","title":"UserData - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/#userdata","title":"UserData","text":"[jvm]\\ data class UserData@JvmOverloadsconstructor(val always_active: Boolean? = null, val color: String? = null, val deleted: Boolean? = null, val enterprise_user: EnterpriseUser? = null, val has_2fa: Boolean? = null, val id: String? = null, val is_admin: Boolean? = null, val is_app_user: Boolean? = null, val is_bot: Boolean? = null, val is_email_confirmed: Boolean? = null, val is_invited_user: Boolean? = null, val is_owner: Boolean? = null, val is_primary_owner: Boolean? = null, val is_restricted: Boolean? = null, val is_stranger: Boolean? = null, val is_ultra_restricted: Boolean? = null, val locale: String? = null, val name: String? = null, val profile: UserProfile? = null, val real_name: String? = null, val team_id: String? = null, val two_factor_type: String? = null, val tz: String? = null, val tz_label: String? = null, val tz_offset: Int? = null, val updated: Int? = null)
A user object contains information about a Slack workspace user. The composition of user objects can vary greatly depending on the API being used, or the context of each Slack workspace. Data that has not been supplied may not be present at all, may be null, or may contain an empty string.
https://api.slack.com/types/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/#constructors","title":"Constructors","text":"UserData [jvm]@JvmOverloadsconstructor(always_active: Boolean? = null, color: String? = null, deleted: Boolean? = null, enterprise_user: EnterpriseUser? = null, has_2fa: Boolean? = null, id: String? = null, is_admin: Boolean? = null, is_app_user: Boolean? = null, is_bot: Boolean? = null, is_email_confirmed: Boolean? = null, is_invited_user: Boolean? = null, is_owner: Boolean? = null, is_primary_owner: Boolean? = null, is_restricted: Boolean? = null, is_stranger: Boolean? = null, is_ultra_restricted: Boolean? = null, locale: String? = null, name: String? = null, profile: UserProfile? = null, real_name: String? = null, team_id: String? = null, two_factor_type: String? = null, tz: String? = null, tz_label: String? = null, tz_offset: Int? = null, updated: Int? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/#properties","title":"Properties","text":"Name Summary always_active [jvm]val always_active: Boolean? = nullIndicates that a bot user is set to be constantly active in presence status. color [jvm]val color: String? = nullUsed in some clients to display a special username color. deleted [jvm]val deleted: Boolean? = nullThis user has been deactivated when the value of this field is true. Otherwise, the value is false, or the field may not appear at all. enterprise_user [jvm]val enterprise_user: EnterpriseUser? = nullAn object containing info related to an Enterprise Grid user. has_2fa [jvm]val has_2fa: Boolean? = nullDescribes whether two-factor authentication is enabled for this user. Only visible if the user executing the call is an admin. id [jvm]val id: String? = nullIdentifier for this workspace user. It is unique to the workspace containing the user. Use this field together with team_id as a unique key when storing related data or when specifying the user in API requests. We recommend considering the format of the string to be an opaque value, and not to rely on a particular structure. is_admin [jvm]val is_admin: Boolean? = nullIndicates whether the user is an Admin of the current workspace. is_app_user [jvm]val is_app_user: Boolean? = nullIndicates whether the user is an authorized user of the calling app. is_bot [jvm]val is_bot: Boolean? = nullIndicates whether the user is actually a bot user. Bleep bloop. Note that Slackbot is special, so is_bot will be false for it. is_email_confirmed [jvm]val is_email_confirmed: Boolean? = nullIndicates whether the user email has been confirmed. is_invited_user [jvm]val is_invited_user: Boolean? = nullOnly present (and always true) when a user has been invited but has not yet signed in. Once the user signs in, this field is no longer present. is_owner [jvm]val is_owner: Boolean? = nullIndicates whether the user is an Owner of the current workspace. is_primary_owner [jvm]val is_primary_owner: Boolean? = nullIndicates whether the user is the Primary Owner of the current workspace. is_restricted [jvm]val is_restricted: Boolean? = nullIndicates whether the user is a guest user. Use in combination with the is_ultra_restricted field to check if the user is a single-channel guest user. is_stranger [jvm]val is_stranger: Boolean? = nullIf true, this user belongs to a different workspace than the one associated with your app\u2019s token, and isn\u2019t in any shared channels visible to your app. If false (or this field is not present), the user is either from the same workspace as associated with your app\u2019s token, or they are from a different workspace, but are in a shared channel that your app has access to. Read our shared channels docs for more detail. is_ultra_restricted [jvm]val is_ultra_restricted: Boolean? = nullIndicates whether the user is a single-channel guest. locale [jvm]val locale: String? = nullContains an IETF language code that represents this user\u2019s chosen display language for Slack clients. Useful for localizing your apps. name [jvm]val name: String? = nullDon\u2019t use this. It once indicated the preferred username for a user, but that behavior has fundamentally changed since. profile [jvm]val profile: UserProfile? = nullThe profile object contains the default fields of a user\u2019s workspace profile. A user\u2019s custom profile fields may be discovered using users.profile.get. real_name [jvm]val real_name: String? = nullThe user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared. team_id [jvm]val team_id: String? = nullThe ID of the team the user is on. two_factor_type [jvm]val two_factor_type: String? = nullIndicates the type of two-factor authentication in use. Only present if has_2fa is true. The value will be either app or sms. tz [jvm]val tz: String? = nullA human-readable string for the geographic timezone-related region this user has specified in their account. tz_label [jvm]val tz_label: String? = nullDescribes the commonly used name of the tz timezone. tz_offset [jvm]val tz_offset: Int? = nullIndicates the number of seconds to offset UTC time by for this user\u2019s tz. Changes silently if changed due to daylight savings. updated [jvm]val updated: Int? = nullA Unix timestamp indicating when the user object was last updated."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/-user-data/","title":"UserData - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/UserData
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/-user-data/#userdata","title":"UserData","text":"[jvm]\\
@JvmOverloads
constructor(always_active: Boolean? = null, color: String? = null, deleted: Boolean? = null, enterprise_user: EnterpriseUser? = null, has_2fa: Boolean? = null, id: String? = null, is_admin: Boolean? = null, is_app_user: Boolean? = null, is_bot: Boolean? = null, is_email_confirmed: Boolean? = null, is_invited_user: Boolean? = null, is_owner: Boolean? = null, is_primary_owner: Boolean? = null, is_restricted: Boolean? = null, is_stranger: Boolean? = null, is_ultra_restricted: Boolean? = null, locale: String? = null, name: String? = null, profile: UserProfile? = null, real_name: String? = null, team_id: String? = null, two_factor_type: String? = null, tz: String? = null, tz_label: String? = null, tz_offset: Int? = null, updated: Int? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/always_active/","title":"always_active - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/always_active
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/always_active/#always_active","title":"always_active","text":"[jvm]\\ val always_active: Boolean? = null
Indicates that a bot user is set to be constantly active in presence status.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/color/","title":"color - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/color
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/color/#color","title":"color","text":"[jvm]\\ val color: String? = null
Used in some clients to display a special username color.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/deleted/","title":"deleted - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/deleted
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/deleted/#deleted","title":"deleted","text":"[jvm]\\ val deleted: Boolean? = null
This user has been deactivated when the value of this field is true. Otherwise, the value is false, or the field may not appear at all.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/enterprise_user/","title":"enterprise_user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/enterprise_user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/enterprise_user/#enterprise_user","title":"enterprise_user","text":"[jvm]\\ val enterprise_user: EnterpriseUser? = null
An object containing info related to an Enterprise Grid user.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/has_2fa/","title":"has_2fa - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/has_2fa
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/has_2fa/#has_2fa","title":"has_2fa","text":"[jvm]\\ val has_2fa: Boolean? = null
Describes whether two-factor authentication is enabled for this user. Only visible if the user executing the call is an admin.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/id/#id","title":"id","text":"[jvm]\\ val id: String? = null
Identifier for this workspace user. It is unique to the workspace containing the user. Use this field together with team_id as a unique key when storing related data or when specifying the user in API requests. We recommend considering the format of the string to be an opaque value, and not to rely on a particular structure.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_admin/","title":"is_admin - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_admin
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_admin/#is_admin","title":"is_admin","text":"[jvm]\\ val is_admin: Boolean? = null
Indicates whether the user is an Admin of the current workspace.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_app_user/","title":"is_app_user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_app_user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_app_user/#is_app_user","title":"is_app_user","text":"[jvm]\\ val is_app_user: Boolean? = null
Indicates whether the user is an authorized user of the calling app.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_bot/","title":"is_bot - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_bot
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_bot/#is_bot","title":"is_bot","text":"[jvm]\\ val is_bot: Boolean? = null
Indicates whether the user is actually a bot user. Bleep bloop. Note that Slackbot is special, so is_bot will be false for it.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_email_confirmed/","title":"is_email_confirmed - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_email_confirmed
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_email_confirmed/#is_email_confirmed","title":"is_email_confirmed","text":"[jvm]\\ val is_email_confirmed: Boolean? = null
Indicates whether the user email has been confirmed.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_invited_user/","title":"is_invited_user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_invited_user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_invited_user/#is_invited_user","title":"is_invited_user","text":"[jvm]\\ val is_invited_user: Boolean? = null
Only present (and always true) when a user has been invited but has not yet signed in. Once the user signs in, this field is no longer present.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_owner/","title":"is_owner - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_owner
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_owner/#is_owner","title":"is_owner","text":"[jvm]\\ val is_owner: Boolean? = null
Indicates whether the user is an Owner of the current workspace.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_primary_owner/","title":"is_primary_owner - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_primary_owner
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_primary_owner/#is_primary_owner","title":"is_primary_owner","text":"[jvm]\\ val is_primary_owner: Boolean? = null
Indicates whether the user is the Primary Owner of the current workspace.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_restricted/","title":"is_restricted - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_restricted
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_restricted/#is_restricted","title":"is_restricted","text":"[jvm]\\ val is_restricted: Boolean? = null
Indicates whether the user is a guest user. Use in combination with the is_ultra_restricted field to check if the user is a single-channel guest user.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_stranger/","title":"is_stranger - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_stranger
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_stranger/#is_stranger","title":"is_stranger","text":"[jvm]\\ val is_stranger: Boolean? = null
If true, this user belongs to a different workspace than the one associated with your app\u2019s token, and isn\u2019t in any shared channels visible to your app. If false (or this field is not present), the user is either from the same workspace as associated with your app\u2019s token, or they are from a different workspace, but are in a shared channel that your app has access to. Read our shared channels docs for more detail.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_ultra_restricted/","title":"is_ultra_restricted - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_ultra_restricted
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_ultra_restricted/#is_ultra_restricted","title":"is_ultra_restricted","text":"[jvm]\\ val is_ultra_restricted: Boolean? = null
Indicates whether the user is a single-channel guest.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/locale/","title":"locale - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/locale
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/locale/#locale","title":"locale","text":"[jvm]\\ val locale: String? = null
Contains an IETF language code that represents this user\u2019s chosen display language for Slack clients. Useful for localizing your apps.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/name/","title":"name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/name/#name","title":"name","text":"[jvm]\\ val name: String? = null
Don\u2019t use this. It once indicated the preferred username for a user, but that behavior has fundamentally changed since.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/profile/","title":"profile - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/profile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/profile/#profile","title":"profile","text":"[jvm]\\ val profile: UserProfile? = null
The profile object contains the default fields of a user\u2019s workspace profile. A user\u2019s custom profile fields may be discovered using users.profile.get.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/real_name/","title":"real_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/real_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/real_name/#real_name","title":"real_name","text":"[jvm]\\ val real_name: String? = null
The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/team_id/","title":"team_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/team_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/team_id/#team_id","title":"team_id","text":"[jvm]\\ val team_id: String? = null
The ID of the team the user is on.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/two_factor_type/","title":"two_factor_type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/two_factor_type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/two_factor_type/#two_factor_type","title":"two_factor_type","text":"[jvm]\\ val two_factor_type: String? = null
Indicates the type of two-factor authentication in use. Only present if has_2fa is true. The value will be either app or sms.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz/","title":"tz - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/tz
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz/#tz","title":"tz","text":"[jvm]\\ val tz: String? = null
A human-readable string for the geographic timezone-related region this user has specified in their account.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_label/","title":"tz_label - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/tz_label
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_label/#tz_label","title":"tz_label","text":"[jvm]\\ val tz_label: String? = null
Describes the commonly used name of the tz timezone.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_offset/","title":"tz_offset - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/tz_offset
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_offset/#tz_offset","title":"tz_offset","text":"[jvm]\\ val tz_offset: Int? = null
Indicates the number of seconds to offset UTC time by for this user\u2019s tz. Changes silently if changed due to daylight savings.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/updated/","title":"updated - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/updated
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/updated/#updated","title":"updated","text":"[jvm]\\ val updated: Int? = null
A Unix timestamp indicating when the user object was last updated.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/","title":"Index","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/#userprofile","title":"UserProfile","text":"[jvm]\\ data class UserProfile@JvmOverloadsconstructor(val avatar_hash: String? = null, val display_name: String? = null, val display_name_normalized: String? = null, val email: String? = null, val fields: UserProfileFields? = null, val first_name: String? = null, val image_24: String? = null, val image_32: String? = null, val image_48: String? = null, val image_72: String? = null, val image_192: String? = null, val image_512: String? = null, val last_name: String? = null, val phone: String? = null, val pronouns: String? = null, val real_name: String? = null, val real_name_normalized: String? = null, val skype: String? = null, val start_date: String? = null, val status_emoji: String? = null, val status_expiration: Int? = null, val status_text: String? = null, val team: String? = null, val title: String? = null)
A user object contains information about a Slack workspace user.
https://api.slack.com/types/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/#constructors","title":"Constructors","text":"UserProfile [jvm]@JvmOverloadsconstructor(avatar_hash: String? = null, display_name: String? = null, display_name_normalized: String? = null, email: String? = null, fields: UserProfileFields? = null, first_name: String? = null, image_24: String? = null, image_32: String? = null, image_48: String? = null, image_72: String? = null, image_192: String? = null, image_512: String? = null, last_name: String? = null, phone: String? = null, pronouns: String? = null, real_name: String? = null, real_name_normalized: String? = null, skype: String? = null, start_date: String? = null, status_emoji: String? = null, status_expiration: Int? = null, status_text: String? = null, team: String? = null, title: String? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/#properties","title":"Properties","text":"Name Summary avatar_hash [jvm]val avatar_hash: String? = nullThe hash identifier for the user\u2019s avatar image. display_name [jvm]val display_name: String? = nullThe display name the user has chosen to identify themselves by in their workspace profile. Do not use this field as a unique identifier for a user, as it may change at any time. Instead, use id and team_id in concert. display_name_normalized [jvm]val display_name_normalized: String? = nullThe display_name field, but with any non-Latin characters filtered out. email [jvm]val email: String? = nullA valid email address for the user. It cannot have spaces and must have an @ and a domain. It cannot be in use by another member of the same team. Changing a user\u2019s email address will send an email to both the old and new addresses and post a slackbot to the user informing them of the change. This field can only be changed by admins for users on paid teams. fields [jvm]val fields: UserProfileFields? = nullAll the custom profile fields for the user. first_name [jvm]val first_name: String? = nullThe user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name. image_192 [jvm]val image_192: String? = nullURL pointing to a 192x192 pixel image representing the user\u2019s profile picture. image_24 [jvm]val image_24: String? = nullURL pointing to a 24x24 pixel image representing the user\u2019s profile picture. image_32 [jvm]val image_32: String? = nullURL pointing to a 32x32 pixel image representing the user\u2019s profile picture. image_48 [jvm]val image_48: String? = nullURL pointing to a 48x48 pixel image representing the user\u2019s profile picture. image_512 [jvm]val image_512: String? = nullURL pointing to a 512x512 pixel image representing the user\u2019s profile picture. image_72 [jvm]val image_72: String? = nullURL pointing to a 72x72 pixel image representing the user\u2019s profile picture. last_name [jvm]val last_name: String? = nullThe user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name. phone [jvm]val phone: String? = nullThe user\u2019s phone number, in any format. pronouns [jvm]val pronouns: String? = nullThe pronouns the user prefers to be addressed by. real_name [jvm]val real_name: String? = nullThe user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared. real_name_normalized [jvm]val real_name_normalized: String? = nullThe real_name field, but with any non-Latin characters filtered out. skype [jvm]val skype: String? = nullA shadow from a bygone era. It will always be an empty string and cannot be set otherwise. start_date [jvm]val start_date: String? = nullThe date the person joined the organization. Only available if Slack Atlas is enabled. status_emoji [jvm]val status_emoji: String? = nullThe displayed emoji that is enabled for the Slack team, such as \":train:\". status_expiration [jvm]val status_expiration: Int? = nullThe Unix timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire. status_text [jvm]val status_text: String? = nullThe displayed text of up to 100 characters. We strongly encourage brevity. team [jvm]val team: String? = nullThe ID of the team the user is on. title [jvm]val title: String? = nullThe user\u2019s title."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/-user-profile/","title":"user profile","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/UserProfile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/-user-profile/#userprofile","title":"UserProfile","text":"[jvm]\\
@JvmOverloads
constructor(avatar_hash: String? = null, display_name: String? = null, display_name_normalized: String? = null, email: String? = null, fields: UserProfileFields? = null, first_name: String? = null, image_24: String? = null, image_32: String? = null, image_48: String? = null, image_72: String? = null, image_192: String? = null, image_512: String? = null, last_name: String? = null, phone: String? = null, pronouns: String? = null, real_name: String? = null, real_name_normalized: String? = null, skype: String? = null, start_date: String? = null, status_emoji: String? = null, status_expiration: Int? = null, status_text: String? = null, team: String? = null, title: String? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/avatar_hash/","title":"avatar_hash - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/avatar_hash
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/avatar_hash/#avatar_hash","title":"avatar_hash","text":"[jvm]\\ val avatar_hash: String? = null
The hash identifier for the user\u2019s avatar image.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name/","title":"display_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/display_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name/#display_name","title":"display_name","text":"[jvm]\\ val display_name: String? = null
The display name the user has chosen to identify themselves by in their workspace profile. Do not use this field as a unique identifier for a user, as it may change at any time. Instead, use id and team_id in concert.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name_normalized/","title":"display_name_normalized - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/display_name_normalized
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name_normalized/#display_name_normalized","title":"display_name_normalized","text":"[jvm]\\ val display_name_normalized: String? = null
The display_name field, but with any non-Latin characters filtered out.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/email/","title":"email - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/email
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/email/#email","title":"email","text":"[jvm]\\ val email: String? = null
A valid email address for the user. It cannot have spaces and must have an @ and a domain. It cannot be in use by another member of the same team. Changing a user\u2019s email address will send an email to both the old and new addresses and post a slackbot to the user informing them of the change. This field can only be changed by admins for users on paid teams.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/fields/","title":"fields - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/fields
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/fields/#fields","title":"fields","text":"[jvm]\\ val fields: UserProfileFields? = null
All the custom profile fields for the user.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/first_name/","title":"first_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/first_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/first_name/#first_name","title":"first_name","text":"[jvm]\\ val first_name: String? = null
The user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_192/","title":"image_192 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_192
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_192/#image_192","title":"image_192","text":"[jvm]\\ val image_192: String? = null
URL pointing to a 192x192 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_24/","title":"image_24 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_24
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_24/#image_24","title":"image_24","text":"[jvm]\\ val image_24: String? = null
URL pointing to a 24x24 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_32/","title":"image_32 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_32
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_32/#image_32","title":"image_32","text":"[jvm]\\ val image_32: String? = null
URL pointing to a 32x32 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_48/","title":"image_48 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_48
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_48/#image_48","title":"image_48","text":"[jvm]\\ val image_48: String? = null
URL pointing to a 48x48 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_512/","title":"image_512 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_512
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_512/#image_512","title":"image_512","text":"[jvm]\\ val image_512: String? = null
URL pointing to a 512x512 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_72/","title":"image_72 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_72
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_72/#image_72","title":"image_72","text":"[jvm]\\ val image_72: String? = null
URL pointing to a 72x72 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/last_name/","title":"last_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/last_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/last_name/#last_name","title":"last_name","text":"[jvm]\\ val last_name: String? = null
The user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/phone/","title":"phone - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/phone
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/phone/#phone","title":"phone","text":"[jvm]\\ val phone: String? = null
The user\u2019s phone number, in any format.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/pronouns/","title":"pronouns - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/pronouns
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/pronouns/#pronouns","title":"pronouns","text":"[jvm]\\ val pronouns: String? = null
The pronouns the user prefers to be addressed by.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name/","title":"real_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/real_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name/#real_name","title":"real_name","text":"[jvm]\\ val real_name: String? = null
The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name_normalized/","title":"real_name_normalized - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/real_name_normalized
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name_normalized/#real_name_normalized","title":"real_name_normalized","text":"[jvm]\\ val real_name_normalized: String? = null
The real_name field, but with any non-Latin characters filtered out.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/skype/","title":"skype - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/skype
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/skype/#skype","title":"skype","text":"[jvm]\\ val skype: String? = null
A shadow from a bygone era. It will always be an empty string and cannot be set otherwise.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/start_date/","title":"start_date - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/start_date
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/start_date/#start_date","title":"start_date","text":"[jvm]\\ val start_date: String? = null
The date the person joined the organization. Only available if Slack Atlas is enabled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_emoji/","title":"status_emoji - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/status_emoji
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_emoji/#status_emoji","title":"status_emoji","text":"[jvm]\\ val status_emoji: String? = null
The displayed emoji that is enabled for the Slack team, such as \":train:\".
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_expiration/","title":"status_expiration - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/status_expiration
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_expiration/#status_expiration","title":"status_expiration","text":"[jvm]\\ val status_expiration: Int? = null
The Unix timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_text/","title":"status_text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/status_text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_text/#status_text","title":"status_text","text":"[jvm]\\ val status_text: String? = null
The displayed text of up to 100 characters. We strongly encourage brevity.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/team/","title":"team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/team/#team","title":"team","text":"[jvm]\\ val team: String? = null
The ID of the team the user is on.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/title/","title":"title - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/title
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/title/#title","title":"title","text":"[jvm]\\ val title: String? = null
The user\u2019s title.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/","title":"Index","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/#userprofilefields","title":"UserProfileFields","text":"[jvm]\\ data class UserProfileFields@JvmOverloadsconstructor(val display_name: String?, val email: String?, val first_name: String?, val last_name: String?, val phone: String?, val pronouns: String?, val real_name: String?, val start_date: String?, val title: String?)
The following fields are the default fields of a user\u2019s workspace profile.
https://api.slack.com/types/user#profile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/#constructors","title":"Constructors","text":"UserProfileFields [jvm]@JvmOverloadsconstructor(display_name: String?, email: String?, first_name: String?, last_name: String?, phone: String?, pronouns: String?, real_name: String?, start_date: String?, title: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/#properties","title":"Properties","text":"Name Summary display_name [jvm]val display_name: String?The display name the user has chosen to identify themselves by in their workspace profile. email [jvm]val email: String?A valid email address. It cannot have spaces, or be in use by another member of the same team. It must have an @ and a domain. Changing a user\u2019s email address will send an email to both the old and new addresses, and also post a slackbot message to the user informing them of the change. You cannot update your own email using this method. This field can only be changed by admins for users on paid teams. first_name [jvm]val first_name: String?The user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name. last_name [jvm]val last_name: String?The user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name. phone [jvm]val phone: String?The user\u2019s phone number, in any format. pronouns [jvm]val pronouns: String?The user\u2019s pronouns. real_name [jvm]val real_name: String?The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared. start_date [jvm]val start_date: String?The date the person joined the organization. Only available if Slack Atlas is enabled. title [jvm]val title: String?The user\u2019s title."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/-user-profile-fields/","title":"user profile fields","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/UserProfileFields
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/-user-profile-fields/#userprofilefields","title":"UserProfileFields","text":"[jvm]\\
@JvmOverloads
constructor(display_name: String?, email: String?, first_name: String?, last_name: String?, phone: String?, pronouns: String?, real_name: String?, start_date: String?, title: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/display_name/","title":"display_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/display_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/display_name/#display_name","title":"display_name","text":"[jvm]\\ val display_name: String?
The display name the user has chosen to identify themselves by in their workspace profile.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/email/","title":"email - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/email
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/email/#email","title":"email","text":"[jvm]\\ val email: String?
A valid email address. It cannot have spaces, or be in use by another member of the same team. It must have an @ and a domain. Changing a user\u2019s email address will send an email to both the old and new addresses, and also post a slackbot message to the user informing them of the change. You cannot update your own email using this method. This field can only be changed by admins for users on paid teams.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/first_name/","title":"first_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/first_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/first_name/#first_name","title":"first_name","text":"[jvm]\\ val first_name: String?
The user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/last_name/","title":"last_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/last_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/last_name/#last_name","title":"last_name","text":"[jvm]\\ val last_name: String?
The user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/phone/","title":"phone - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/phone
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/phone/#phone","title":"phone","text":"[jvm]\\ val phone: String?
The user\u2019s phone number, in any format.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/pronouns/","title":"pronouns - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/pronouns
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/pronouns/#pronouns","title":"pronouns","text":"[jvm]\\ val pronouns: String?
The user\u2019s pronouns.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/real_name/","title":"real_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/real_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/real_name/#real_name","title":"real_name","text":"[jvm]\\ val real_name: String?
The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/start_date/","title":"start_date - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/start_date
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/start_date/#start_date","title":"start_date","text":"[jvm]\\ val start_date: String?
The date the person joined the organization. Only available if Slack Atlas is enabled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/title/","title":"title - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/title
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/title/#title","title":"title","text":"[jvm]\\ val title: String?
The user\u2019s title.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/","title":"Values - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/#values","title":"Values","text":"[jvm]\\ data class Values(val text: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/#constructors","title":"Constructors","text":"Values [jvm]constructor(text: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/#properties","title":"Properties","text":"Name Summary text [jvm]val text: String?"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/-values/","title":"Values - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Values/Values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/-values/#values","title":"Values","text":"[jvm]\\ constructor(text: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Values/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/text/#text","title":"text","text":"[jvm]\\ val text: String?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack.webapi.interceptors
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/#types","title":"Types","text":"Name Summary SlackClientInterceptor [jvm]@Singletonclass SlackClientInterceptor@Injectconstructor(val config: SlackConfig) : Interceptor SlackSignedRequestsInterceptor [jvm]@Singletonclass SlackSignedRequestsInterceptor@Injectconstructor(clock: Clock, slackConfig: SlackConfig) : NetworkInterceptor SlackSignedRequestsOnly [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])annotation class SlackSignedRequestsOnly"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/","title":"SlackClientInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#slackclientinterceptor","title":"SlackClientInterceptor","text":"[jvm]\\ @Singleton
class SlackClientInterceptor@Injectconstructor(val config: SlackConfig) : Interceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#constructors","title":"Constructors","text":"SlackClientInterceptor [jvm]@Injectconstructor(config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#properties","title":"Properties","text":"Name Summary config [jvm]val config: SlackConfig"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): ResponseThe SlackClientInterceptor intercepts outgoing requests to Slack and chains the bearer token to the request. This token is provided by the Slack API when a Slack app is originally created. https://api.slack.com/web#url-encoded-bodies"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/-slack-client-interceptor/","title":"SlackClientInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor/SlackClientInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/-slack-client-interceptor/#slackclientinterceptor","title":"SlackClientInterceptor","text":"[jvm]\\
@Inject
constructor(config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/config/","title":"config - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor/config
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/config/#config","title":"config","text":"[jvm]\\ val config: SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/intercept/","title":"intercept - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor/intercept
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response
The SlackClientInterceptor intercepts outgoing requests to Slack and chains the bearer token to the request. This token is provided by the Slack API when a Slack app is originally created. https://api.slack.com/web#url-encoded-bodies
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/","title":"SlackSignedRequestsInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#slacksignedrequestsinterceptor","title":"SlackSignedRequestsInterceptor","text":"[jvm]\\ @Singleton
class SlackSignedRequestsInterceptor@Injectconstructor(clock: Clock, slackConfig: SlackConfig) : NetworkInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#constructors","title":"Constructors","text":"SlackSignedRequestsInterceptor [jvm]@Injectconstructor(clock: Clock, slackConfig: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor) : NetworkInterceptor.Factory"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)The SlackSignedRequestsInterceptor verifies that the incoming request is authorized by using the signing secret provided from Slack and cross-checking it against slack\u2019s incoming header with a signature https://api.slack.com/authentication/verifying-requests-from-slack"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-slack-signed-requests-interceptor/","title":"SlackSignedRequestsInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/SlackSignedRequestsInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-slack-signed-requests-interceptor/#slacksignedrequestsinterceptor","title":"SlackSignedRequestsInterceptor","text":"[jvm]\\
@Inject
constructor(clock: Clock, slackConfig: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/intercept/","title":"intercept - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/intercept
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
The SlackSignedRequestsInterceptor verifies that the incoming request is authorized by using the signing secret provided from Slack and cross-checking it against slack\u2019s incoming header with a signature https://api.slack.com/authentication/verifying-requests-from-slack
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/","title":"Factory - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/Factory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor) : NetworkInterceptor.Factory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/-factory/","title":"Factory - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/Factory/Factory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/create/","title":"create - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/Factory/create
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-only/","title":"SlackSignedRequestsOnly - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsOnly
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-only/#slacksignedrequestsonly","title":"SlackSignedRequestsOnly","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])
annotation class SlackSignedRequestsOnly
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/#types","title":"Types","text":"Name Summary SlashCommandHandler [jvm]abstract class SlashCommandHandler(val slackApi: SlackApi)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/","title":"SlashCommandHandler - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#slashcommandhandler","title":"SlashCommandHandler","text":"[jvm]\\ abstract class SlashCommandHandler(val slackApi: SlackApi)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#constructors","title":"Constructors","text":"SlashCommandHandler [jvm]constructor(slackApi: SlackApi)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#properties","title":"Properties","text":"Name Summary slackApi [jvm]open val slackApi: SlackApi"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#functions","title":"Functions","text":"Name Summary handle [jvm]abstract fun handle(slashCommandJson: SlashCommand): BooleanBusiness logic to handle the slash command sent from the user https://api.slack.com/interactivity/slash-commands Returns true if slashCommandJson was handled. sendSlackConfirmation [jvm]open fun sendSlackConfirmation(channelId: String, text: String, responseUrl: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/-slash-command-handler/","title":"SlashCommandHandler - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/SlashCommandHandler
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/-slash-command-handler/#slashcommandhandler","title":"SlashCommandHandler","text":"[jvm]\\ constructor(slackApi: SlackApi)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/handle/","title":"handle - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/handle
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/handle/#handle","title":"handle","text":"[jvm]\\ abstract fun handle(slashCommandJson: SlashCommand): Boolean
Business logic to handle the slash command sent from the user https://api.slack.com/interactivity/slash-commands Returns true if slashCommandJson was handled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/send-slack-confirmation/","title":"sendSlackConfirmation - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/sendSlackConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/send-slack-confirmation/#sendslackconfirmation","title":"sendSlackConfirmation","text":"[jvm]\\ open fun sendSlackConfirmation(channelId: String, text: String, responseUrl: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/slack-api/","title":"slackApi - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/slackApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/slack-api/#slackapi","title":"slackApi","text":"[jvm]\\ open val slackApi: SlackApi
"},{"location":"0.x/misk-sqldelight/","title":"misk-sqldelight - Misk","text":"//misk-sqldelight
"},{"location":"0.x/misk-sqldelight/#misk-sqldelight","title":"misk-sqldelight","text":""},{"location":"0.x/misk-sqldelight/#packages","title":"Packages","text":"Name misk.sqldelight"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/","title":"Package-level declarations - Misk","text":"//misk-sqldelight/misk.sqldelight
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/#types","title":"Types","text":"Name Summary RetryingTransacter [jvm]abstract class RetryingTransacter@JvmOverloadsconstructor(delegate: Transacter, val options: TransacterOptions = TransacterOptions()) : Transacter TransacterOptions [jvm]data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val minRetryDelayMillis: Long = 100, val maxRetryDelayMillis: Long = 500, val retryJitterMillis: Long = 400)"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/","title":"RetryingTransacter - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#retryingtransacter","title":"RetryingTransacter","text":"[jvm]\\ abstract class RetryingTransacter@JvmOverloadsconstructor(delegate: Transacter, val options: TransacterOptions = TransacterOptions()) : Transacter
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#constructors","title":"Constructors","text":"RetryingTransacter [jvm]@JvmOverloadsconstructor(delegate: Transacter, options: TransacterOptions = TransacterOptions())"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#properties","title":"Properties","text":"Name Summary options [jvm]val options: TransacterOptions"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#functions","title":"Functions","text":"Name Summary transaction [jvm]open override fun transaction(noEnclosing: Boolean, body: TransactionWithoutReturn.() -> Unit) transactionWithResult [jvm]open override fun <R> transactionWithResult(noEnclosing: Boolean, bodyWithReturn: TransactionWithReturn<R>.() -> R): R"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/-retrying-transacter/","title":"RetryingTransacter - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/RetryingTransacter
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/-retrying-transacter/#retryingtransacter","title":"RetryingTransacter","text":"[jvm]\\
@JvmOverloads
constructor(delegate: Transacter, options: TransacterOptions = TransacterOptions())
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/options/","title":"options - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/options
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/options/#options","title":"options","text":"[jvm]\\ val options: TransacterOptions
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction-with-result/","title":"transactionWithResult - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/transactionWithResult
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction-with-result/#transactionwithresult","title":"transactionWithResult","text":"[jvm]\\ open override fun <R> transactionWithResult(noEnclosing: Boolean, bodyWithReturn: TransactionWithReturn<R>.() -> R): R
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction/","title":"transaction - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/transaction
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\ open override fun transaction(noEnclosing: Boolean, body: TransactionWithoutReturn.() -> Unit)
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\ data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val minRetryDelayMillis: Long = 100, val maxRetryDelayMillis: Long = 500, val retryJitterMillis: Long = 400)
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/#constructors","title":"Constructors","text":"TransacterOptions [jvm]@JvmOverloadsconstructor(maxAttempts: Int = 3, minRetryDelayMillis: Long = 100, maxRetryDelayMillis: Long = 500, retryJitterMillis: Long = 400)"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/#properties","title":"Properties","text":"Name Summary maxAttempts [jvm]val maxAttempts: Int = 3 maxRetryDelayMillis [jvm]val maxRetryDelayMillis: Long = 500 minRetryDelayMillis [jvm]val minRetryDelayMillis: Long = 100 retryJitterMillis [jvm]val retryJitterMillis: Long = 400"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/TransacterOptions
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\
@JvmOverloads
constructor(maxAttempts: Int = 3, minRetryDelayMillis: Long = 100, maxRetryDelayMillis: Long = 500, retryJitterMillis: Long = 400)
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-attempts/","title":"maxAttempts - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/maxAttempts
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-attempts/#maxattempts","title":"maxAttempts","text":"[jvm]\\ val maxAttempts: Int = 3
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-retry-delay-millis/","title":"maxRetryDelayMillis - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/maxRetryDelayMillis
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-retry-delay-millis/#maxretrydelaymillis","title":"maxRetryDelayMillis","text":"[jvm]\\ val maxRetryDelayMillis: Long = 500
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/min-retry-delay-millis/","title":"minRetryDelayMillis - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/minRetryDelayMillis
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/min-retry-delay-millis/#minretrydelaymillis","title":"minRetryDelayMillis","text":"[jvm]\\ val minRetryDelayMillis: Long = 100
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/retry-jitter-millis/","title":"retryJitterMillis - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/retryJitterMillis
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/retry-jitter-millis/#retryjittermillis","title":"retryJitterMillis","text":"[jvm]\\ val retryJitterMillis: Long = 400
"},{"location":"0.x/misk-tailwind/","title":"misk-tailwind - Misk","text":"//misk-tailwind
"},{"location":"0.x/misk-tailwind/#misk-tailwind","title":"misk-tailwind","text":""},{"location":"0.x/misk-tailwind/#packages","title":"Packages","text":"Name misk.tailwind misk.tailwind.components misk.tailwind.icons misk.tailwind.pages"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/","title":"Index","text":"//misk-tailwind/misk.tailwind
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/#types","title":"Types","text":"Name Summary Link [jvm]data class Link@JvmOverloadsconstructor(val label: String, val href: String, val style: Style? = null, val isSelected: Boolean = false, val isPageNavigation: Boolean = false, val dataTurbo: Boolean? = true, val openInNewTab: Boolean = false, val rawHtml: String? = null, val hoverText: String? = null)Defines a link (such as for ) with configuration including for styles and Hotwire Turbo handling. Style [jvm]interface Style"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/#functions","title":"Functions","text":"Name Summary TailwindHtmlLayout [jvm]fun TagConsumer<>.TailwindHtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-tailwind-html-layout/","title":"tailwind html layout","text":"//misk-tailwind/misk.tailwind/TailwindHtmlLayout
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-tailwind-html-layout/#tailwindhtmllayout","title":"TailwindHtmlLayout","text":"[jvm]\\ fun TagConsumer<>.TailwindHtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/","title":"Link - Misk","text":"//misk-tailwind/misk.tailwind/Link
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/#link","title":"Link","text":"[jvm]\\ data class Link@JvmOverloadsconstructor(val label: String, val href: String, val style: Style? = null, val isSelected: Boolean = false, val isPageNavigation: Boolean = false, val dataTurbo: Boolean? = true, val openInNewTab: Boolean = false, val rawHtml: String? = null, val hoverText: String? = null)
Defines a link (such as for ) with configuration including for styles and Hotwire Turbo handling.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/#constructors","title":"Constructors","text":"Link [jvm]@JvmOverloadsconstructor(label: String, href: String, style: Style? = null, isSelected: Boolean = false, isPageNavigation: Boolean = false, dataTurbo: Boolean? = true, openInNewTab: Boolean = false, rawHtml: String? = null, hoverText: String? = null)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/#properties","title":"Properties","text":"Name Summary dataTurbo [jvm]val dataTurbo: Boolean? = truenull: default true: preload false: disabled hoverText [jvm]val hoverText: String? = null href [jvm]val href: String isPageNavigation [jvm]val isPageNavigation: Boolean = falseThis forces page navigation vs within Turbo Frame navigation by adding a target=\"_top\" attribute. isSelected [jvm]val isSelected: Boolean = false label [jvm]val label: String openInNewTab [jvm]val openInNewTab: Boolean = false rawHtml [jvm]val rawHtml: String? = null style [jvm]val style: Style? = null"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/-link/","title":"Link - Misk","text":"//misk-tailwind/misk.tailwind/Link/Link
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/-link/#link","title":"Link","text":"[jvm]\\
@JvmOverloads
constructor(label: String, href: String, style: Style? = null, isSelected: Boolean = false, isPageNavigation: Boolean = false, dataTurbo: Boolean? = true, openInNewTab: Boolean = false, rawHtml: String? = null, hoverText: String? = null)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/data-turbo/","title":"dataTurbo - Misk","text":"//misk-tailwind/misk.tailwind/Link/dataTurbo
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/data-turbo/#dataturbo","title":"dataTurbo","text":"[jvm]\\ val dataTurbo: Boolean? = true
null: default true: preload false: disabled
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/hover-text/","title":"hoverText - Misk","text":"//misk-tailwind/misk.tailwind/Link/hoverText
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/hover-text/#hovertext","title":"hoverText","text":"[jvm]\\ val hoverText: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/href/","title":"href - Misk","text":"//misk-tailwind/misk.tailwind/Link/href
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/href/#href","title":"href","text":"[jvm]\\ val href: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-page-navigation/","title":"isPageNavigation - Misk","text":"//misk-tailwind/misk.tailwind/Link/isPageNavigation
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-page-navigation/#ispagenavigation","title":"isPageNavigation","text":"[jvm]\\ val isPageNavigation: Boolean = false
This forces page navigation vs within Turbo Frame navigation by adding a target=\"_top\" attribute.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-selected/","title":"isSelected - Misk","text":"//misk-tailwind/misk.tailwind/Link/isSelected
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-selected/#isselected","title":"isSelected","text":"[jvm]\\ val isSelected: Boolean = false
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/label/","title":"label - Misk","text":"//misk-tailwind/misk.tailwind/Link/label
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/label/#label","title":"label","text":"[jvm]\\ val label: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/open-in-new-tab/","title":"openInNewTab - Misk","text":"//misk-tailwind/misk.tailwind/Link/openInNewTab
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/open-in-new-tab/#openinnewtab","title":"openInNewTab","text":"[jvm]\\ val openInNewTab: Boolean = false
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/raw-html/","title":"rawHtml - Misk","text":"//misk-tailwind/misk.tailwind/Link/rawHtml
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/raw-html/#rawhtml","title":"rawHtml","text":"[jvm]\\ val rawHtml: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/style/","title":"style - Misk","text":"//misk-tailwind/misk.tailwind/Link/style
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/style/#style","title":"style","text":"[jvm]\\ val style: Style? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/","title":"Style - Misk","text":"//misk-tailwind/misk.tailwind/Style
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/#style","title":"Style","text":"[jvm]\\ interface Style
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/#properties","title":"Properties","text":"Name Summary classes [jvm]abstract val classes: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/classes/","title":"classes - Misk","text":"//misk-tailwind/misk.tailwind/Style/classes
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/classes/#classes","title":"classes","text":"[jvm]\\ abstract val classes: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/","title":"Package-level declarations - Misk","text":"//misk-tailwind/misk.tailwind.components
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/#types","title":"Types","text":"Name Summary AlertTheme [jvm]enum AlertTheme : Enum<AlertTheme>"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/#functions","title":"Functions","text":"Name Summary Alert [jvm]fun TagConsumer<*>.Alert(theme: AlertTheme, message: String?, label: String?, link: String?, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertError [jvm]fun TagConsumer<*>.AlertError(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertInfo [jvm]fun TagConsumer<*>.AlertInfo(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertInfoHighlight [jvm]fun TagConsumer<*>.AlertInfoHighlight(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertMessage [jvm]fun TagConsumer<*>.AlertMessage(successMessage: String?, errorMessage: String?, label: String?, link: String?) AlertSuccess [jvm]fun TagConsumer<*>.AlertSuccess(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) CodeBlock [jvm]fun TagConsumer<*>.CodeBlock(text: String) ToggleContainer [jvm]fun TagConsumer<>.ToggleContainer(buttonText: String, borderless: Boolean = false, menuBlock: TagConsumer<>.() -> Unit = {}, isOpen: Boolean = false, hiddenBlock: TagConsumer<*>.() -> Unit)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-error/","title":"AlertError - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertError
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-error/#alerterror","title":"AlertError","text":"[jvm]\\ fun TagConsumer<*>.AlertError(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info-highlight/","title":"AlertInfoHighlight - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertInfoHighlight
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info-highlight/#alertinfohighlight","title":"AlertInfoHighlight","text":"[jvm]\\ fun TagConsumer<*>.AlertInfoHighlight(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info/","title":"AlertInfo - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertInfo
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info/#alertinfo","title":"AlertInfo","text":"[jvm]\\ fun TagConsumer<*>.AlertInfo(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-message/","title":"AlertMessage - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertMessage
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-message/#alertmessage","title":"AlertMessage","text":"[jvm]\\ fun TagConsumer<*>.AlertMessage(successMessage: String?, errorMessage: String?, label: String?, link: String?)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-success/","title":"AlertSuccess - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertSuccess
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-success/#alertsuccess","title":"AlertSuccess","text":"[jvm]\\ fun TagConsumer<*>.AlertSuccess(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert/","title":"Alert - Misk","text":"//misk-tailwind/misk.tailwind.components/Alert
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert/#alert","title":"Alert","text":"[jvm]\\ fun TagConsumer<*>.Alert(theme: AlertTheme, message: String?, label: String?, link: String?, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-code-block/","title":"CodeBlock - Misk","text":"//misk-tailwind/misk.tailwind.components/CodeBlock
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-code-block/#codeblock","title":"CodeBlock","text":"[jvm]\\ fun TagConsumer<*>.CodeBlock(text: String)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-toggle-container/","title":"ToggleContainer - Misk","text":"//misk-tailwind/misk.tailwind.components/ToggleContainer
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-toggle-container/#togglecontainer","title":"ToggleContainer","text":"[jvm]\\ fun TagConsumer<>.ToggleContainer(buttonText: String, borderless: Boolean = false, menuBlock: TagConsumer<>.() -> Unit = {}, isOpen: Boolean = false, hiddenBlock: TagConsumer<*>.() -> Unit)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/","title":"AlertTheme - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#alerttheme","title":"AlertTheme","text":"[jvm]\\ enum AlertTheme : Enum<AlertTheme>
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#entries","title":"Entries","text":"BLUE_HIGHLIGHT [jvm]BLUE_HIGHLIGHT BLUE [jvm]BLUE GREEN [jvm]GREEN RED [jvm]RED"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String entries [jvm]val entries: EnumEntries<AlertTheme>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AlertThemeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AlertTheme>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/background-color/","title":"backgroundColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/backgroundColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/background-color/#backgroundcolor","title":"backgroundColor","text":"[jvm]\\ val backgroundColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/entries/","title":"entries - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/entries
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AlertTheme>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/heading-text-color/","title":"headingTextColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/headingTextColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/heading-text-color/#headingtextcolor","title":"headingTextColor","text":"[jvm]\\ val headingTextColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/hover-text-color/","title":"hoverTextColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/hoverTextColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/hover-text-color/#hovertextcolor","title":"hoverTextColor","text":"[jvm]\\ val hoverTextColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/icon-color/","title":"iconColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/iconColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/icon-color/#iconcolor","title":"iconColor","text":"[jvm]\\ val iconColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/text-color/","title":"textColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/textColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/text-color/#textcolor","title":"textColor","text":"[jvm]\\ val textColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/value-of/","title":"valueOf - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/valueOf
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AlertTheme
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/values/","title":"values - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/values
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AlertTheme>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e/","title":"BLUE - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/BLUE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e/#blue","title":"BLUE","text":"[jvm]\\ BLUE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e_-h-i-g-h-l-i-g-h-t/","title":"BLUE_HIGHLIGHT - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/BLUE_HIGHLIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e_-h-i-g-h-l-i-g-h-t/#blue_highlight","title":"BLUE_HIGHLIGHT","text":"[jvm]\\ BLUE_HIGHLIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e_-h-i-g-h-l-i-g-h-t/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-g-r-e-e-n/","title":"GREEN - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/GREEN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-g-r-e-e-n/#green","title":"GREEN","text":"[jvm]\\ GREEN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-g-r-e-e-n/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-r-e-d/","title":"RED - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/RED
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-r-e-d/#red","title":"RED","text":"[jvm]\\ RED
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-r-e-d/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/","title":"Package-level declarations - Misk","text":"//misk-tailwind/misk.tailwind.icons
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/#types","title":"Types","text":"Name Summary HeroiconProps [jvm]data class HeroiconProps@JvmOverloadsconstructor(val icon: Heroicons, val modifierClass: String? = null, val spanClass: String? = null) Heroicons [jvm]enum Heroicons : Enum<Heroicons> Tailwind Heroicons Kotlin Bindings https://heroicons.com/"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/#functions","title":"Functions","text":"Name Summary heroicon [jvm]fun TagConsumer<*>.heroicon(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)kotlinx.html component to use the above Heroicons enum to inline SVG icons."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/heroicon/","title":"heroicon - Misk","text":"//misk-tailwind/misk.tailwind.icons/heroicon
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/heroicon/#heroicon","title":"heroicon","text":"[jvm]\\ fun TagConsumer<*>.heroicon(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)
kotlinx.html component to use the above Heroicons enum to inline SVG icons.
div {\n heroicon(Heroicons.MINI_CHEVRON_DOWN)\n heroicon(Heroicons.MINI_CHEVRON_DOWN, \"text-gray-400 group-hover:text-gray-500\")\n}\njvm
modifierClass override of the icon\u2019s defaultModifierClass. For example if icon should have a different color, boldness\u2026etc then a modifierClass can be provided which overrides the icon\u2019s defaultModifierClass."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/","title":"HeroiconProps - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/#heroiconprops","title":"HeroiconProps","text":"[jvm]\\ data class HeroiconProps@JvmOverloadsconstructor(val icon: Heroicons, val modifierClass: String? = null, val spanClass: String? = null)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/#constructors","title":"Constructors","text":"HeroiconProps [jvm]@JvmOverloadsconstructor(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/#properties","title":"Properties","text":"Name Summary icon [jvm]val icon: Heroicons modifierClass [jvm]val modifierClass: String? = null spanClass [jvm]val spanClass: String? = null"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/-heroicon-props/","title":"HeroiconProps - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/HeroiconProps
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/-heroicon-props/#heroiconprops","title":"HeroiconProps","text":"[jvm]\\
@JvmOverloads
constructor(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/icon/","title":"icon - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/icon
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/icon/#icon","title":"icon","text":"[jvm]\\ val icon: Heroicons
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/modifier-class/","title":"modifierClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/modifierClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/modifier-class/#modifierclass","title":"modifierClass","text":"[jvm]\\ val modifierClass: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/span-class/","title":"spanClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/spanClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/span-class/#spanclass","title":"spanClass","text":"[jvm]\\ val spanClass: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/","title":"Heroicons - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#heroicons","title":"Heroicons","text":"[jvm]\\ enum Heroicons : Enum<Heroicons>
Tailwind Heroicons Kotlin Bindings https://heroicons.com/
Add any new icons as they are used.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#entries","title":"Entries","text":"OUTLINE_XMARK [jvm]OUTLINE_XMARK OUTLINE_HOME [jvm]OUTLINE_HOME OUTLINE_BARS_4 [jvm]OUTLINE_BARS_4 OUTLINE_CLOCK [jvm]OUTLINE_CLOCK OUTLINE_DOCUMENT_MAGNIFYING_GLASS [jvm]OUTLINE_DOCUMENT_MAGNIFYING_GLASS MINI_CHEVRON_UP_DOWN [jvm]MINI_CHEVRON_UP_DOWN QUEUE_LIST [jvm]QUEUE_LIST DOCUMENT_MAGNIFYING_GLASS [jvm]DOCUMENT_MAGNIFYING_GLASS BELL_ALERT [jvm]BELL_ALERT OUTLINE_BARS_3_CENTER_LEFT [jvm]OUTLINE_BARS_3_CENTER_LEFT MAGNIFYING_GLASS [jvm]MAGNIFYING_GLASS MINI_FUNNEL [jvm]MINI_FUNNEL MINI_CHEVRON_UP [jvm]MINI_CHEVRON_UP MINI_CHEVRON_DOWN [jvm]MINI_CHEVRON_DOWN MINI_ARROW_LONG_LEFT [jvm]MINI_ARROW_LONG_LEFT MINI_ARROW_LONG_RIGHT [jvm]MINI_ARROW_LONG_RIGHT MINI_ARROW_TOP_RIGHT_ON_SQUARE [jvm]MINI_ARROW_TOP_RIGHT_ON_SQUARE"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String entries [jvm]val entries: EnumEntries<Heroicons>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): HeroiconsReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Heroicons>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/default-modifier-class/","title":"defaultModifierClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/defaultModifierClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/default-modifier-class/#defaultmodifierclass","title":"defaultModifierClass","text":"[jvm]\\ val defaultModifierClass: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/entries/","title":"entries - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/entries
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Heroicons>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/id/","title":"id - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/id
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/raw-html/","title":"rawHtml - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/rawHtml
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/raw-html/#rawhtml","title":"rawHtml","text":"[jvm]\\ val rawHtml: (String) -> String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/svg-class/","title":"svgClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/svgClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/svg-class/#svgclass","title":"svgClass","text":"[jvm]\\ val svgClass: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/value-of/","title":"valueOf - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/valueOf
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Heroicons
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/values/","title":"values - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/values
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Heroicons>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-b-e-l-l_-a-l-e-r-t/","title":"BELL_ALERT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/BELL_ALERT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-b-e-l-l_-a-l-e-r-t/#bell_alert","title":"BELL_ALERT","text":"[jvm]\\ BELL_ALERT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-b-e-l-l_-a-l-e-r-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/","title":"DOCUMENT_MAGNIFYING_GLASS - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#document_magnifying_glass","title":"DOCUMENT_MAGNIFYING_GLASS","text":"[jvm]\\ DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/","title":"MAGNIFYING_GLASS - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#magnifying_glass","title":"MAGNIFYING_GLASS","text":"[jvm]\\ MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-l-e-f-t/","title":"MINI_ARROW_LONG_LEFT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_ARROW_LONG_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-l-e-f-t/#mini_arrow_long_left","title":"MINI_ARROW_LONG_LEFT","text":"[jvm]\\ MINI_ARROW_LONG_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-l-e-f-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-r-i-g-h-t/","title":"MINI_ARROW_LONG_RIGHT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_ARROW_LONG_RIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-r-i-g-h-t/#mini_arrow_long_right","title":"MINI_ARROW_LONG_RIGHT","text":"[jvm]\\ MINI_ARROW_LONG_RIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-r-i-g-h-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-t-o-p_-r-i-g-h-t_-o-n_-s-q-u-a-r-e/","title":"MINI_ARROW_TOP_RIGHT_ON_SQUARE - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_ARROW_TOP_RIGHT_ON_SQUARE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-t-o-p_-r-i-g-h-t_-o-n_-s-q-u-a-r-e/#mini_arrow_top_right_on_square","title":"MINI_ARROW_TOP_RIGHT_ON_SQUARE","text":"[jvm]\\ MINI_ARROW_TOP_RIGHT_ON_SQUARE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-t-o-p_-r-i-g-h-t_-o-n_-s-q-u-a-r-e/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-d-o-w-n/","title":"MINI_CHEVRON_DOWN - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_CHEVRON_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-d-o-w-n/#mini_chevron_down","title":"MINI_CHEVRON_DOWN","text":"[jvm]\\ MINI_CHEVRON_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-d-o-w-n/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p/","title":"MINI_CHEVRON_UP - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_CHEVRON_UP
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p/#mini_chevron_up","title":"MINI_CHEVRON_UP","text":"[jvm]\\ MINI_CHEVRON_UP
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p_-d-o-w-n/","title":"MINI_CHEVRON_UP_DOWN - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_CHEVRON_UP_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p_-d-o-w-n/#mini_chevron_up_down","title":"MINI_CHEVRON_UP_DOWN","text":"[jvm]\\ MINI_CHEVRON_UP_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p_-d-o-w-n/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-f-u-n-n-e-l/","title":"MINI_FUNNEL - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_FUNNEL
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-f-u-n-n-e-l/#mini_funnel","title":"MINI_FUNNEL","text":"[jvm]\\ MINI_FUNNEL
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-f-u-n-n-e-l/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_3_-c-e-n-t-e-r_-l-e-f-t/","title":"OUTLINE_BARS_3_CENTER_LEFT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_BARS_3_CENTER_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_3_-c-e-n-t-e-r_-l-e-f-t/#outline_bars_3_center_left","title":"OUTLINE_BARS_3_CENTER_LEFT","text":"[jvm]\\ OUTLINE_BARS_3_CENTER_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_3_-c-e-n-t-e-r_-l-e-f-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_4/","title":"OUTLINE_BARS_4 - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_BARS_4
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_4/#outline_bars_4","title":"OUTLINE_BARS_4","text":"[jvm]\\ OUTLINE_BARS_4
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_4/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-c-l-o-c-k/","title":"OUTLINE_CLOCK - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_CLOCK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-c-l-o-c-k/#outline_clock","title":"OUTLINE_CLOCK","text":"[jvm]\\ OUTLINE_CLOCK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-c-l-o-c-k/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/","title":"OUTLINE_DOCUMENT_MAGNIFYING_GLASS - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#outline_document_magnifying_glass","title":"OUTLINE_DOCUMENT_MAGNIFYING_GLASS","text":"[jvm]\\ OUTLINE_DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-h-o-m-e/","title":"OUTLINE_HOME - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_HOME
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-h-o-m-e/#outline_home","title":"OUTLINE_HOME","text":"[jvm]\\ OUTLINE_HOME
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-h-o-m-e/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-x-m-a-r-k/","title":"OUTLINE_XMARK - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_XMARK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-x-m-a-r-k/#outline_xmark","title":"OUTLINE_XMARK","text":"[jvm]\\ OUTLINE_XMARK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-x-m-a-r-k/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-q-u-e-u-e_-l-i-s-t/","title":"QUEUE_LIST - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/QUEUE_LIST
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-q-u-e-u-e_-l-i-s-t/#queue_list","title":"QUEUE_LIST","text":"[jvm]\\ QUEUE_LIST
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-q-u-e-u-e_-l-i-s-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/","title":"Index","text":"//misk-tailwind/misk.tailwind.pages
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/#types","title":"Types","text":"Name Summary MenuSection [jvm]data class MenuSection(val title: String, val links: List<Link>)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/#functions","title":"Functions","text":"Name Summary Navbar [jvm]fun TagConsumer<>.Navbar(appName: String, deployment: Deployment, homeHref: String, menuSections: List<MenuSection> = listOf(), content: TagConsumer<>.() -> Unit = {})"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-navbar/","title":"Navbar - Misk","text":"//misk-tailwind/misk.tailwind.pages/Navbar
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-navbar/#navbar","title":"Navbar","text":"[jvm]\\ fun TagConsumer<>.Navbar(appName: String, deployment: Deployment, homeHref: String, menuSections: List<MenuSection> = listOf(), content: TagConsumer<>.() -> Unit = {})
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/","title":"Index","text":"//misk-tailwind/misk.tailwind.pages/MenuSection
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/#menusection","title":"MenuSection","text":"[jvm]\\ data class MenuSection(val title: String, val links: List<Link>)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/#constructors","title":"Constructors","text":"MenuSection [jvm]constructor(title: String, links: List<Link>)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/#properties","title":"Properties","text":"Name Summary links [jvm]val links: List<Link> title [jvm]val title: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/-menu-section/","title":"menu section","text":"//misk-tailwind/misk.tailwind.pages/MenuSection/MenuSection
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/-menu-section/#menusection","title":"MenuSection","text":"[jvm]\\ constructor(title: String, links: List<Link>)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/links/","title":"links - Misk","text":"//misk-tailwind/misk.tailwind.pages/MenuSection/links
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/links/#links","title":"links","text":"[jvm]\\ val links: List<Link>
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/title/","title":"title - Misk","text":"//misk-tailwind/misk.tailwind.pages/MenuSection/title
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/title/#title","title":"title","text":"[jvm]\\ val title: String
"},{"location":"0.x/misk-testing/","title":"misk-testing - Misk","text":"//misk-testing
"},{"location":"0.x/misk-testing/#misk-testing","title":"misk-testing","text":""},{"location":"0.x/misk-testing/#packages","title":"Packages","text":"Name misk misk.cloud.fake.security.keys misk.concurrent misk.containers misk.logging misk.mockito misk.random misk.service misk.services misk.testing misk.time misk.web org.assertj.core.api"},{"location":"0.x/misk-testing/misk-testing/misk/","title":"Package-level declarations - Misk","text":"//misk-testing/misk
"},{"location":"0.x/misk-testing/misk-testing/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk/#types","title":"Types","text":"Name Summary MiskTestingServiceModule [jvm]class MiskTestingServiceModule : KAbstractModuleMiskTestingServiceModule should be installed in unit testing environments."},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/","title":"MiskTestingServiceModule - Misk","text":"//misk-testing/misk/MiskTestingServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/#misktestingservicemodule","title":"MiskTestingServiceModule","text":"[jvm]\\ class MiskTestingServiceModule : KAbstractModule
MiskTestingServiceModule should be installed in unit testing environments.
This should not contain application level fakes for testing. It includes a small, selective set of fake bindings to replace real bindings that cannot exist in a unit testing environment (e.g system env vars and filesystem dependencies).
"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/#constructors","title":"Constructors","text":"MiskTestingServiceModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/-misk-testing-service-module/","title":"MiskTestingServiceModule - Misk","text":"//misk-testing/misk/MiskTestingServiceModule/MiskTestingServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/-misk-testing-service-module/#misktestingservicemodule","title":"MiskTestingServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.cloud.fake.security.keys
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/#types","title":"Types","text":"Name Summary FakeKeyManagementModule [jvm]class FakeKeyManagementModule : KAbstractModule FakeKeyService [jvm]class FakeKeyService : KeyService"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/","title":"FakeKeyManagementModule - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyManagementModule
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/#fakekeymanagementmodule","title":"FakeKeyManagementModule","text":"[jvm]\\ class FakeKeyManagementModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/#constructors","title":"Constructors","text":"FakeKeyManagementModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/-fake-key-management-module/","title":"FakeKeyManagementModule - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyManagementModule/FakeKeyManagementModule
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/-fake-key-management-module/#fakekeymanagementmodule","title":"FakeKeyManagementModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/","title":"FakeKeyService - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/#fakekeyservice","title":"FakeKeyService","text":"[jvm]\\ class FakeKeyService : KeyService
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/#constructors","title":"Constructors","text":"FakeKeyService [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/#functions","title":"Functions","text":"Name Summary decrypt [jvm]open override fun decrypt(keyAlias: String, cipherText: ByteString): ByteString encrypt [jvm]open override fun encrypt(keyAlias: String, plainText: ByteString): ByteString"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/-fake-key-service/","title":"FakeKeyService - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService/FakeKeyService
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/-fake-key-service/#fakekeyservice","title":"FakeKeyService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/decrypt/","title":"decrypt - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService/decrypt
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/decrypt/#decrypt","title":"decrypt","text":"[jvm]\\ open override fun decrypt(keyAlias: String, cipherText: ByteString): ByteString
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/encrypt/","title":"encrypt - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService/encrypt
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/encrypt/#encrypt","title":"encrypt","text":"[jvm]\\ open override fun encrypt(keyAlias: String, plainText: ByteString): ByteString
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.concurrent
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/#types","title":"Types","text":"Name Summary FakeScheduledExecutorService [jvm]@Singletonclass FakeScheduledExecutorService@Injectconstructor(clock: Clock) : ScheduledExecutorService, ExecutorServiceScheduledExecutorService for testing that runs in the current thread and is triggered using thetick() method. An injected Clock is used to decide whether to execute a scheduled task. FakeSleeper [jvm]@Singletonclass FakeSleeper@Injectconstructor(clock: Clock) : SleeperSleeper for testing that blocks threads calling sleep, and checks whether the threads should wake using the tick() method. An injected Clock is used to decide whether to wake a thread. FakeSleeperModule [jvm]class FakeSleeperModule : KAbstractModule FakeTicker [jvm]@Singletonclass FakeTicker@Injectconstructor : Ticker, Sleeper"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/","title":"FakeScheduledExecutorService - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#fakescheduledexecutorservice","title":"FakeScheduledExecutorService","text":"[jvm]\\ @Singleton
class FakeScheduledExecutorService@Injectconstructor(clock: Clock) : ScheduledExecutorService, ExecutorService
ScheduledExecutorService for testing that runs in the current thread and is triggered using the tick() method. An injected Clock is used to decide whether to execute a scheduled task.
This service must always \"catch up\" to the clock, so fixed rate and fixed delay jobs are not different.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#constructors","title":"Constructors","text":"FakeScheduledExecutorService [jvm]@Injectconstructor(clock: Clock)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#types","title":"Types","text":"Name Summary ScheduledFutureTask [jvm]inner class ScheduledFutureTask<V>(var executeAt: Long, fixedDelay: Long, val clock: Clock, val task: () -> V) : FutureTask<V> , ScheduledFuture<V>"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]open override fun awaitTermination(p0: Long, p1: TimeUnit): Boolean execute [jvm]open override fun execute(p0: Runnable) invokeAll [jvm]open override fun <T : Any> invokeAll(p0: MutableCollection<out Callable<T>>): MutableList<Future<T>>open override fun <T : Any> invokeAll(p0: MutableCollection<out Callable<T>>, p1: Long, p2: TimeUnit): MutableList<Future<T>> invokeAny [jvm]open override fun <T : Any> invokeAny(p0: MutableCollection<out Callable<T>>): Topen override fun <T : Any> invokeAny(p0: MutableCollection<out Callable<T>>, p1: Long, p2: TimeUnit): T isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean schedule [jvm]open override fun schedule(command: Runnable, delay: Long, unit: TimeUnit): ScheduledFuture<Unit>open override fun <V> schedule(callable: Callable<V>, delay: Long, unit: TimeUnit): ScheduledFuture<V> scheduleAtFixedRate [jvm]open override fun scheduleAtFixedRate(command: Runnable, initialDelay: Long, period: Long, unit: TimeUnit): ScheduledFuture<*> scheduleWithFixedDelay [jvm]open override fun scheduleWithFixedDelay(command: Runnable, initialDelay: Long, delay: Long, unit: TimeUnit): ScheduledFuture<*> shutdown [jvm]open override fun shutdown() shutdownNow [jvm]open override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(p0: Runnable): Future<*>open override fun <T : Any> submit(p0: Callable<T>): Future<T>open override fun <T : Any> submit(p0: Runnable, p1: T): Future<T> tick [jvm]fun tick()Check the current time on the clock and run any scheduled tasks that are due."},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-fake-scheduled-executor-service/","title":"FakeScheduledExecutorService - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/FakeScheduledExecutorService
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-fake-scheduled-executor-service/#fakescheduledexecutorservice","title":"FakeScheduledExecutorService","text":"[jvm]\\
@Inject
constructor(clock: Clock)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/is-shutdown/","title":"isShutdown - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/isShutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/is-shutdown/#isshutdown","title":"isShutdown","text":"[jvm]\\ open override fun isShutdown(): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-at-fixed-rate/","title":"scheduleAtFixedRate - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/scheduleAtFixedRate
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-at-fixed-rate/#scheduleatfixedrate","title":"scheduleAtFixedRate","text":"[jvm]\\ open override fun scheduleAtFixedRate(command: Runnable, initialDelay: Long, period: Long, unit: TimeUnit): ScheduledFuture<*>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-with-fixed-delay/","title":"scheduleWithFixedDelay - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/scheduleWithFixedDelay
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-with-fixed-delay/#schedulewithfixeddelay","title":"scheduleWithFixedDelay","text":"[jvm]\\ open override fun scheduleWithFixedDelay(command: Runnable, initialDelay: Long, delay: Long, unit: TimeUnit): ScheduledFuture<*>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule/","title":"schedule - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/schedule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule/#schedule","title":"schedule","text":"[jvm]\\ open override fun schedule(command: Runnable, delay: Long, unit: TimeUnit): ScheduledFuture<Unit>
open override fun <V> schedule(callable: Callable<V>, delay: Long, unit: TimeUnit): ScheduledFuture<V>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/shutdown/","title":"shutdown - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/shutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/shutdown/#shutdown","title":"shutdown","text":"[jvm]\\ open override fun shutdown()
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/tick/","title":"tick - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/tick
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/tick/#tick","title":"tick","text":"[jvm]\\ fun tick()
Check the current time on the clock and run any scheduled tasks that are due.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/","title":"ScheduledFutureTask - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#scheduledfuturetask","title":"ScheduledFutureTask","text":"[jvm]\\ inner class ScheduledFutureTask<V>(var executeAt: Long, fixedDelay: Long, val clock: Clock, val task: () -> V) : FutureTask<V> , ScheduledFuture<V>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#constructors","title":"Constructors","text":"ScheduledFutureTask [jvm]constructor(executeAt: Long, clock: Clock, task: () -> V)constructor(executeAt: Long, fixedDelay: Long, clock: Clock, task: () -> V)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#properties","title":"Properties","text":"Name Summary clock [jvm]val clock: Clock executeAt [jvm]var executeAt: Long isRepeated [jvm]val isRepeated: Boolean task [jvm]val task: () -> V"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#functions","title":"Functions","text":"Name Summary cancel [jvm]open override fun cancel(p0: Boolean): Boolean compareTo [jvm]open operator override fun compareTo(other: Delayed): Int get [jvm]open override fun get(): Vopen operator override fun get(p0: Long, p1: TimeUnit): V getDelay [jvm]open override fun getDelay(unit: TimeUnit): Long isCancelled [jvm]open override fun isCancelled(): Boolean isDone [jvm]open override fun isDone(): Boolean run [jvm]open override fun run() runAndReset [jvm]open override fun runAndReset(): Boolean toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/-scheduled-future-task/","title":"ScheduledFutureTask - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/ScheduledFutureTask
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/-scheduled-future-task/#scheduledfuturetask","title":"ScheduledFutureTask","text":"[jvm]\\ constructor(executeAt: Long, clock: Clock, task: () -> V)
constructor(executeAt: Long, fixedDelay: Long, clock: Clock, task: () -> V)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/clock/","title":"clock - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/clock
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/clock/#clock","title":"clock","text":"[jvm]\\ val clock: Clock
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/compare-to/","title":"compareTo - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/compareTo
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Delayed): Int
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/execute-at/","title":"executeAt - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/executeAt
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/execute-at/#executeat","title":"executeAt","text":"[jvm]\\ var executeAt: Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/get-delay/","title":"getDelay - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/getDelay
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/get-delay/#getdelay","title":"getDelay","text":"[jvm]\\ open override fun getDelay(unit: TimeUnit): Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/is-repeated/","title":"isRepeated - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/isRepeated
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/is-repeated/#isrepeated","title":"isRepeated","text":"[jvm]\\ val isRepeated: Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/run-and-reset/","title":"runAndReset - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/runAndReset
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/run-and-reset/#runandreset","title":"runAndReset","text":"[jvm]\\ open override fun runAndReset(): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/task/","title":"task - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/task
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/task/#task","title":"task","text":"[jvm]\\ val task: () -> V
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/","title":"FakeSleeper - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/#fakesleeper","title":"FakeSleeper","text":"[jvm]\\ @Singleton
class FakeSleeper@Injectconstructor(clock: Clock) : Sleeper
Sleeper for testing that blocks threads calling sleep, and checks whether the threads should wake using the tick() method. An injected Clock is used to decide whether to wake a thread.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/#constructors","title":"Constructors","text":"FakeSleeper [jvm]@Injectconstructor(clock: Clock)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/#functions","title":"Functions","text":"Name Summary lastSleepDuration [jvm]fun lastSleepDuration(): Duration?Returns the last duration FakeSleeper was called with. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently. sleep [jvm]open override fun sleep(duration: Duration) sleepCount [jvm]fun sleepCount(): IntReturns the total number of times the FakeSleeper has been called. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently. tick [jvm]fun tick()Check the current time and triggers any sleeping threads that are due to be awoken. waitForSleep [jvm]fun waitForSleep(numThreads: Int)Blocks until the given number of threads are asleep (as a result of calling sleep on this FakeSleeper)."},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/-fake-sleeper/","title":"FakeSleeper - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/FakeSleeper
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/-fake-sleeper/#fakesleeper","title":"FakeSleeper","text":"[jvm]\\
@Inject
constructor(clock: Clock)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/last-sleep-duration/","title":"lastSleepDuration - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/lastSleepDuration
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/last-sleep-duration/#lastsleepduration","title":"lastSleepDuration","text":"[jvm]\\ fun lastSleepDuration(): Duration?
Returns the last duration FakeSleeper was called with. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep-count/","title":"sleepCount - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/sleepCount
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep-count/#sleepcount","title":"sleepCount","text":"[jvm]\\ fun sleepCount(): Int
Returns the total number of times the FakeSleeper has been called. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep/","title":"sleep - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/sleep
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep/#sleep","title":"sleep","text":"[jvm]\\ open override fun sleep(duration: Duration)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/tick/","title":"tick - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/tick
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/tick/#tick","title":"tick","text":"[jvm]\\ fun tick()
Check the current time and triggers any sleeping threads that are due to be awoken.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/wait-for-sleep/","title":"waitForSleep - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/waitForSleep
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/wait-for-sleep/#waitforsleep","title":"waitForSleep","text":"[jvm]\\ fun waitForSleep(numThreads: Int)
Blocks until the given number of threads are asleep (as a result of calling sleep on this FakeSleeper).
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/","title":"FakeSleeperModule - Misk","text":"//misk-testing/misk.concurrent/FakeSleeperModule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/#fakesleepermodule","title":"FakeSleeperModule","text":"[jvm]\\ class FakeSleeperModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/#constructors","title":"Constructors","text":"FakeSleeperModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/-fake-sleeper-module/","title":"FakeSleeperModule - Misk","text":"//misk-testing/misk.concurrent/FakeSleeperModule/FakeSleeperModule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/-fake-sleeper-module/#fakesleepermodule","title":"FakeSleeperModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/","title":"FakeTicker - Misk","text":"//misk-testing/misk.concurrent/FakeTicker
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#faketicker","title":"FakeTicker","text":"[jvm]\\ @Singleton
class FakeTicker@Injectconstructor : Ticker, Sleeper
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#constructors","title":"Constructors","text":"FakeTicker [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#properties","title":"Properties","text":"Name Summary nowMs [jvm]val nowMs: Long"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#functions","title":"Functions","text":"Name Summary read [jvm]open override fun read(): Long sleep [jvm]open override fun sleep(duration: Duration) sleepMs [jvm]fun sleepMs(durationMs: Long)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/-fake-ticker/","title":"FakeTicker - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/FakeTicker
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/-fake-ticker/#faketicker","title":"FakeTicker","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/now-ms/","title":"nowMs - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/nowMs
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/now-ms/#nowms","title":"nowMs","text":"[jvm]\\ val nowMs: Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/read/","title":"read - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/read
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/read/#read","title":"read","text":"[jvm]\\ open override fun read(): Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep-ms/","title":"sleepMs - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/sleepMs
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep-ms/#sleepms","title":"sleepMs","text":"[jvm]\\ fun sleepMs(durationMs: Long)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep/","title":"sleep - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/sleep
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep/#sleep","title":"sleep","text":"[jvm]\\ open override fun sleep(duration: Duration)
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.containers
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.containers/#types","title":"Types","text":"Name Summary Composer [jvm]class Composer(name: String, containers: Container)Composer composes many Containers together to use in a unit test. Container [jvm]data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)A Container creates a Docker container for testing."},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/","title":"Composer - Misk","text":"//misk-testing/misk.containers/Composer
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/#composer","title":"Composer","text":"[jvm]\\ class Composer(name: String, containers: Container)
Composer composes many Containers together to use in a unit test.
The Containers are networked using a dedicated Docker network. Tests need to expose ports in order for the test to communicate with the containers over 127.0.0.1.
The following example composes Kafka and Zookeeper containers for testing. Kafka is exposed to the jUnit test via 127.0.0.1:9102. In this example, Zookeeper is not exposed to the test.
val zkContainer = Container {\n withImage(\"confluentinc/cp-zookeeper\")\n withName(\"zookeeper\")\n withEnv(\"ZOOKEEPER_CLIENT_PORT=2181\")\n }\n val kafka = Container {\n withImage(\"confluentinc/cp-kafka\"\n withName(\"kafka\")\n withExposedPorts(ExposedPort.tcp(port))\n withPortBindings(Ports().apply {\n bind(ExposedPort.tcp(9102), Ports.Binding.bindPort(9102))\n })\n withEnv(\n \"KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181\",\n \"KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9102\")\n }\n val composer = Composer(\"e-kafka\", zkContainer, kafka)\n composer.start()\n//misk-testing/misk.containers/Composer/Composer
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/-composer/#composer","title":"Composer","text":"[jvm]\\ constructor(name: String, vararg containers: Container)
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/start/","title":"start - Misk","text":"//misk-testing/misk.containers/Composer/start
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/start/#start","title":"start","text":"[jvm]\\ fun start()
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/stop/","title":"stop - Misk","text":"//misk-testing/misk.containers/Composer/stop
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/stop/#stop","title":"stop","text":"[jvm]\\ fun stop()
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/","title":"Container - Misk","text":"//misk-testing/misk.containers/Container
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/#container","title":"Container","text":"[jvm]\\ data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)
A Container creates a Docker container for testing.
Tests provide a lambda to build a CreateContainerCmd. The createCmd lambda must set CreateContainerCmd.withName and CreateContainerCmd.withImage. All other fields are optional. The Composer takes care of setting up the network.
There may be a need to configure your container between the creation and start steps. beforeStartHook provides you with an id to your container allowing you to manipulate as necessary before the command/entrypoint is invoked.
See Composer for an example.
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/#constructors","title":"Constructors","text":"Container [jvm]constructor(createCmd: CreateContainerCmd.() -> Unit)constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/#properties","title":"Properties","text":"Name Summary beforeStartHook [jvm]val beforeStartHook: (docker: DockerClient, id: String) -> Unit createCmd [jvm]val createCmd: CreateContainerCmd.() -> Unit"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/-container/","title":"Container - Misk","text":"//misk-testing/misk.containers/Container/Container
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/-container/#container","title":"Container","text":"[jvm]\\ constructor(createCmd: CreateContainerCmd.() -> Unit)
constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/before-start-hook/","title":"beforeStartHook - Misk","text":"//misk-testing/misk.containers/Container/beforeStartHook
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/before-start-hook/#beforestarthook","title":"beforeStartHook","text":"[jvm]\\ val beforeStartHook: (docker: DockerClient, id: String) -> Unit
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/create-cmd/","title":"createCmd - Misk","text":"//misk-testing/misk.containers/Container/createCmd
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/create-cmd/#createcmd","title":"createCmd","text":"[jvm]\\ val createCmd: CreateContainerCmd.() -> Unit
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.logging
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.logging/#types","title":"Types","text":"Name Summary LogCollectorModule [jvm]class LogCollectorModule : KAbstractModule LogCollectorService [jvm]interface LogCollectorService : ServiceMarker interface for the service that produces a LogCollector."},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/","title":"LogCollectorModule - Misk","text":"//misk-testing/misk.logging/LogCollectorModule
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/#logcollectormodule","title":"LogCollectorModule","text":"[jvm]\\ class LogCollectorModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/#constructors","title":"Constructors","text":"LogCollectorModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/-log-collector-module/","title":"LogCollectorModule - Misk","text":"//misk-testing/misk.logging/LogCollectorModule/LogCollectorModule
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/-log-collector-module/#logcollectormodule","title":"LogCollectorModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-service/","title":"LogCollectorService - Misk","text":"//misk-testing/misk.logging/LogCollectorService
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-service/#logcollectorservice","title":"LogCollectorService","text":"[jvm]\\ interface LogCollectorService : Service
Marker interface for the service that produces a LogCollector.
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.mockito
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.mockito/#types","title":"Types","text":"Name Summary Mockito [jvm]object Mockito"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/","title":"Mockito - Misk","text":"//misk-testing/misk.mockito/Mockito
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/#mockito","title":"Mockito","text":"[jvm]\\ object Mockito
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/#functions","title":"Functions","text":"Name Summary captor [jvm]inline fun <T : Any> captor(): ArgumentCaptor<T> mock [jvm]inline fun <T : Any> mock(): T whenever [jvm]inline fun <T : Any> whenever(t: T): OngoingStubbing<T>"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/captor/","title":"captor - Misk","text":"//misk-testing/misk.mockito/Mockito/captor
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/captor/#captor","title":"captor","text":"[jvm]\\ inline fun <T : Any> captor(): ArgumentCaptor<T>
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/mock/","title":"mock - Misk","text":"//misk-testing/misk.mockito/Mockito/mock
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/mock/#mock","title":"mock","text":"[jvm]\\ inline fun <T : Any> mock(): T
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/whenever/","title":"whenever - Misk","text":"//misk-testing/misk.mockito/Mockito/whenever
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/whenever/#whenever","title":"whenever","text":"[jvm]\\ inline fun <T : Any> whenever(t: T): OngoingStubbing<T>
"},{"location":"0.x/misk-testing/misk-testing/misk.random/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.random
"},{"location":"0.x/misk-testing/misk-testing/misk.random/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.random/#types","title":"Types","text":"Name Summary FakeRandom [jvm]@Singletonclass FakeRandom@Injectconstructor : Random FakeRandomModule [jvm]class FakeRandomModule : KAbstractModule FakeThreadLocalRandom [jvm]@Singletonclass FakeThreadLocalRandom@Injectconstructor : ThreadLocalRandom"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/","title":"FakeRandom - Misk","text":"//misk-testing/misk.random/FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#fakerandom","title":"FakeRandom","text":"[jvm]\\ @Singleton
class FakeRandom@Injectconstructor : Random
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#constructors","title":"Constructors","text":"FakeRandom [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#properties","title":"Properties","text":"Name Summary nextBoolean [jvm]var nextBoolean: Boolean? nextDouble [jvm]var nextDouble: Double? nextFloat [jvm]var nextFloat: Float? nextInt [jvm]var nextInt: Int? nextLong [jvm]var nextLong: Long?"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#functions","title":"Functions","text":"Name Summary doubles [jvm]open override fun doubles(): DoubleStreamopen override fun doubles(p0: Long): DoubleStreamopen override fun doubles(p0: Double, p1: Double): DoubleStreamopen override fun doubles(p0: Long, p1: Double, p2: Double): DoubleStream ints [jvm]open override fun ints(): IntStreamopen override fun ints(p0: Long): IntStreamopen override fun ints(p0: Int, p1: Int): IntStreamopen override fun ints(p0: Long, p1: Int, p2: Int): IntStream isDeprecated [jvm]open fun isDeprecated(): Boolean longs [jvm]open override fun longs(): LongStreamopen override fun longs(p0: Long): LongStreamopen override fun longs(p0: Long, p1: Long): LongStreamopen override fun longs(p0: Long, p1: Long, p2: Long): LongStream nextBoolean [jvm]open override fun nextBoolean(): Boolean nextBytes [jvm]open override fun nextBytes(p0: ByteArray) nextDouble [jvm]open fun nextDouble(p0: Double): Doubleopen fun nextDouble(p0: Double, p1: Double): Doubleopen override fun nextDouble(): Double nextExponential [jvm]open fun nextExponential(): Double nextFloat [jvm]open fun nextFloat(p0: Float): Floatopen fun nextFloat(p0: Float, p1: Float): Floatopen override fun nextFloat(): Float nextGaussian [jvm]open override fun nextGaussian(): Doubleopen fun nextGaussian(p0: Double, p1: Double): Double nextInt [jvm]open override fun nextInt(p0: Int): Intopen fun nextInt(p0: Int, p1: Int): Intopen override fun nextInt(): Int nextLong [jvm]open fun nextLong(p0: Long): Longopen fun nextLong(p0: Long, p1: Long): Longopen override fun nextLong(): Long setSeed [jvm]open fun setSeed(p0: Long)"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/-fake-random/","title":"FakeRandom - Misk","text":"//misk-testing/misk.random/FakeRandom/FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/-fake-random/#fakerandom","title":"FakeRandom","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-boolean/","title":"nextBoolean - Misk","text":"//misk-testing/misk.random/FakeRandom/nextBoolean
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-boolean/#nextboolean","title":"nextBoolean","text":"[jvm]\\ open override fun nextBoolean(): Boolean
var nextBoolean: Boolean?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-double/","title":"nextDouble - Misk","text":"//misk-testing/misk.random/FakeRandom/nextDouble
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-double/#nextdouble","title":"nextDouble","text":"[jvm]\\ open override fun nextDouble(): Double
var nextDouble: Double?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-float/","title":"nextFloat - Misk","text":"//misk-testing/misk.random/FakeRandom/nextFloat
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-float/#nextfloat","title":"nextFloat","text":"[jvm]\\ open override fun nextFloat(): Float
var nextFloat: Float?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-int/","title":"nextInt - Misk","text":"//misk-testing/misk.random/FakeRandom/nextInt
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-int/#nextint","title":"nextInt","text":"[jvm]\\ open override fun nextInt(): Int
var nextInt: Int?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-long/","title":"nextLong - Misk","text":"//misk-testing/misk.random/FakeRandom/nextLong
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-long/#nextlong","title":"nextLong","text":"[jvm]\\ open override fun nextLong(): Long
var nextLong: Long?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/","title":"FakeRandomModule - Misk","text":"//misk-testing/misk.random/FakeRandomModule
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/#fakerandommodule","title":"FakeRandomModule","text":"[jvm]\\ class FakeRandomModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/#constructors","title":"Constructors","text":"FakeRandomModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/-fake-random-module/","title":"FakeRandomModule - Misk","text":"//misk-testing/misk.random/FakeRandomModule/FakeRandomModule
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/-fake-random-module/#fakerandommodule","title":"FakeRandomModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/","title":"FakeThreadLocalRandom - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#fakethreadlocalrandom","title":"FakeThreadLocalRandom","text":"[jvm]\\ @Singleton
class FakeThreadLocalRandom@Injectconstructor : ThreadLocalRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#constructors","title":"Constructors","text":"FakeThreadLocalRandom [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#properties","title":"Properties","text":"Name Summary fakeRandom [jvm]@Injectlateinit var fakeRandom: FakeRandom"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#functions","title":"Functions","text":"Name Summary current [jvm]open override fun current(): FakeRandom"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/-fake-thread-local-random/","title":"FakeThreadLocalRandom - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom/FakeThreadLocalRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/-fake-thread-local-random/#fakethreadlocalrandom","title":"FakeThreadLocalRandom","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/current/","title":"current - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom/current
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/current/#current","title":"current","text":"[jvm]\\ open override fun current(): FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/fake-random/","title":"fakeRandom - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom/fakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/fake-random/#fakerandom","title":"fakeRandom","text":"[jvm]\\
@Inject
lateinit var fakeRandom: FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.service/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.service
"},{"location":"0.x/misk-testing/misk-testing/misk.service/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.service/#types","title":"Types","text":"Name Summary CachedTestService [jvm]abstract class CachedTestService : AbstractIdleServiceTest services can derive from CachedTestService if they\u2019d like to reuse the same service for the span of a given runtime. This is helpful when you want to avoid incurring the cost of service startup and shutdown with each test run."},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/","title":"CachedTestService - Misk","text":"//misk-testing/misk.service/CachedTestService
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#cachedtestservice","title":"CachedTestService","text":"[jvm]\\ abstract class CachedTestService : AbstractIdleService
Test services can derive from CachedTestService if they\u2019d like to reuse the same service for the span of a given runtime. This is helpful when you want to avoid incurring the cost of service startup and shutdown with each test run.
NOTE: The caching is only useful if the implementing service references a shared instance of their underlying resources. A common way to do this is to leverage a companion object.
Example:
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#constructors","title":"Constructors","text":"CachedTestService [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#functions","title":"Functions","text":"Name Summary actualShutdown [jvm]abstract fun actualShutdown()Actually shuts the service down. This will be invoked once per runtime. actualStartup [jvm]abstract fun actualStartup()Actually starts the service up. This will be invoked once per runtime. addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-cached-test-service/","title":"CachedTestService - Misk","text":"//misk-testing/misk.service/CachedTestService/CachedTestService
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-cached-test-service/#cachedtestservice","title":"CachedTestService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-shutdown/","title":"actualShutdown - Misk","text":"//misk-testing/misk.service/CachedTestService/actualShutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-shutdown/#actualshutdown","title":"actualShutdown","text":"[jvm]\\ abstract fun actualShutdown()
Actually shuts the service down. This will be invoked once per runtime.
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-startup/","title":"actualStartup - Misk","text":"//misk-testing/misk.service/CachedTestService/actualStartup
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-startup/#actualstartup","title":"actualStartup","text":"[jvm]\\ abstract fun actualStartup()
Actually starts the service up. This will be invoked once per runtime.
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-companion/","title":"Companion - Misk","text":"//misk-testing/misk.service/CachedTestService/Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.services/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.services
"},{"location":"0.x/misk-testing/misk-testing/misk.services/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.services/#types","title":"Types","text":"Name Summary FakeService [jvm]@Singletonclass FakeService@Injectconstructor : AbstractIdleService FakeServiceModule [jvm]class FakeServiceModule : KAbstractModule"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/","title":"FakeService - Misk","text":"//misk-testing/misk.services/FakeService
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/#fakeservice","title":"FakeService","text":"[jvm]\\ @Singleton
class FakeService@Injectconstructor : AbstractIdleService
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/#constructors","title":"Constructors","text":"FakeService [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/-fake-service/","title":"FakeService - Misk","text":"//misk-testing/misk.services/FakeService/FakeService
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/-fake-service/#fakeservice","title":"FakeService","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/","title":"FakeServiceModule - Misk","text":"//misk-testing/misk.services/FakeServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/#fakeservicemodule","title":"FakeServiceModule","text":"[jvm]\\ class FakeServiceModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/#constructors","title":"Constructors","text":"FakeServiceModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/-fake-service-module/","title":"FakeServiceModule - Misk","text":"//misk-testing/misk.services/FakeServiceModule/FakeServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/-fake-service-module/#fakeservicemodule","title":"FakeServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.testing
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.testing/#types","title":"Types","text":"Name Summary ConcurrentMockTracer [jvm]@Singletonclass ConcurrentMockTracer@Injectconstructor : MockTracerExtends MockTracer for use in concurrent environments, such as a web server and test client. Prefer this wherever you\u2019d otherwise use MockTracer. ExternalDependency [jvm]interface ExternalDependencyAn external dependency of the Misk Application that needs to be started for test, like Redis, Vitess, MySQL, SQS, etc. InjectingParameterResolver [jvm]class InjectingParameterResolver : ParameterResolver InjectTest [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])@Test@ExtendWith(value = [InjectingParameterResolver::class])annotation class InjectTest LogLevel [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])annotation class LogLevel(val level: LogLevel.Level = Level.INFO)Annotate your test classes or methods with@LogLevel to change the log level used by the test. It can be useful to have different LogLevel by test, specially if you\u2019re debugging issues on CI. LogLevelExtension [jvm]class LogLevelExtension@Injectconstructor : BeforeEachCallback MiskExternalDependency [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class MiskExternalDependency MiskTest [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])@ExtendWith(value = [MiskTestExtension::class])annotation class MiskTest(val startService: Boolean = false)Annotate your test classes with @MiskTest to have fields annotated with @Inject initialized. Provide modules to be installed by annotating a Module field in your test class with MiskTestModule. This can be a compound module, composed using Modules.combine. MiskTestModule [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class MiskTestModule MockTracingBackendModule [jvm]class MockTracingBackendModule : KAbstractModule TemporaryFolder [jvm]class TemporaryFolder(val root: Path)A temporary folder for use by a given test TemporaryFolderModule [jvm]class TemporaryFolderModule : KAbstractModule"},{"location":"0.x/misk-testing/misk-testing/misk.testing/#functions","title":"Functions","text":"Name Summary retrieve [jvm]inline fun <T> ExtensionContext.retrieve(name: String): T store [jvm]fun <T> ExtensionContext.store(name: String, value: T)Stores an object scoped to the test class on the context"},{"location":"0.x/misk-testing/misk-testing/misk.testing/retrieve/","title":"retrieve - Misk","text":"//misk-testing/misk.testing/retrieve
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/retrieve/#retrieve","title":"retrieve","text":"[jvm]\\ inline fun <T> ExtensionContext.retrieve(name: String): T
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/retrieve/#return","title":"Return","text":"A previously stored object scoped to the test class
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/store/","title":"store - Misk","text":"//misk-testing/misk.testing/store
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/store/#store","title":"store","text":"[jvm]\\ fun <T> ExtensionContext.store(name: String, value: T)
Stores an object scoped to the test class on the context
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/","title":"ConcurrentMockTracer - Misk","text":"//misk-testing/misk.testing/ConcurrentMockTracer
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/#concurrentmocktracer","title":"ConcurrentMockTracer","text":"[jvm]\\ @Singleton
class ConcurrentMockTracer@Injectconstructor : MockTracer
Extends MockTracer for use in concurrent environments, such as a web server and test client. Prefer this wherever you\u2019d otherwise use MockTracer.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/#constructors","title":"Constructors","text":"ConcurrentMockTracer [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/#functions","title":"Functions","text":"Name Summary activateSpan [jvm]open override fun activateSpan(p0: Span): Scope activeSpan [jvm]open override fun activeSpan(): Span buildSpan [jvm]open override fun buildSpan(p0: String): MockTracer.SpanBuilder close [jvm]open override fun close() extract [jvm]open override fun <C : Any> extract(p0: Format<C>, p1: C): SpanContext finishedSpans [jvm]open fun finishedSpans(): MutableList<MockSpan> inject [jvm]open override fun <C : Any> inject(p0: SpanContext, p1: Format<C>, p2: C) reset [jvm]open fun reset() scopeManager [jvm]open override fun scopeManager(): ScopeManager take [jvm]fun take(): MockSpanAwaits a span, removes it, and returns it.[jvm]fun take(operationName: String): MockSpanAwaits a span named operationName, removes it, and returns it. Spans with other names are consumed and discarded."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/-concurrent-mock-tracer/","title":"ConcurrentMockTracer - Misk","text":"//misk-testing/misk.testing/ConcurrentMockTracer/ConcurrentMockTracer
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/-concurrent-mock-tracer/#concurrentmocktracer","title":"ConcurrentMockTracer","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/take/","title":"take - Misk","text":"//misk-testing/misk.testing/ConcurrentMockTracer/take
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/take/#take","title":"take","text":"[jvm]\\ fun take(): MockSpan
Awaits a span, removes it, and returns it.
[jvm]\\ fun take(operationName: String): MockSpan
Awaits a span named operationName, removes it, and returns it. Spans with other names are consumed and discarded.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/","title":"ExternalDependency - Misk","text":"//misk-testing/misk.testing/ExternalDependency
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/#externaldependency","title":"ExternalDependency","text":"[jvm]\\ interface ExternalDependency
An external dependency of the Misk Application that needs to be started for test, like Redis, Vitess, MySQL, SQS, etc.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/#properties","title":"Properties","text":"Name Summary id [jvm]open val id: StringUnique ID for the dependency, used as a stable key across tests. Can be overridden if more than one instance of the dependency is supported."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/#functions","title":"Functions","text":"Name Summary afterEach [jvm]abstract fun afterEach()Called before each test run beforeEach [jvm]abstract fun beforeEach()Called before each test run shutdown [jvm]abstract fun shutdown()Stops the dependency. startup [jvm]abstract fun startup()Starts the dependency."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/after-each/","title":"afterEach - Misk","text":"//misk-testing/misk.testing/ExternalDependency/afterEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/after-each/#aftereach","title":"afterEach","text":"[jvm]\\ abstract fun afterEach()
Called before each test run
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/before-each/","title":"beforeEach - Misk","text":"//misk-testing/misk.testing/ExternalDependency/beforeEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/before-each/#beforeeach","title":"beforeEach","text":"[jvm]\\ abstract fun beforeEach()
Called before each test run
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/id/","title":"id - Misk","text":"//misk-testing/misk.testing/ExternalDependency/id
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/id/#id","title":"id","text":"[jvm]\\ open val id: String
Unique ID for the dependency, used as a stable key across tests. Can be overridden if more than one instance of the dependency is supported.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/shutdown/","title":"shutdown - Misk","text":"//misk-testing/misk.testing/ExternalDependency/shutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/shutdown/#shutdown","title":"shutdown","text":"[jvm]\\ abstract fun shutdown()
Stops the dependency.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/startup/","title":"startup - Misk","text":"//misk-testing/misk.testing/ExternalDependency/startup
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/startup/#startup","title":"startup","text":"[jvm]\\ abstract fun startup()
Starts the dependency.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-inject-test/","title":"InjectTest - Misk","text":"//misk-testing/misk.testing/InjectTest
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-inject-test/#injecttest","title":"InjectTest","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
@Test
@ExtendWith(value = [InjectingParameterResolver::class])
annotation class InjectTest
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/","title":"InjectingParameterResolver - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/#injectingparameterresolver","title":"InjectingParameterResolver","text":"[jvm]\\ class InjectingParameterResolver : ParameterResolver
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/#constructors","title":"Constructors","text":"InjectingParameterResolver [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/#functions","title":"Functions","text":"Name Summary resolveParameter [jvm]open override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any supportsParameter [jvm]open override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/-injecting-parameter-resolver/","title":"InjectingParameterResolver - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver/InjectingParameterResolver
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/-injecting-parameter-resolver/#injectingparameterresolver","title":"InjectingParameterResolver","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/resolve-parameter/","title":"resolveParameter - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver/resolveParameter
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/resolve-parameter/#resolveparameter","title":"resolveParameter","text":"[jvm]\\ open override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/supports-parameter/","title":"supportsParameter - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver/supportsParameter
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/supports-parameter/#supportsparameter","title":"supportsParameter","text":"[jvm]\\ open override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/","title":"LogLevel - Misk","text":"//misk-testing/misk.testing/LogLevel
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/#loglevel","title":"LogLevel","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])
annotation class LogLevel(val level: LogLevel.Level = Level.INFO)
Annotate your test classes or methods with @LogLevel to change the log level used by the test. It can be useful to have different LogLevel by test, specially if you\u2019re debugging issues on CI.
You can annotate methods:
@LogLevel(level = LogLevel.Level.DEBUG)\n@Test fun levelDebug() {\n}\nAlso, You can annotate test classes:
@LogLevel(level = LogLevel.Level.ERROR)\nclass `you can annotate the test` {\n@Test fun levelError() {\n//misk-testing/misk.testing/LogLevel/level
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/level/#level","title":"level","text":"[jvm]\\ val level: LogLevel.Level
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/","title":"Level - Misk","text":"//misk-testing/misk.testing/LogLevel/Level
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#level","title":"Level","text":"[jvm]\\ enum Level : Enum<LogLevel.Level>
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#entries","title":"Entries","text":"DEBUG [jvm]DEBUG INFO [jvm]INFO WARN [jvm]WARN ERROR [jvm]ERROR"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<LogLevel.Level>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): LogLevel.LevelReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<LogLevel.Level>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/entries/","title":"entries - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/entries
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<LogLevel.Level>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/value-of/","title":"valueOf - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/valueOf
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): LogLevel.Level
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/values/","title":"values - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/values
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<LogLevel.Level>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-d-e-b-u-g/","title":"DEBUG - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/DEBUG
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-d-e-b-u-g/#debug","title":"DEBUG","text":"[jvm]\\ DEBUG
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-d-e-b-u-g/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-e-r-r-o-r/","title":"ERROR - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/ERROR
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-e-r-r-o-r/#error","title":"ERROR","text":"[jvm]\\ ERROR
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-e-r-r-o-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-i-n-f-o/","title":"INFO - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/INFO
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-i-n-f-o/#info","title":"INFO","text":"[jvm]\\ INFO
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-i-n-f-o/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-w-a-r-n/","title":"WARN - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/WARN
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-w-a-r-n/#warn","title":"WARN","text":"[jvm]\\ WARN
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-w-a-r-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/","title":"LogLevelExtension - Misk","text":"//misk-testing/misk.testing/LogLevelExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/#loglevelextension","title":"LogLevelExtension","text":"[jvm]\\ class LogLevelExtension@Injectconstructor : BeforeEachCallback
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/#constructors","title":"Constructors","text":"LogLevelExtension [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/#functions","title":"Functions","text":"Name Summary beforeEach [jvm]open override fun beforeEach(context: ExtensionContext?)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/-log-level-extension/","title":"LogLevelExtension - Misk","text":"//misk-testing/misk.testing/LogLevelExtension/LogLevelExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/-log-level-extension/#loglevelextension","title":"LogLevelExtension","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/before-each/","title":"beforeEach - Misk","text":"//misk-testing/misk.testing/LogLevelExtension/beforeEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/before-each/#beforeeach","title":"beforeEach","text":"[jvm]\\ open override fun beforeEach(context: ExtensionContext?)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-external-dependency/","title":"MiskExternalDependency - Misk","text":"//misk-testing/misk.testing/MiskExternalDependency
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-external-dependency/#miskexternaldependency","title":"MiskExternalDependency","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class MiskExternalDependency
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test/","title":"MiskTest - Misk","text":"//misk-testing/misk.testing/MiskTest
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test/#misktest","title":"MiskTest","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
@ExtendWith(value = [MiskTestExtension::class])
annotation class MiskTest(val startService: Boolean = false)
Annotate your test classes with @MiskTest to have fields annotated with @Inject initialized. Provide modules to be installed by annotating a Module field in your test class with MiskTestModule. This can be a compound module, composed using Modules.combine.
Configure test callbacks with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<BeforeEachCallback>().to<MyBeforeEach>()\nmultibind<AfterEachCallback>().to<MyAfterEach>()\n//misk-testing/misk.testing/MiskTest/startService
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test/start-service/#startservice","title":"startService","text":"[jvm]\\ val startService: Boolean = false
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test-module/","title":"MiskTestModule - Misk","text":"//misk-testing/misk.testing/MiskTestModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test-module/#misktestmodule","title":"MiskTestModule","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class MiskTestModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/","title":"MockTracingBackendModule - Misk","text":"//misk-testing/misk.testing/MockTracingBackendModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/#mocktracingbackendmodule","title":"MockTracingBackendModule","text":"[jvm]\\ class MockTracingBackendModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/#constructors","title":"Constructors","text":"MockTracingBackendModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/-mock-tracing-backend-module/","title":"MockTracingBackendModule - Misk","text":"//misk-testing/misk.testing/MockTracingBackendModule/MockTracingBackendModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/-mock-tracing-backend-module/#mocktracingbackendmodule","title":"MockTracingBackendModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/","title":"TemporaryFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#temporaryfolder","title":"TemporaryFolder","text":"[jvm]\\ class TemporaryFolder(val root: Path)
A temporary folder for use by a given test
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#constructors","title":"Constructors","text":"TemporaryFolder [jvm]constructor(root: Path)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#properties","title":"Properties","text":"Name Summary root [jvm]val root: Path"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#functions","title":"Functions","text":"Name Summary delete [jvm]fun delete()Deletes all files and folders under the temporary folder newFile [jvm]fun newFile(): Pathfun newFile(name: String): Path newFolder [jvm]fun newFolder(): Pathfun newFolder(name: String): Path"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/-temporary-folder/","title":"TemporaryFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/TemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/-temporary-folder/#temporaryfolder","title":"TemporaryFolder","text":"[jvm]\\ constructor(root: Path)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/delete/","title":"delete - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/delete
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/delete/#delete","title":"delete","text":"[jvm]\\ fun delete()
Deletes all files and folders under the temporary folder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/","title":"newFile - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/newFile
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/#newfile","title":"newFile","text":"[jvm]\\ fun newFile(): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/#return","title":"Return","text":"a new file with a randomly generated name
[jvm]\\ fun newFile(name: String): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/#return_1","title":"Return","text":"a new file with the given name
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/","title":"newFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/newFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/#newfolder","title":"newFolder","text":"[jvm]\\ fun newFolder(): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/#return","title":"Return","text":"a new folder with a randomly generated name
[jvm]\\ fun newFolder(name: String): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/#return_1","title":"Return","text":"a new folder with the given name
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/root/","title":"root - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/root
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/root/#root","title":"root","text":"[jvm]\\ val root: Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/","title":"TemporaryFolderModule - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#temporaryfoldermodule","title":"TemporaryFolderModule","text":"[jvm]\\ class TemporaryFolderModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#constructors","title":"Constructors","text":"TemporaryFolderModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#types","title":"Types","text":"Name Summary DeleteTempFolder [jvm]class DeleteTempFolder@Injectconstructor(tempDir: TemporaryFolder) : AfterEachCallback"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideTemporaryFolder [jvm]@Provides@Singletonfun provideTemporaryFolder(): TemporaryFolder"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-temporary-folder-module/","title":"TemporaryFolderModule - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/TemporaryFolderModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-temporary-folder-module/#temporaryfoldermodule","title":"TemporaryFolderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/provide-temporary-folder/","title":"provideTemporaryFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/provideTemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/provide-temporary-folder/#providetemporaryfolder","title":"provideTemporaryFolder","text":"[jvm]\\
@Provides
@Singleton
fun provideTemporaryFolder(): TemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/","title":"DeleteTempFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/DeleteTempFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/#deletetempfolder","title":"DeleteTempFolder","text":"[jvm]\\ class DeleteTempFolder@Injectconstructor(tempDir: TemporaryFolder) : AfterEachCallback
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/#constructors","title":"Constructors","text":"DeleteTempFolder [jvm]@Injectconstructor(tempDir: TemporaryFolder)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/#functions","title":"Functions","text":"Name Summary afterEach [jvm]open override fun afterEach(context: ExtensionContext)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/-delete-temp-folder/","title":"DeleteTempFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/DeleteTempFolder/DeleteTempFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/-delete-temp-folder/#deletetempfolder","title":"DeleteTempFolder","text":"[jvm]\\
@Inject
constructor(tempDir: TemporaryFolder)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/after-each/","title":"afterEach - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/DeleteTempFolder/afterEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/after-each/#aftereach","title":"afterEach","text":"[jvm]\\ open override fun afterEach(context: ExtensionContext)
"},{"location":"0.x/misk-testing/misk-testing/misk.time/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.time
"},{"location":"0.x/misk-testing/misk-testing/misk.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.time/#types","title":"Types","text":"Name Summary FakeClock [jvm]@Singletonclass FakeClock@Injectconstructor : FakeClock FakeClockModule [jvm]class FakeClockModule : KInstallOnceModule FakeTickerModule [jvm]class FakeTickerModule : KAbstractModule"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/","title":"FakeClock - Misk","text":"//misk-testing/misk.time/FakeClock
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\ @Singleton
class FakeClock@Injectconstructor : FakeClock
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/#constructors","title":"Constructors","text":"FakeClock [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(d: Duration): Longfun add(p: Period): Longfun add(n: Long, unit: TimeUnit): Long equals [jvm]open operator override fun equals(other: Any?): Boolean getZone [jvm]open override fun getZone(): ZoneId hashCode [jvm]open override fun hashCode(): Int instant [jvm]open override fun instant(): Instant millis [jvm]open override fun millis(): Long reset [jvm]open override fun reset() setNow [jvm]fun setNow(instant: Instant) withZone [jvm]open override fun withZone(zone: ZoneId): Clock"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/-fake-clock/","title":"FakeClock - Misk","text":"//misk-testing/misk.time/FakeClock/FakeClock
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/","title":"FakeClockModule - Misk","text":"//misk-testing/misk.time/FakeClockModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/#fakeclockmodule","title":"FakeClockModule","text":"[jvm]\\ class FakeClockModule : KInstallOnceModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/#constructors","title":"Constructors","text":"FakeClockModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/-fake-clock-module/","title":"FakeClockModule - Misk","text":"//misk-testing/misk.time/FakeClockModule/FakeClockModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/-fake-clock-module/#fakeclockmodule","title":"FakeClockModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/","title":"FakeTickerModule - Misk","text":"//misk-testing/misk.time/FakeTickerModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/#faketickermodule","title":"FakeTickerModule","text":"[jvm]\\ class FakeTickerModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/#constructors","title":"Constructors","text":"FakeTickerModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/-fake-ticker-module/","title":"FakeTickerModule - Misk","text":"//misk-testing/misk.time/FakeTickerModule/FakeTickerModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/-fake-ticker-module/#faketickermodule","title":"FakeTickerModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.web
"},{"location":"0.x/misk-testing/misk-testing/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.web/#types","title":"Types","text":"Name Summary FakeHttpCall [jvm]data class FakeHttpCall@JvmOverloadsconstructor(val url: HttpUrl = \"https://example.com/\".toHttpUrl(), val linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), val dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, var requestHeaders: Headers = headersOf(), var statusCode: Int = 200, var networkStatusCode: Int = 200, val headersBuilder: Headers.Builder = Headers.Builder(), var sendTrailers: Boolean = false, val trailersBuilder: Headers.Builder = Headers.Builder(), var requestBody: BufferedSource? = Buffer(), var responseBody: BufferedSink? = Buffer(), var webSocket: WebSocket? = null, var webSocketListener: WebSocketListener? = null, var cookies: List<Cookie> = listOf()) : HttpCall FakeWebSocket [jvm]class FakeWebSocket : WebSocket FakeWebSocketListener [jvm]class FakeWebSocketListener : WebSocketListener MiskCallerExtension [jvm]class MiskCallerExtension : BeforeTestExecutionCallback, AfterTestExecutionCallback WebServerTestingModule [jvm]class WebServerTestingModule@JvmOverloadsconstructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true) : KAbstractModuleA module that starts an embedded Jetty web server configured for testing. The server supports both plaintext and TLS. WebTestClient [jvm]class WebTestClient@Injectconstructor(moshi: Moshi, jettyService: JettyService)Use WebTestClient to test calls to the application at the integration level. WithMiskCaller [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])@ExtendWith(value = [MiskCallerExtension::class])annotation class WithMiskCaller(val user: String = \"\", val service: String = \"\")Use this annotation to specify an ActionScoped for this class."},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/","title":"FakeHttpCall - Misk","text":"//misk-testing/misk.web/FakeHttpCall
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#fakehttpcall","title":"FakeHttpCall","text":"[jvm]\\ data class FakeHttpCall@JvmOverloadsconstructor(val url: HttpUrl = \"https://example.com/\".toHttpUrl(), val linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), val dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, var requestHeaders: Headers = headersOf(), var statusCode: Int = 200, var networkStatusCode: Int = 200, val headersBuilder: Headers.Builder = Headers.Builder(), var sendTrailers: Boolean = false, val trailersBuilder: Headers.Builder = Headers.Builder(), var requestBody: BufferedSource? = Buffer(), var responseBody: BufferedSink? = Buffer(), var webSocket: WebSocket? = null, var webSocketListener: WebSocketListener? = null, var cookies: List<Cookie> = listOf()) : HttpCall
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#constructors","title":"Constructors","text":"FakeHttpCall [jvm]@JvmOverloadsconstructor(url: HttpUrl = \"https://example.com/\".toHttpUrl(), linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, requestHeaders: Headers = headersOf(), statusCode: Int = 200, networkStatusCode: Int = 200, headersBuilder: Headers.Builder = Headers.Builder(), sendTrailers: Boolean = false, trailersBuilder: Headers.Builder = Headers.Builder(), requestBody: BufferedSource? = Buffer(), responseBody: BufferedSink? = Buffer(), webSocket: WebSocket? = null, webSocketListener: WebSocketListener? = null, cookies: List<Cookie> = listOf())"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#properties","title":"Properties","text":"Name Summary cookies [jvm]open override var cookies: List<Cookie> dispatchMechanism [jvm]open override val dispatchMechanism: DispatchMechanism headersBuilder [jvm]val headersBuilder: Headers.Builder linkLayerLocalAddress [jvm]open override val linkLayerLocalAddress: SocketAddress networkStatusCode [jvm]open override var networkStatusCode: Int requestBody [jvm]var requestBody: BufferedSource? requestHeaders [jvm]open override var requestHeaders: Headers responseBody [jvm]var responseBody: BufferedSink? responseHeaders [jvm]open override val responseHeaders: Headers sendTrailers [jvm]var sendTrailers: Boolean statusCode [jvm]open override var statusCode: Int trailersBuilder [jvm]val trailersBuilder: Headers.Builder url [jvm]open override val url: HttpUrl webSocket [jvm]var webSocket: WebSocket? webSocketListener [jvm]var webSocketListener: WebSocketListener?"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#functions","title":"Functions","text":"Name Summary accepts [jvm]open fun accepts(): List<MediaRange> addResponseHeaders [jvm]open override fun addResponseHeaders(headers: Headers) asOkHttpRequest [jvm]open fun asOkHttpRequest(): Request computeRequestHeader [jvm]open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?) contentType [jvm]open fun contentType(): MediaType? initWebSocketListener [jvm]open override fun initWebSocketListener(webSocketListener: WebSocketListener) putRequestBody [jvm]open override fun putRequestBody(requestBody: BufferedSource) putResponseBody [jvm]open override fun putResponseBody(responseBody: BufferedSink) putWebSocket [jvm]open override fun putWebSocket(webSocket: WebSocket) requireTrailers [jvm]open override fun requireTrailers() setResponseHeader [jvm]open override fun setResponseHeader(name: String, value: String) setResponseTrailer [jvm]open override fun setResponseTrailer(name: String, value: String) setStatusCodes [jvm]open override fun setStatusCodes(statusCode: Int, networkStatusCode: Int) takeRequestBody [jvm]open override fun takeRequestBody(): BufferedSource? takeResponseBody [jvm]open override fun takeResponseBody(): BufferedSink? takeWebSocket [jvm]open override fun takeWebSocket(): WebSocket?"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/-fake-http-call/","title":"FakeHttpCall - Misk","text":"//misk-testing/misk.web/FakeHttpCall/FakeHttpCall
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/-fake-http-call/#fakehttpcall","title":"FakeHttpCall","text":"[jvm]\\
@JvmOverloads
constructor(url: HttpUrl = \"https://example.com/\".toHttpUrl(), linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, requestHeaders: Headers = headersOf(), statusCode: Int = 200, networkStatusCode: Int = 200, headersBuilder: Headers.Builder = Headers.Builder(), sendTrailers: Boolean = false, trailersBuilder: Headers.Builder = Headers.Builder(), requestBody: BufferedSource? = Buffer(), responseBody: BufferedSink? = Buffer(), webSocket: WebSocket? = null, webSocketListener: WebSocketListener? = null, cookies: List<Cookie> = listOf())
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/add-response-headers/","title":"addResponseHeaders - Misk","text":"//misk-testing/misk.web/FakeHttpCall/addResponseHeaders
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/add-response-headers/#addresponseheaders","title":"addResponseHeaders","text":"[jvm]\\ open override fun addResponseHeaders(headers: Headers)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/cookies/","title":"cookies - Misk","text":"//misk-testing/misk.web/FakeHttpCall/cookies
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/cookies/#cookies","title":"cookies","text":"[jvm]\\ open override var cookies: List<Cookie>
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/dispatch-mechanism/","title":"dispatchMechanism - Misk","text":"//misk-testing/misk.web/FakeHttpCall/dispatchMechanism
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"[jvm]\\ open override val dispatchMechanism: DispatchMechanism
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/headers-builder/","title":"headersBuilder - Misk","text":"//misk-testing/misk.web/FakeHttpCall/headersBuilder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/headers-builder/#headersbuilder","title":"headersBuilder","text":"[jvm]\\ val headersBuilder: Headers.Builder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/init-web-socket-listener/","title":"initWebSocketListener - Misk","text":"//misk-testing/misk.web/FakeHttpCall/initWebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/init-web-socket-listener/#initwebsocketlistener","title":"initWebSocketListener","text":"[jvm]\\ open override fun initWebSocketListener(webSocketListener: WebSocketListener)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/link-layer-local-address/","title":"linkLayerLocalAddress - Misk","text":"//misk-testing/misk.web/FakeHttpCall/linkLayerLocalAddress
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/link-layer-local-address/#linklayerlocaladdress","title":"linkLayerLocalAddress","text":"[jvm]\\ open override val linkLayerLocalAddress: SocketAddress
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/network-status-code/","title":"networkStatusCode - Misk","text":"//misk-testing/misk.web/FakeHttpCall/networkStatusCode
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/network-status-code/#networkstatuscode","title":"networkStatusCode","text":"[jvm]\\ open override var networkStatusCode: Int
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-request-body/","title":"putRequestBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/putRequestBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-request-body/#putrequestbody","title":"putRequestBody","text":"[jvm]\\ open override fun putRequestBody(requestBody: BufferedSource)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-response-body/","title":"putResponseBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/putResponseBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-response-body/#putresponsebody","title":"putResponseBody","text":"[jvm]\\ open override fun putResponseBody(responseBody: BufferedSink)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-web-socket/","title":"putWebSocket - Misk","text":"//misk-testing/misk.web/FakeHttpCall/putWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-web-socket/#putwebsocket","title":"putWebSocket","text":"[jvm]\\ open override fun putWebSocket(webSocket: WebSocket)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-body/","title":"requestBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/requestBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-body/#requestbody","title":"requestBody","text":"[jvm]\\ var requestBody: BufferedSource?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-headers/","title":"requestHeaders - Misk","text":"//misk-testing/misk.web/FakeHttpCall/requestHeaders
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-headers/#requestheaders","title":"requestHeaders","text":"[jvm]\\ open override var requestHeaders: Headers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/require-trailers/","title":"requireTrailers - Misk","text":"//misk-testing/misk.web/FakeHttpCall/requireTrailers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/require-trailers/#requiretrailers","title":"requireTrailers","text":"[jvm]\\ open override fun requireTrailers()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-body/","title":"responseBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/responseBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ var responseBody: BufferedSink?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-headers/","title":"responseHeaders - Misk","text":"//misk-testing/misk.web/FakeHttpCall/responseHeaders
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-headers/#responseheaders","title":"responseHeaders","text":"[jvm]\\ open override val responseHeaders: Headers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/send-trailers/","title":"sendTrailers - Misk","text":"//misk-testing/misk.web/FakeHttpCall/sendTrailers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/send-trailers/#sendtrailers","title":"sendTrailers","text":"[jvm]\\ var sendTrailers: Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-header/","title":"setResponseHeader - Misk","text":"//misk-testing/misk.web/FakeHttpCall/setResponseHeader
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-header/#setresponseheader","title":"setResponseHeader","text":"[jvm]\\ open override fun setResponseHeader(name: String, value: String)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-trailer/","title":"setResponseTrailer - Misk","text":"//misk-testing/misk.web/FakeHttpCall/setResponseTrailer
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-trailer/#setresponsetrailer","title":"setResponseTrailer","text":"[jvm]\\ open override fun setResponseTrailer(name: String, value: String)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-status-codes/","title":"setStatusCodes - Misk","text":"//misk-testing/misk.web/FakeHttpCall/setStatusCodes
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-status-codes/#setstatuscodes","title":"setStatusCodes","text":"[jvm]\\ open override fun setStatusCodes(statusCode: Int, networkStatusCode: Int)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/status-code/","title":"statusCode - Misk","text":"//misk-testing/misk.web/FakeHttpCall/statusCode
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/status-code/#statuscode","title":"statusCode","text":"[jvm]\\ open override var statusCode: Int
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-request-body/","title":"takeRequestBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/takeRequestBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-request-body/#takerequestbody","title":"takeRequestBody","text":"[jvm]\\ open override fun takeRequestBody(): BufferedSource?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-response-body/","title":"takeResponseBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/takeResponseBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"[jvm]\\ open override fun takeResponseBody(): BufferedSink?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-web-socket/","title":"takeWebSocket - Misk","text":"//misk-testing/misk.web/FakeHttpCall/takeWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-web-socket/#takewebsocket","title":"takeWebSocket","text":"[jvm]\\ open override fun takeWebSocket(): WebSocket?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/trailers-builder/","title":"trailersBuilder - Misk","text":"//misk-testing/misk.web/FakeHttpCall/trailersBuilder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/trailers-builder/#trailersbuilder","title":"trailersBuilder","text":"[jvm]\\ val trailersBuilder: Headers.Builder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/url/","title":"url - Misk","text":"//misk-testing/misk.web/FakeHttpCall/url
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/url/#url","title":"url","text":"[jvm]\\ open override val url: HttpUrl
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket-listener/","title":"webSocketListener - Misk","text":"//misk-testing/misk.web/FakeHttpCall/webSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket-listener/#websocketlistener","title":"webSocketListener","text":"[jvm]\\ var webSocketListener: WebSocketListener?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket/","title":"webSocket - Misk","text":"//misk-testing/misk.web/FakeHttpCall/webSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket/#websocket","title":"webSocket","text":"[jvm]\\ var webSocket: WebSocket?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/","title":"FakeWebSocket - Misk","text":"//misk-testing/misk.web/FakeWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/#fakewebsocket","title":"FakeWebSocket","text":"[jvm]\\ class FakeWebSocket : WebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/#constructors","title":"Constructors","text":"FakeWebSocket [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/#functions","title":"Functions","text":"Name Summary cancel [jvm]open override fun cancel() close [jvm]open override fun close(code: Int, reason: String?): Boolean poll [jvm]fun poll(): String? queueSize [jvm]open override fun queueSize(): Long send [jvm]open override fun send(text: String): Booleanopen override fun send(bytes: ByteString): Boolean"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/-fake-web-socket/","title":"FakeWebSocket - Misk","text":"//misk-testing/misk.web/FakeWebSocket/FakeWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/-fake-web-socket/#fakewebsocket","title":"FakeWebSocket","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/cancel/","title":"cancel - Misk","text":"//misk-testing/misk.web/FakeWebSocket/cancel
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/cancel/#cancel","title":"cancel","text":"[jvm]\\ open override fun cancel()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/close/","title":"close - Misk","text":"//misk-testing/misk.web/FakeWebSocket/close
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/close/#close","title":"close","text":"[jvm]\\ open override fun close(code: Int, reason: String?): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/poll/","title":"poll - Misk","text":"//misk-testing/misk.web/FakeWebSocket/poll
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/poll/#poll","title":"poll","text":"[jvm]\\ fun poll(): String?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/queue-size/","title":"queueSize - Misk","text":"//misk-testing/misk.web/FakeWebSocket/queueSize
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ open override fun queueSize(): Long
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/send/","title":"send - Misk","text":"//misk-testing/misk.web/FakeWebSocket/send
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/send/#send","title":"send","text":"[jvm]\\ open override fun send(bytes: ByteString): Boolean
open override fun send(text: String): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/","title":"FakeWebSocketListener - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#fakewebsocketlistener","title":"FakeWebSocketListener","text":"[jvm]\\ class FakeWebSocketListener : WebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#constructors","title":"Constructors","text":"FakeWebSocketListener [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#properties","title":"Properties","text":"Name Summary messages [jvm]val messages: LinkedBlockingDeque<String>"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#functions","title":"Functions","text":"Name Summary onClosed [jvm]open fun onClosed(webSocket: WebSocket, code: Int, reason: String) onClosing [jvm]open fun onClosing(webSocket: WebSocket, code: Int, reason: String) onFailure [jvm]open fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?) onMessage [jvm]open override fun onMessage(webSocket: WebSocket, text: String)open fun onMessage(webSocket: WebSocket, bytes: ByteString) onOpen [jvm]open fun onOpen(webSocket: WebSocket, response: Response) takeMessage [jvm]fun takeMessage(): String"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/-fake-web-socket-listener/","title":"FakeWebSocketListener - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/FakeWebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/-fake-web-socket-listener/#fakewebsocketlistener","title":"FakeWebSocketListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/messages/","title":"messages - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/messages
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/messages/#messages","title":"messages","text":"[jvm]\\ val messages: LinkedBlockingDeque<String>
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/on-message/","title":"onMessage - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/onMessage
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/on-message/#onmessage","title":"onMessage","text":"[jvm]\\ open override fun onMessage(webSocket: WebSocket, text: String)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/take-message/","title":"takeMessage - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/takeMessage
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/take-message/#takemessage","title":"takeMessage","text":"[jvm]\\ fun takeMessage(): String
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/","title":"MiskCallerExtension - Misk","text":"//misk-testing/misk.web/MiskCallerExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/#miskcallerextension","title":"MiskCallerExtension","text":"[jvm]\\ class MiskCallerExtension : BeforeTestExecutionCallback, AfterTestExecutionCallback
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/#constructors","title":"Constructors","text":"MiskCallerExtension [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/#functions","title":"Functions","text":"Name Summary afterTestExecution [jvm]open override fun afterTestExecution(context: ExtensionContext) beforeTestExecution [jvm]open override fun beforeTestExecution(context: ExtensionContext)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/-misk-caller-extension/","title":"MiskCallerExtension - Misk","text":"//misk-testing/misk.web/MiskCallerExtension/MiskCallerExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/-misk-caller-extension/#miskcallerextension","title":"MiskCallerExtension","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/after-test-execution/","title":"afterTestExecution - Misk","text":"//misk-testing/misk.web/MiskCallerExtension/afterTestExecution
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/after-test-execution/#aftertestexecution","title":"afterTestExecution","text":"[jvm]\\ open override fun afterTestExecution(context: ExtensionContext)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/before-test-execution/","title":"beforeTestExecution - Misk","text":"//misk-testing/misk.web/MiskCallerExtension/beforeTestExecution
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/before-test-execution/#beforetestexecution","title":"beforeTestExecution","text":"[jvm]\\ open override fun beforeTestExecution(context: ExtensionContext)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/","title":"WebServerTestingModule - Misk","text":"//misk-testing/misk.web/WebServerTestingModule
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#webservertestingmodule","title":"WebServerTestingModule","text":"[jvm]\\ class WebServerTestingModule@JvmOverloadsconstructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true) : KAbstractModule
A module that starts an embedded Jetty web server configured for testing. The server supports both plaintext and TLS.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#constructors","title":"Constructors","text":"WebServerTestingModule [jvm]@JvmOverloadsconstructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-web-server-testing-module/","title":"WebServerTestingModule - Misk","text":"//misk-testing/misk.web/WebServerTestingModule/WebServerTestingModule
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-web-server-testing-module/#webservertestingmodule","title":"WebServerTestingModule","text":"[jvm]\\
@JvmOverloads
constructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/","title":"Companion - Misk","text":"//misk-testing/misk.web/WebServerTestingModule/Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/#properties","title":"Properties","text":"Name Summary TESTING_WEB_CONFIG [jvm]val TESTING_WEB_CONFIG: WebConfig"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/-t-e-s-t-i-n-g_-w-e-b_-c-o-n-f-i-g/","title":"TESTING_WEB_CONFIG - Misk","text":"//misk-testing/misk.web/WebServerTestingModule/Companion/TESTING_WEB_CONFIG
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/-t-e-s-t-i-n-g_-w-e-b_-c-o-n-f-i-g/#testing_web_config","title":"TESTING_WEB_CONFIG","text":"[jvm]\\ val TESTING_WEB_CONFIG: WebConfig
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/","title":"WebTestClient - Misk","text":"//misk-testing/misk.web/WebTestClient
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/#webtestclient","title":"WebTestClient","text":"[jvm]\\ class WebTestClient@Injectconstructor(moshi: Moshi, jettyService: JettyService)
Use WebTestClient to test calls to the application at the integration level.
To use:
@MiskTest(startService = true) to the test class@MiskTestModule val module = TestModule()WebTestingModule to the module under test: install(WebTestingModule())WebTestClient in the test class//misk-testing/misk.web/WebTestClient/WebTestClient
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-client/#webtestclient","title":"WebTestClient","text":"[jvm]\\
@Inject
constructor(moshi: Moshi, jettyService: JettyService)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/call/","title":"call - Misk","text":"//misk-testing/misk.web/WebTestClient/call
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/call/#call","title":"call","text":"[jvm]\\ fun call(path: String, action: Request.Builder.() -> Unit): WebTestClient.WebTestResponse
Performs a call to the started service. Allows the caller to customize the action before it\u2019s sent through.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/get/","title":"get - Misk","text":"//misk-testing/misk.web/WebTestClient/get
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/get/#get","title":"get","text":"[jvm]\\ fun get(path: String): WebTestClient.WebTestResponse
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/post/","title":"post - Misk","text":"//misk-testing/misk.web/WebTestClient/post
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/post/#post","title":"post","text":"[jvm]\\ fun <T : Any> post(path: String, body: T, tClass: KClass<T>): WebTestClient.WebTestResponse
inline fun <T : Any> post(path: String, body: T): WebTestClient.WebTestResponse
Performs a POST request with a JSON request body created from the input.
[jvm]\\
@JvmOverloads
fun post(path: String, body: String, mediaType: MediaType = MediaTypes.APPLICATION_JSON_MEDIA_TYPE): WebTestClient.WebTestResponse
Performs a POST request.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/","title":"WebTestResponse - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#webtestresponse","title":"WebTestResponse","text":"[jvm]\\ data class WebTestResponse(val response: Response, moshi: Moshi)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#constructors","title":"Constructors","text":"WebTestResponse [jvm]constructor(response: Response, moshi: Moshi)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#properties","title":"Properties","text":"Name Summary response [jvm]val response: Response"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#functions","title":"Functions","text":"Name Summary parseJson [jvm]inline fun <T : Any> parseJson(): Tfun <T : Any> parseJson(tClass: KClass<T>): T"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/-web-test-response/","title":"WebTestResponse - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse/WebTestResponse
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/-web-test-response/#webtestresponse","title":"WebTestResponse","text":"[jvm]\\ constructor(response: Response, moshi: Moshi)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/parse-json/","title":"parseJson - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse/parseJson
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/parse-json/#parsejson","title":"parseJson","text":"[jvm]\\ fun <T : Any> parseJson(tClass: KClass<T>): T
inline fun <T : Any> parseJson(): T
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/response/","title":"response - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse/response
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/response/#response","title":"response","text":"[jvm]\\ val response: Response
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/","title":"WithMiskCaller - Misk","text":"//misk-testing/misk.web/WithMiskCaller
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/#withmiskcaller","title":"WithMiskCaller","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
@ExtendWith(value = [MiskCallerExtension::class])
annotation class WithMiskCaller(val user: String = \"\", val service: String = \"\")
Use this annotation to specify an ActionScoped for this class.
Annotate after misk.testing.MiskTest.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/#properties","title":"Properties","text":"Name Summary service [jvm]val service: String user [jvm]val user: String"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/service/","title":"service - Misk","text":"//misk-testing/misk.web/WithMiskCaller/service
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/service/#service","title":"service","text":"[jvm]\\ val service: String
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/user/","title":"user - Misk","text":"//misk-testing/misk.web/WithMiskCaller/user
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/user/#user","title":"user","text":"[jvm]\\ val user: String
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/","title":"Package-level declarations - Misk","text":"//misk-testing/org.assertj.core.api
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/#functions","title":"Functions","text":"Name Summary assertOrdering [jvm]fun <A : Comparable<A>> assertOrdering(vararg values: A) containsExactly [jvm]inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE> isEqualToAsJson [jvm]fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/assert-ordering/","title":"assertOrdering - Misk","text":"//misk-testing/org.assertj.core.api/assertOrdering
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/assert-ordering/#assertordering","title":"assertOrdering","text":"[jvm]\\ fun <A : Comparable<A>> assertOrdering(vararg values: A)
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/contains-exactly/","title":"containsExactly - Misk","text":"//misk-testing/org.assertj.core.api/containsExactly
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/contains-exactly/#containsexactly","title":"containsExactly","text":"[jvm]\\ inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE>
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/is-equal-to-as-json/","title":"isEqualToAsJson - Misk","text":"//misk-testing/org.assertj.core.api/isEqualToAsJson
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/is-equal-to-as-json/#isequaltoasjson","title":"isEqualToAsJson","text":"[jvm]\\ fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>
"},{"location":"0.x/misk-testing-api/","title":"misk-testing-api - Misk","text":"//misk-testing-api
"},{"location":"0.x/misk-testing-api/#misk-testing-api","title":"misk-testing-api","text":""},{"location":"0.x/misk-testing-api/#packages","title":"Packages","text":"Name misk.testing"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/","title":"Package-level declarations - Misk","text":"//misk-testing-api/misk.testing
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/#types","title":"Types","text":"Name Summary FakeFixture [jvm]open class FakeFixture : TestFixtureBase class providing a mechanism to define properties in fakes that will automatically be reset between test runs. The properties are defined using theresettable function, which creates a resettable property delegate. ResettablePropertyDelegate [jvm]class ResettablePropertyDelegate<T>(initializer: () -> T) TestFixture [jvm]interface TestFixtureInterface for test fixtures that need to be reset between test runs, when the reuse injector feature is enabled."},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/","title":"FakeFixture - Misk","text":"//misk-testing-api/misk.testing/FakeFixture
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/#fakefixture","title":"FakeFixture","text":"[jvm]\\ open class FakeFixture : TestFixture
Base class providing a mechanism to define properties in fakes that will automatically be reset between test runs. The properties are defined using the resettable function, which creates a resettable property delegate.
class FakeJwtVerifier @Inject constructor() : JwtVerifier, FakeFixture() {\n - private var succeeds = true\n + private var succeeds by resettable { true }\n\n // more methods\n}\n//misk-testing-api/misk.testing/FakeFixture/FakeFixture
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/-fake-fixture/#fakefixture","title":"FakeFixture","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/reset/","title":"reset - Misk","text":"//misk-testing-api/misk.testing/FakeFixture/reset
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
Called before each test run to reset the state of the fixture.
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/resettable/","title":"resettable - Misk","text":"//misk-testing-api/misk.testing/FakeFixture/resettable
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/resettable/#resettable","title":"resettable","text":"[jvm]\\ fun <T> resettable(initializer: () -> T): ResettablePropertyDelegate<T>
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/","title":"ResettablePropertyDelegate - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/#resettablepropertydelegate","title":"ResettablePropertyDelegate","text":"[jvm]\\ class ResettablePropertyDelegate<T>(initializer: () -> T)
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/#constructors","title":"Constructors","text":"ResettablePropertyDelegate [jvm]constructor(initializer: () -> T)"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/#functions","title":"Functions","text":"Name Summary getValue [jvm]operator fun getValue(thisRef: Any?, property: KProperty<*>): T reset [jvm]fun reset() setValue [jvm]operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T)"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/-resettable-property-delegate/","title":"ResettablePropertyDelegate - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/ResettablePropertyDelegate
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/-resettable-property-delegate/#resettablepropertydelegate","title":"ResettablePropertyDelegate","text":"[jvm]\\ constructor(initializer: () -> T)
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/get-value/","title":"getValue - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/getValue
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/get-value/#getvalue","title":"getValue","text":"[jvm]\\ operator fun getValue(thisRef: Any?, property: KProperty<*>): T
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/reset/","title":"reset - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/reset
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/reset/#reset","title":"reset","text":"[jvm]\\ fun reset()
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/set-value/","title":"setValue - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/setValue
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/set-value/#setvalue","title":"setValue","text":"[jvm]\\ operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T)
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-test-fixture/","title":"TestFixture - Misk","text":"//misk-testing-api/misk.testing/TestFixture
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-test-fixture/#testfixture","title":"TestFixture","text":"interface TestFixture
Interface for test fixtures that need to be reset between test runs, when the reuse injector feature is enabled.
This needs to be implemented by:
vars or mutable collections. The reset implementation should set the state to the initial values. In such case, prefer extending the DelegatedPropertiesTestFixture class instead.reset implementation needs to clear the store.TestFixtures must be multibound in a Guice module to ensure that the test infrastructure can reset them between test runs. For example:
bind<Clock>().to<FakeClock>()\n + multibind<TestFixture>().to<FakeClock>()\n//misk-testing-api/misk.testing/TestFixture/reset
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-test-fixture/reset/#reset","title":"reset","text":"[jvm]\\ abstract fun reset()
Called before each test run to reset the state of the fixture.
"},{"location":"0.x/misk-warmup/","title":"misk-warmup - Misk","text":"//misk-warmup
"},{"location":"0.x/misk-warmup/#misk-warmup","title":"misk-warmup","text":""},{"location":"0.x/misk-warmup/#packages","title":"Packages","text":"Name misk.warmup"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/","title":"Package-level declarations - Misk","text":"//misk-warmup/misk.warmup
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/#types","title":"Types","text":"Name Summary WarmupModule [jvm]class WarmupModule(name: String, key: Key<out WarmupTask>) : KAbstractModule WarmupTask [jvm]abstract class WarmupTaskRegister a warmup task in your service with the following:"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/#functions","title":"Functions","text":"Name Summary WarmupModule [jvm]inline fun <T : WarmupTask> WarmupModule(qualifier: KClass<out Annotation>? = null): WarmupModule"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/","title":"WarmupModule - Misk","text":"//misk-warmup/misk.warmup/WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#warmupmodule","title":"WarmupModule","text":"[jvm]\\ inline fun <T : WarmupTask> WarmupModule(qualifier: KClass<out Annotation>? = null): WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/","title":"WarmupModule - Misk","text":"//misk-warmup/misk.warmup/WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#warmupmodule","title":"WarmupModule","text":"[jvm]\\ class WarmupModule(name: String, key: Key<out WarmupTask>) : KAbstractModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#constructors","title":"Constructors","text":"WarmupModule [jvm]constructor(name: String, key: Key<out WarmupTask>)"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/-warmup-module/","title":"WarmupModule - Misk","text":"//misk-warmup/misk.warmup/WarmupModule/WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/-warmup-module/#warmupmodule","title":"WarmupModule","text":"[jvm]\\ constructor(name: String, key: Key<out WarmupTask>)
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/","title":"WarmupTask - Misk","text":"//misk-warmup/misk.warmup/WarmupTask
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/#warmuptask","title":"WarmupTask","text":"[jvm]\\ abstract class WarmupTask
Register a warmup task in your service with the following:
install(WarmupModule<MyWarmupTask>())\nMisk will run the task after all services have started successfully, but before health checks report the service as healthy. Warm up tasks should complete quickly (under 10 seconds is best) because the service won\u2019t serve live traffic until all warm up tasks complete.
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/#constructors","title":"Constructors","text":"WarmupTask [jvm]constructor()"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/#functions","title":"Functions","text":"Name Summary execute [jvm]abstract fun execute()Perform production-like work to cause caches to be seeded, pools to be filled, and hot spots to be compiled. This should return once warmup is complete."},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/-warmup-task/","title":"WarmupTask - Misk","text":"//misk-warmup/misk.warmup/WarmupTask/WarmupTask
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/-warmup-task/#warmuptask","title":"WarmupTask","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/execute/","title":"execute - Misk","text":"//misk-warmup/misk.warmup/WarmupTask/execute
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/execute/#execute","title":"execute","text":"[jvm]\\ abstract fun execute()
Perform production-like work to cause caches to be seeded, pools to be filled, and hot spots to be compiled. This should return once warmup is complete.
"},{"location":"0.x/wisp-aws-environment/","title":"wisp-aws-environment - Misk","text":"//wisp-aws-environment
"},{"location":"0.x/wisp-aws-environment/#wisp-aws-environment","title":"wisp-aws-environment","text":""},{"location":"0.x/wisp-aws-environment/#packages","title":"Packages","text":"Name wisp.aws.environment"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/","title":"Package-level declarations - Misk","text":"//wisp-aws-environment/wisp.aws.environment
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/#types","title":"Types","text":"Name Summary AwsAccountId [jvm]data class AwsAccountId(val value: String)AwsAccountId is the id of the account in which the service is running AwsEnvironment [jvm]object AwsEnvironmentAwsEnvironment pulls region and account information from installed environment variables AwsRegion [jvm]data class AwsRegion(val name: String)AwsRegion is the region in which the service is running"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/","title":"AwsAccountId - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ data class AwsAccountId(val value: String)
AwsAccountId is the id of the account in which the service is running
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/#constructors","title":"Constructors","text":"AwsAccountId [jvm]constructor(value: String)"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/-aws-account-id/","title":"AwsAccountId - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsAccountId/AwsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ constructor(value: String)
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/value/","title":"value - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsAccountId/value
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/","title":"AwsEnvironment - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsEnvironment
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/#awsenvironment","title":"AwsEnvironment","text":"[jvm]\\ object AwsEnvironment
AwsEnvironment pulls region and account information from installed environment variables
Note: Because of different package names for AWS1 vs AWS2 sdks, we can\u2019t use AWS\u2019s Region class.
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/#functions","title":"Functions","text":"Name Summary awsAccountId [jvm]fun awsAccountId(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariable: String = \"ACCOUNT_ID\"): AwsAccountId awsRegion [jvm]fun awsRegion(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariables: List<String> = listOf(\"REGION\", \"AWS_REGION\"), defaultAwsRegion: String = \"us-west-2\"): AwsRegion"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-account-id/","title":"awsAccountId - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsEnvironment/awsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-account-id/#awsaccountid","title":"awsAccountId","text":"[jvm]\\ fun awsAccountId(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariable: String = \"ACCOUNT_ID\"): AwsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-region/","title":"awsRegion - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsEnvironment/awsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-region/#awsregion","title":"awsRegion","text":"[jvm]\\ fun awsRegion(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariables: List<String> = listOf(\"REGION\", \"AWS_REGION\"), defaultAwsRegion: String = \"us-west-2\"): AwsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/","title":"AwsRegion - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ data class AwsRegion(val name: String)
AwsRegion is the region in which the service is running
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/#constructors","title":"Constructors","text":"AwsRegion [jvm]constructor(name: String)"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/-aws-region/","title":"AwsRegion - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsRegion/AwsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/name/","title":"name - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsRegion/name
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-client/","title":"wisp-client - Misk","text":"//wisp-client
"},{"location":"0.x/wisp-client/#wisp-client","title":"wisp-client","text":""},{"location":"0.x/wisp-client/#packages","title":"Packages","text":"Name wisp.client"},{"location":"0.x/wisp-client/wisp-client/wisp.client/","title":"Package-level declarations - Misk","text":"//wisp-client/wisp.client
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-client/wisp-client/wisp.client/#types","title":"Types","text":"Name Summary EnvoyClientEndpointProvider [jvm]interface EnvoyClientEndpointProviderEnvoy configuration provider per endpoint that wisp clients can customize to their needs. HttpClientConfig [jvm]data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null) HttpClientEndpointConfig [jvm]data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig()) HttpClientEnvoyConfig [jvm]data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null) HttpClientFactory [jvm]class HttpClientFactory@JvmOverloadsconstructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null) HttpClientsConfig [jvm]data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf()) HttpClientSSLConfig [jvm]data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig) NoOpDns [jvm]object NoOpDns : Dns OkHttpClientCommonConfigurator [jvm]class OkHttpClientCommonConfigurator UnixDomainServerSocketFactory [jvm]class UnixDomainServerSocketFactory : ServerSocketFactoryImpersonate TCP-style ServerSocketFactory over UNIX domain sockets. UnixDomainSocketFactory [jvm]class UnixDomainSocketFactory : SocketFactoryImpersonate TCP-style SocketFactory over UNIX domain sockets."},{"location":"0.x/wisp-client/wisp-client/wisp.client/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/apply-defaults/","title":"applyDefaults - Misk","text":"//wisp-client/wisp.client/applyDefaults
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/apply-defaults/#applydefaults","title":"applyDefaults","text":"[jvm]\\ fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/","title":"EnvoyClientEndpointProvider - Misk","text":"//wisp-client/wisp.client/EnvoyClientEndpointProvider
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"EnvoyClientEndpointProvider","text":"[jvm]\\ interface EnvoyClientEndpointProvider
Envoy configuration provider per endpoint that wisp clients can customize to their needs.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/#functions","title":"Functions","text":"Name Summary unixSocket [jvm]abstract fun unixSocket(httpClientEnvoyConfig: HttpClientEnvoyConfig): FileUnix socket file to be used to communicate to the local Envoy sidecar. url [jvm]abstract fun url(httpClientEnvoyConfig: HttpClientEnvoyConfig): StringHost header that will be used to route the request."},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/unix-socket/","title":"unixSocket - Misk","text":"//wisp-client/wisp.client/EnvoyClientEndpointProvider/unixSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/unix-socket/#unixsocket","title":"unixSocket","text":"[jvm]\\ abstract fun unixSocket(httpClientEnvoyConfig: HttpClientEnvoyConfig): File
Unix socket file to be used to communicate to the local Envoy sidecar.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/url/","title":"url - Misk","text":"//wisp-client/wisp.client/EnvoyClientEndpointProvider/url
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/url/#url","title":"url","text":"[jvm]\\ abstract fun url(httpClientEnvoyConfig: HttpClientEnvoyConfig): String
Host header that will be used to route the request.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/","title":"HttpClientConfig - Misk","text":"//wisp-client/wisp.client/HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\ data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#constructors","title":"Constructors","text":"HttpClientConfig [jvm]@JvmOverloadsconstructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null connectTimeout [jvm]val connectTimeout: Duration? = null keepAliveDuration [jvm]val keepAliveDuration: Duration? = null maxIdleConnections [jvm]val maxIdleConnections: Int? = null maxRequests [jvm]val maxRequests: Int? = null maxRequestsPerHost [jvm]val maxRequestsPerHost: Int? = null pingInterval [jvm]val pingInterval: Duration? = null protocols [jvm]val protocols: List<String>? = null readTimeout [jvm]val readTimeout: Duration? = null retryOnConnectionFailure [jvm]val retryOnConnectionFailure: Boolean? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null unixSocketFile [jvm]val unixSocketFile: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/-http-client-config/","title":"HttpClientConfig - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\
@JvmOverloads
constructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/call-timeout/","title":"callTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/callTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/call-timeout/#calltimeout","title":"callTimeout","text":"[jvm]\\ val callTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/connect-timeout/","title":"connectTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/connectTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"[jvm]\\ val connectTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/keepAliveDuration
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/maxIdleConnections
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ val maxIdleConnections: Int? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/maxRequestsPerHost
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"[jvm]\\ val maxRequestsPerHost: Int? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests/","title":"maxRequests - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/maxRequests
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests/#maxrequests","title":"maxRequests","text":"[jvm]\\ val maxRequests: Int? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ping-interval/","title":"pingInterval - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/pingInterval
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ping-interval/#pinginterval","title":"pingInterval","text":"[jvm]\\ val pingInterval: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/protocols/","title":"protocols - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/protocols
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/protocols/#protocols","title":"protocols","text":"[jvm]\\ val protocols: List<String>? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/read-timeout/","title":"readTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/readTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/read-timeout/#readtimeout","title":"readTimeout","text":"[jvm]\\ val readTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/retryOnConnectionFailure
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"[jvm]\\ val retryOnConnectionFailure: Boolean? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ssl/","title":"ssl - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/ssl
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/unix-socket-file/","title":"unixSocketFile - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/unixSocketFile
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/unix-socket-file/#unixsocketfile","title":"unixSocketFile","text":"[jvm]\\ val unixSocketFile: String? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/write-timeout/","title":"writeTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/writeTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/write-timeout/#writetimeout","title":"writeTimeout","text":"[jvm]\\ val writeTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\ data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/#constructors","title":"Constructors","text":"HttpClientEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/#properties","title":"Properties","text":"Name Summary clientConfig [jvm]val clientConfig: HttpClientConfig envoy [jvm]val envoy: HttpClientEnvoyConfig? = null url [jvm]val url: String? = null"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/client-config/","title":"clientConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/clientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"[jvm]\\ val clientConfig: HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/envoy/","title":"envoy - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/envoy
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/envoy/#envoy","title":"envoy","text":"[jvm]\\ val envoy: HttpClientEnvoyConfig? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/url/","title":"url - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/url
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\ data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/#constructors","title":"Constructors","text":"HttpClientEnvoyConfig [jvm]@JvmOverloadsconstructor(app: String, env: String? = null)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/#properties","title":"Properties","text":"Name Summary app [jvm]val app: String env [jvm]val env: String? = nullEnvironment to target. If null, the same environment as the app is running in is assumed."},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig/HttpClientEnvoyConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\
@JvmOverloads
constructor(app: String, env: String? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/app/","title":"app - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig/app
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/app/#app","title":"app","text":"[jvm]\\ val app: String
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/env/","title":"env - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig/env
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/env/#env","title":"env","text":"[jvm]\\ val env: String? = null
Environment to target. If null, the same environment as the app is running in is assumed.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//wisp-client/wisp.client/HttpClientFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\ class HttpClientFactory@JvmOverloadsconstructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#constructors","title":"Constructors","text":"HttpClientFactory [jvm]@JvmOverloadsconstructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(config: HttpClientEndpointConfig): OkHttpClientReturns a client initialized based onconfig."},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//wisp-client/wisp.client/HttpClientFactory/HttpClientFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\
@JvmOverloads
constructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/create/","title":"create - Misk","text":"//wisp-client/wisp.client/HttpClientFactory/create
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/create/#create","title":"create","text":"[jvm]\\ fun create(config: HttpClientEndpointConfig): OkHttpClient
Returns a client initialized based on config.
//wisp-client/wisp.client/HttpClientFactory/Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/#constructors","title":"Constructors","text":"HttpClientSSLConfig [jvm]constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig? trust_store [jvm]val trust_store: TrustStoreConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig/HttpClientSSLConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/cert_store/","title":"cert_store - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig/cert_store
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/cert_store/#cert_store","title":"cert_store","text":"[jvm]\\ val cert_store: CertStoreConfig?
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/trust_store/","title":"trust_store - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig/trust_store
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/trust_store/#trust_store","title":"trust_store","text":"[jvm]\\ val trust_store: TrustStoreConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\ data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#constructors","title":"Constructors","text":"HttpClientsConfig [jvm]@JvmOverloadsconstructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf())"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#properties","title":"Properties","text":"Name Summary endpoints [jvm]val endpoints: Map<String, HttpClientEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig>"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#functions","title":"Functions","text":"Name Summary endpointNames [jvm]fun endpointNames(): Set<String>Names of configured endpoints, all of which can be fetched using get get [jvm]operator fun get(url: URL): HttpClientEndpointConfigoperator fun get(clientName: String): HttpClientEndpointConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/HttpClientsConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\
@JvmOverloads
constructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoint-names/","title":"endpointNames - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/endpointNames
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoint-names/#endpointnames","title":"endpointNames","text":"[jvm]\\ fun endpointNames(): Set<String>
Names of configured endpoints, all of which can be fetched using get
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoints/","title":"endpoints - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/endpoints
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoints/#endpoints","title":"endpoints","text":"[jvm]\\ val endpoints: Map<String, HttpClientEndpointConfig>
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/","title":"get - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/get
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/#get","title":"get","text":"[jvm]\\ operator fun get(clientName: String): HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/#return","title":"Return","text":"The HttpClientEndpointConfig for the given client, populated with defaults as needed
[jvm]\\ operator fun get(url: URL): HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/#return_1","title":"Return","text":"The HttpClientEndpointConfig for the given URL, populated with defaults as needed
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/host-configs/","title":"hostConfigs - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/hostConfigs
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/","title":"Companion - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/#properties","title":"Properties","text":"Name Summary httpClientConfigDefaults [jvm]val httpClientConfigDefaults: HttpClientConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/http-client-config-defaults/","title":"httpClientConfigDefaults - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/Companion/httpClientConfigDefaults
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/http-client-config-defaults/#httpclientconfigdefaults","title":"httpClientConfigDefaults","text":"[jvm]\\ val httpClientConfigDefaults: HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/","title":"NoOpDns - Misk","text":"//wisp-client/wisp.client/NoOpDns
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/#noopdns","title":"NoOpDns","text":"[jvm]\\ object NoOpDns : Dns
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/#functions","title":"Functions","text":"Name Summary lookup [jvm]open override fun lookup(hostname: String): List<InetAddress>"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/lookup/","title":"lookup - Misk","text":"//wisp-client/wisp.client/NoOpDns/lookup
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/lookup/#lookup","title":"lookup","text":"[jvm]\\ open override fun lookup(hostname: String): List<InetAddress>
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\ class OkHttpClientCommonConfigurator
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#constructors","title":"Constructors","text":"OkHttpClientCommonConfigurator [jvm]constructor()"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/OkHttpClientCommonConfigurator
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/configure/","title":"configure - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/configure
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/configure/#configure","title":"configure","text":"[jvm]\\ fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/","title":"Companion - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/#properties","title":"Properties","text":"Name Summary keepAliveDuration [jvm]val keepAliveDuration: Duration maxIdleConnections [jvm]const val maxIdleConnections: Int = 5 retryOnConnectionFailure [jvm]const val retryOnConnectionFailure: Boolean = false"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion/keepAliveDuration
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion/maxIdleConnections
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ const val maxIdleConnections: Int = 5
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion/retryOnConnectionFailure
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"[jvm]\\ const val retryOnConnectionFailure: Boolean = false
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/","title":"UnixDomainServerSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainServerSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/#unixdomainserversocketfactory","title":"UnixDomainServerSocketFactory","text":"[jvm]\\ class UnixDomainServerSocketFactory : ServerSocketFactory
Impersonate TCP-style ServerSocketFactory over UNIX domain sockets.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/#constructors","title":"Constructors","text":"UnixDomainServerSocketFactory [jvm]constructor(path: File)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/#functions","title":"Functions","text":"Name Summary createServerSocket [jvm]open fun createServerSocket(): ServerSocketopen fun createServerSocket(port: Int): ServerSocketopen fun createServerSocket(port: Int, backlog: Int): ServerSocketopen fun createServerSocket(port: Int, backlog: Int, inetAddress: InetAddress): ServerSocket getDefault [jvm]open fun getDefault(): ServerSocketFactory"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/-unix-domain-server-socket-factory/","title":"UnixDomainServerSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainServerSocketFactory/UnixDomainServerSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/-unix-domain-server-socket-factory/#unixdomainserversocketfactory","title":"UnixDomainServerSocketFactory","text":"[jvm]\\ constructor(path: File)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/create-server-socket/","title":"createServerSocket - Misk","text":"//wisp-client/wisp.client/UnixDomainServerSocketFactory/createServerSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/create-server-socket/#createserversocket","title":"createServerSocket","text":"[jvm]\\ open fun createServerSocket(): ServerSocket
open fun createServerSocket(port: Int): ServerSocket
open fun createServerSocket(port: Int, backlog: Int): ServerSocket
open fun createServerSocket(port: Int, backlog: Int, inetAddress: InetAddress): ServerSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/","title":"UnixDomainSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/#unixdomainsocketfactory","title":"UnixDomainSocketFactory","text":"[jvm]\\ class UnixDomainSocketFactory : SocketFactory
Impersonate TCP-style SocketFactory over UNIX domain sockets.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/#constructors","title":"Constructors","text":"UnixDomainSocketFactory [jvm]constructor(path: File)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/#functions","title":"Functions","text":"Name Summary createSocket [jvm]open fun createSocket(): Socketopen fun createSocket(host: String, port: Int): Socketopen fun createSocket(host: InetAddress, port: Int): Socketopen fun createSocket(host: String, port: Int, localHost: InetAddress, localPort: Int): Socketopen fun createSocket(host: InetAddress, port: Int, localAddress: InetAddress, localPort: Int): Socket getDefault [jvm]open fun getDefault(): SocketFactory"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/-unix-domain-socket-factory/","title":"UnixDomainSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainSocketFactory/UnixDomainSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/-unix-domain-socket-factory/#unixdomainsocketfactory","title":"UnixDomainSocketFactory","text":"[jvm]\\ constructor(path: File)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/create-socket/","title":"createSocket - Misk","text":"//wisp-client/wisp.client/UnixDomainSocketFactory/createSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/create-socket/#createsocket","title":"createSocket","text":"[jvm]\\ open fun createSocket(): Socket
open fun createSocket(host: String, port: Int): Socket
open fun createSocket(host: String, port: Int, localHost: InetAddress, localPort: Int): Socket
open fun createSocket(host: InetAddress, port: Int): Socket
open fun createSocket(host: InetAddress, port: Int, localAddress: InetAddress, localPort: Int): Socket
"},{"location":"0.x/wisp-config/","title":"wisp-config - Misk","text":"//wisp-config
"},{"location":"0.x/wisp-config/#wisp-config","title":"wisp-config","text":""},{"location":"0.x/wisp-config/#packages","title":"Packages","text":"Name wisp.config"},{"location":"0.x/wisp-config/wisp-config/wisp.config/","title":"Package-level declarations - Misk","text":"//wisp-config/wisp.config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-config/wisp-config/wisp.config/#types","title":"Types","text":"Name Summary Config [jvm]interface Config ConfigSource [jvm]data class ConfigSource@JvmOverloadsconstructor(val configLocation: String, val format: String = \"yml\")Config location and format (default yaml). The location should be in a format that ResourceLoader understands. Configurable [jvm]interface Configurable<T : Config> PrefixResourceLoaderPreprocessor [jvm]class PrefixResourceLoaderPreprocessor@JvmOverloadsconstructor(val prefix: String, val resourceLoader: ResourceLoader = ResourceLoader.SYSTEM) : TraversingPrimitivePreprocessorPreprocessor for a config node. If the node is a StringNode and the value starts with the prefix, then the node value is treated as a resource location. This is loaded using the resourceLoader and returned as a StringNode. WispConfig [jvm]object WispConfigWispConfig is a wrapper around the Hoplite config library: https://github.com/sksamuel/hoplite"},{"location":"0.x/wisp-config/wisp-config/wisp.config/#functions","title":"Functions","text":"Name Summary addWispConfigSources [jvm]fun ConfigLoaderBuilder.addWispConfigSources(configSources: List<ConfigSource>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): ConfigLoaderBuilderAdd the config sources in the order supplied. If the config source location does not exist it is silently skipped, i.e. the config locations are optional."},{"location":"0.x/wisp-config/wisp-config/wisp.config/add-wisp-config-sources/","title":"addWispConfigSources - Misk","text":"//wisp-config/wisp.config/addWispConfigSources
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/add-wisp-config-sources/#addwispconfigsources","title":"addWispConfigSources","text":"[jvm]\\ fun ConfigLoaderBuilder.addWispConfigSources(configSources: List<ConfigSource>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): ConfigLoaderBuilder
Add the config sources in the order supplied. If the config source location does not exist it is silently skipped, i.e. the config locations are optional.
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config/","title":"Config - Misk","text":"//wisp-config/wisp.config/Config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config/#config","title":"Config","text":"[jvm]\\ interface Config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/","title":"ConfigSource - Misk","text":"//wisp-config/wisp.config/ConfigSource
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/#configsource","title":"ConfigSource","text":"[jvm]\\ data class ConfigSource@JvmOverloadsconstructor(val configLocation: String, val format: String = \"yml\")
Config location and format (default yaml). The location should be in a format that ResourceLoader understands.
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/#constructors","title":"Constructors","text":"ConfigSource [jvm]@JvmOverloadsconstructor(configLocation: String, format: String = \"yml\")"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/#properties","title":"Properties","text":"Name Summary configLocation [jvm]val configLocation: String format [jvm]val format: String"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/-config-source/","title":"ConfigSource - Misk","text":"//wisp-config/wisp.config/ConfigSource/ConfigSource
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/-config-source/#configsource","title":"ConfigSource","text":"[jvm]\\
@JvmOverloads
constructor(configLocation: String, format: String = \"yml\")
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/config-location/","title":"configLocation - Misk","text":"//wisp-config/wisp.config/ConfigSource/configLocation
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/config-location/#configlocation","title":"configLocation","text":"[jvm]\\ val configLocation: String
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/format/","title":"format - Misk","text":"//wisp-config/wisp.config/ConfigSource/format
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/","title":"Configurable - Misk","text":"//wisp-config/wisp.config/Configurable
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/#configurable","title":"Configurable","text":"[jvm]\\ interface Configurable<T : Config>
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/#functions","title":"Functions","text":"Name Summary configure [jvm]abstract fun configure(config: T) getConfigClass [jvm]abstract fun getConfigClass(): KClass<T>"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/configure/","title":"configure - Misk","text":"//wisp-config/wisp.config/Configurable/configure
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/configure/#configure","title":"configure","text":"[jvm]\\ abstract fun configure(config: T)
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/get-config-class/","title":"getConfigClass - Misk","text":"//wisp-config/wisp.config/Configurable/getConfigClass
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/get-config-class/#getconfigclass","title":"getConfigClass","text":"[jvm]\\ abstract fun getConfigClass(): KClass<T>
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/","title":"PrefixResourceLoaderPreprocessor - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#prefixresourceloaderpreprocessor","title":"PrefixResourceLoaderPreprocessor","text":"[jvm]\\ class PrefixResourceLoaderPreprocessor@JvmOverloadsconstructor(val prefix: String, val resourceLoader: ResourceLoader = ResourceLoader.SYSTEM) : TraversingPrimitivePreprocessor
Preprocessor for a config node. If the node is a StringNode and the value starts with the prefix, then the node value is treated as a resource location. This is loaded using the resourceLoader and returned as a StringNode.
prefix is one of ClasspathResourceLoaderBackend.SCHEME, EnvironmentResourceLoaderBackend.SCHEME or FilesystemLoaderBackend.SCHEME
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#constructors","title":"Constructors","text":"PrefixResourceLoaderPreprocessor [jvm]@JvmOverloadsconstructor(prefix: String, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM)"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#properties","title":"Properties","text":"Name Summary prefix [jvm]val prefix: String resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#functions","title":"Functions","text":"Name Summary handle [jvm]open override fun handle(node: PrimitiveNode, context: DecoderContext): ConfigResult<Node> process [jvm]open override fun process(node: Node, context: DecoderContext): ConfigResult<Node>"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/-prefix-resource-loader-preprocessor/","title":"PrefixResourceLoaderPreprocessor - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/PrefixResourceLoaderPreprocessor
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/-prefix-resource-loader-preprocessor/#prefixresourceloaderpreprocessor","title":"PrefixResourceLoaderPreprocessor","text":"[jvm]\\
@JvmOverloads
constructor(prefix: String, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM)
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/handle/","title":"handle - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/handle
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/handle/#handle","title":"handle","text":"[jvm]\\ open override fun handle(node: PrimitiveNode, context: DecoderContext): ConfigResult<Node>
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/prefix/","title":"prefix - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/prefix
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/prefix/#prefix","title":"prefix","text":"[jvm]\\ val prefix: String
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/resource-loader/","title":"resourceLoader - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/resourceLoader
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/","title":"WispConfig - Misk","text":"//wisp-config/wisp.config/WispConfig
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/#wispconfig","title":"WispConfig","text":"[jvm]\\ object WispConfig
WispConfig is a wrapper around the Hoplite config library: https://github.com/sksamuel/hoplite
Config precedence is in order of sources added for loading, so if you want an environment config file to override values in the default file, it has to be added first.
Note that config values from Environment Variables, System Properties and User Settings are always loaded first, see: https://github.com/sksamuel/hoplite#property-sources for details.
Secrets in config are automatically handled, see: https://github.com/sksamuel/hoplite#masked-values
Note that if you are passing configuration fragments within Wisp, your config class should implement Config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/#functions","title":"Functions","text":"Name Summary builder [jvm]fun builder(): ConfigLoaderBuilderGet a config builder."},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/builder/","title":"builder - Misk","text":"//wisp-config/wisp.config/WispConfig/builder
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/builder/#builder","title":"builder","text":"[jvm]\\ fun builder(): ConfigLoaderBuilder
Get a config builder.
Example use:
val myConfig = WispConfig.builder() \u2026 .addWispConfigSources(\u2026) \u2026 .build() .loadConfigOrThrow() Note that if you are passing configuration fragments within Wisp, MyConfig should implement Config"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/builder/#return","title":"Return","text":"
ConfigLoader.Builder
"},{"location":"0.x/wisp-containers-testing/","title":"wisp-containers-testing - Misk","text":"//wisp-containers-testing
"},{"location":"0.x/wisp-containers-testing/#wisp-containers-testing","title":"wisp-containers-testing","text":""},{"location":"0.x/wisp-containers-testing/#packages","title":"Packages","text":"Name wisp.containers"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/","title":"Package-level declarations - Misk","text":"//wisp-containers-testing/wisp.containers
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/#types","title":"Types","text":"Name Summary Composer [jvm]class Composer(name: String, containers: Container)Composer composes many Containers together to use in a unit test. Container [jvm]data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)A Container creates a Docker container for testing. ContainerUtil [jvm]object ContainerUtil"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/","title":"Composer - Misk","text":"//wisp-containers-testing/wisp.containers/Composer
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/#composer","title":"Composer","text":"[jvm]\\ class Composer(name: String, containers: Container)
Composer composes many Containers together to use in a unit test.
The Containers are networked using a dedicated Docker network. Tests need to expose ports in order for the test to communicate with the containers over 127.0.0.1.
The following example composes Kafka and Zookeeper containers for testing. Kafka is exposed to the jUnit test via 127.0.0.1:9102. In this example, Zookeeper is not exposed to the test.
val zkContainer = Container {\n withImage(\"confluentinc/cp-zookeeper\")\n withName(\"zookeeper\")\n withEnv(\"ZOOKEEPER_CLIENT_PORT=2181\")\n }\n val kafka = Container {\n withImage(\"confluentinc/cp-kafka\")\n withName(\"kafka\")\n withExposedPorts(ExposedPort.tcp(port))\n withPortBindings(Ports().apply {\n bind(ExposedPort.tcp(9102), Ports.Binding.bindPort(9102))\n })\n withEnv(\n \"KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181\",\n \"KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9102\")\n }\n val composer = Composer(\"e-kafka\", zkContainer, kafka)\n composer.start()\n//wisp-containers-testing/wisp.containers/Composer/Composer
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-composer/#composer","title":"Composer","text":"[jvm]\\ constructor(name: String, vararg containers: Container)
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/running/","title":"running - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/running
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/running/#running","title":"running","text":"[jvm]\\ val running: AtomicBoolean
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/start/","title":"start - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/start
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/start/#start","title":"start","text":"[jvm]\\ fun start()
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/stop/","title":"stop - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/stop
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/stop/#stop","title":"stop","text":"[jvm]\\ fun stop()
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/","title":"Companion - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/Companion
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/#properties","title":"Properties","text":"Name Summary dockerClient [jvm]val dockerClient: DockerClient"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/docker-client/","title":"dockerClient - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/Companion/dockerClient
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/docker-client/#dockerclient","title":"dockerClient","text":"[jvm]\\ val dockerClient: DockerClient
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/","title":"Container - Misk","text":"//wisp-containers-testing/wisp.containers/Container
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/#container","title":"Container","text":"[jvm]\\ data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)
A Container creates a Docker container for testing.
Tests provide a lambda to build a CreateContainerCmd. The createCmd lambda must set CreateContainerCmd.withName and CreateContainerCmd.withImage. All other fields are optional. The Composer takes care of setting up the network.
There may be a need to configure your container between the creation and start steps. beforeStartHook provides you with an id to your container allowing you to manipulate as necessary before the command/entrypoint is invoked.
See Composer for an example.
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/#constructors","title":"Constructors","text":"Container [jvm]constructor(createCmd: CreateContainerCmd.() -> Unit)constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/#properties","title":"Properties","text":"Name Summary beforeStartHook [jvm]val beforeStartHook: (docker: DockerClient, id: String) -> Unit createCmd [jvm]val createCmd: CreateContainerCmd.() -> Unit"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/-container/","title":"Container - Misk","text":"//wisp-containers-testing/wisp.containers/Container/Container
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/-container/#container","title":"Container","text":"[jvm]\\ constructor(createCmd: CreateContainerCmd.() -> Unit)
constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/before-start-hook/","title":"beforeStartHook - Misk","text":"//wisp-containers-testing/wisp.containers/Container/beforeStartHook
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/before-start-hook/#beforestarthook","title":"beforeStartHook","text":"[jvm]\\ val beforeStartHook: (docker: DockerClient, id: String) -> Unit
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/create-cmd/","title":"createCmd - Misk","text":"//wisp-containers-testing/wisp.containers/Container/createCmd
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/create-cmd/#createcmd","title":"createCmd","text":"[jvm]\\ val createCmd: CreateContainerCmd.() -> Unit
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/","title":"ContainerUtil - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/#containerutil","title":"ContainerUtil","text":"[jvm]\\ object ContainerUtil
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/#properties","title":"Properties","text":"Name Summary isRunningInDocker [jvm]val isRunningInDocker: Boolean"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/#functions","title":"Functions","text":"Name Summary dockerTargetOrLocalHost [jvm]fun dockerTargetOrLocalHost(): String dockerTargetOrLocalIp [jvm]fun dockerTargetOrLocalIp(): String"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-host/","title":"dockerTargetOrLocalHost - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil/dockerTargetOrLocalHost
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-host/#dockertargetorlocalhost","title":"dockerTargetOrLocalHost","text":"[jvm]\\ fun dockerTargetOrLocalHost(): String
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-ip/","title":"dockerTargetOrLocalIp - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil/dockerTargetOrLocalIp
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-ip/#dockertargetorlocalip","title":"dockerTargetOrLocalIp","text":"[jvm]\\ fun dockerTargetOrLocalIp(): String
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/is-running-in-docker/","title":"isRunningInDocker - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil/isRunningInDocker
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/is-running-in-docker/#isrunningindocker","title":"isRunningInDocker","text":"[jvm]\\ val isRunningInDocker: Boolean
"},{"location":"0.x/wisp-deployment/","title":"wisp-deployment - Misk","text":"//wisp-deployment
"},{"location":"0.x/wisp-deployment/#wisp-deployment","title":"wisp-deployment","text":""},{"location":"0.x/wisp-deployment/#packages","title":"Packages","text":"Name wisp.deployment"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/","title":"Package-level declarations - Misk","text":"//wisp-deployment/wisp.deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#types","title":"Types","text":"Name Summary Deployment [jvm]data class Deployment@JvmOverloadsconstructor(val name: String, val isProduction: Boolean = false, val isStaging: Boolean = false, val isTest: Boolean = false, val isLocalDevelopment: Boolean = false)Deployment describes the context in which the application is running DeploymentLocation [jvm]interface DeploymentLocationFor information about the deployment location. EnvironmentVariableDeploymentLocation [jvm]class EnvironmentVariableDeploymentLocation@JvmOverloadsconstructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real) : DeploymentLocationProvides a deployment location id from the environment variable value. EnvironmentVariableLoader [jvm]interface EnvironmentVariableLoaderLoads an environment variable value. RealEnvironmentVariableLoader [jvm]class RealEnvironmentVariableLoader : EnvironmentVariableLoader"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#properties","title":"Properties","text":"Name Summary deployments [jvm]val deployments: Map<String, Deployment> DEVELOPMENT [jvm]val DEVELOPMENT: Deployment PRODUCTION [jvm]val PRODUCTION: Deployment STAGING [jvm]val STAGING: Deployment TESTING [jvm]val TESTING: Deployment"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#functions","title":"Functions","text":"Name Summary getDeploymentFromEnvironmentVariable [jvm]fun getDeploymentFromEnvironmentVariable(defaultDeployment: Deployment = DEVELOPMENT, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real): DeploymentDetermines a Deployment based on the value within the ENVIRONMENT variable, defaulting to local development if not set (i.e. isLocalDevelopment == true)"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-d-e-v-e-l-o-p-m-e-n-t/","title":"DEVELOPMENT - Misk","text":"//wisp-deployment/wisp.deployment/DEVELOPMENT
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-d-e-v-e-l-o-p-m-e-n-t/#development","title":"DEVELOPMENT","text":"[jvm]\\ val DEVELOPMENT: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-p-r-o-d-u-c-t-i-o-n/","title":"PRODUCTION - Misk","text":"//wisp-deployment/wisp.deployment/PRODUCTION
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-p-r-o-d-u-c-t-i-o-n/#production","title":"PRODUCTION","text":"[jvm]\\ val PRODUCTION: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-s-t-a-g-i-n-g/","title":"STAGING - Misk","text":"//wisp-deployment/wisp.deployment/STAGING
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-s-t-a-g-i-n-g/#staging","title":"STAGING","text":"[jvm]\\ val STAGING: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-t-e-s-t-i-n-g/","title":"TESTING - Misk","text":"//wisp-deployment/wisp.deployment/TESTING
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-t-e-s-t-i-n-g/#testing","title":"TESTING","text":"[jvm]\\ val TESTING: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/deployments/","title":"deployments - Misk","text":"//wisp-deployment/wisp.deployment/deployments
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/deployments/#deployments","title":"deployments","text":"[jvm]\\ val deployments: Map<String, Deployment>
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/get-deployment-from-environment-variable/","title":"getDeploymentFromEnvironmentVariable - Misk","text":"//wisp-deployment/wisp.deployment/getDeploymentFromEnvironmentVariable
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/get-deployment-from-environment-variable/#getdeploymentfromenvironmentvariable","title":"getDeploymentFromEnvironmentVariable","text":"[jvm]\\ fun getDeploymentFromEnvironmentVariable(defaultDeployment: Deployment = DEVELOPMENT, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real): Deployment
Determines a Deployment based on the value within the ENVIRONMENT variable, defaulting to local development if not set (i.e. isLocalDevelopment == true)
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/","title":"Deployment - Misk","text":"//wisp-deployment/wisp.deployment/Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#deployment","title":"Deployment","text":"[jvm]\\ data class Deployment@JvmOverloadsconstructor(val name: String, val isProduction: Boolean = false, val isStaging: Boolean = false, val isTest: Boolean = false, val isLocalDevelopment: Boolean = false)
Deployment describes the context in which the application is running
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#constructors","title":"Constructors","text":"Deployment [jvm]@JvmOverloadsconstructor(name: String, isProduction: Boolean = false, isStaging: Boolean = false, isTest: Boolean = false, isLocalDevelopment: Boolean = false)"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#properties","title":"Properties","text":"Name Summary isFake [jvm]val isFake: BooleanReturns true if running outside of a cluster (CI or local development). Mutually exclusive with isReal. isLocalDevelopment [jvm]val isLocalDevelopment: Boolean = falseWhether the service is running on a local developer machine, including as a Docker image. isProduction [jvm]val isProduction: Boolean = falseWhether the service is running in a production environment, having an SLA or handling customer data. isReal [jvm]val isReal: BooleanReturns true if running in a managed cluster, such as a staging or production cluster. Mutually exclusive with isFake. isStaging [jvm]val isStaging: Boolean = falseWhether the service is running in a staging environment. isTest [jvm]val isTest: Boolean = falseWhether the service is running in a test environment, either locally or in a CI. name [jvm]val name: StringThe name of this deployment. This is used for debugging and should not be parsed."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#functions","title":"Functions","text":"Name Summary mapToEnvironmentName [jvm]fun mapToEnvironmentName(): String"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/-deployment/","title":"Deployment - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/-deployment/#deployment","title":"Deployment","text":"[jvm]\\
@JvmOverloads
constructor(name: String, isProduction: Boolean = false, isStaging: Boolean = false, isTest: Boolean = false, isLocalDevelopment: Boolean = false)
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-fake/","title":"isFake - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isFake
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-fake/#isfake","title":"isFake","text":"[jvm]\\ val isFake: Boolean
Returns true if running outside of a cluster (CI or local development). Mutually exclusive with isReal.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-local-development/","title":"isLocalDevelopment - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isLocalDevelopment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-local-development/#islocaldevelopment","title":"isLocalDevelopment","text":"[jvm]\\ val isLocalDevelopment: Boolean = false
Whether the service is running on a local developer machine, including as a Docker image.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-production/","title":"isProduction - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isProduction
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-production/#isproduction","title":"isProduction","text":"[jvm]\\ val isProduction: Boolean = false
Whether the service is running in a production environment, having an SLA or handling customer data.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-real/","title":"isReal - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isReal
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-real/#isreal","title":"isReal","text":"[jvm]\\ val isReal: Boolean
Returns true if running in a managed cluster, such as a staging or production cluster. Mutually exclusive with isFake.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-staging/","title":"isStaging - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isStaging
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-staging/#isstaging","title":"isStaging","text":"[jvm]\\ val isStaging: Boolean = false
Whether the service is running in a staging environment.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-test/","title":"isTest - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isTest
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-test/#istest","title":"isTest","text":"[jvm]\\ val isTest: Boolean = false
Whether the service is running in a test environment, either locally or in a CI.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/map-to-environment-name/","title":"mapToEnvironmentName - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/mapToEnvironmentName
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/map-to-environment-name/#maptoenvironmentname","title":"mapToEnvironmentName","text":"[jvm]\\ fun mapToEnvironmentName(): String
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/name/","title":"name - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/name
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/name/#name","title":"name","text":"[jvm]\\ val name: String
The name of this deployment. This is used for debugging and should not be parsed.
All pods in the same deployment will have this same name.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/","title":"DeploymentLocation - Misk","text":"//wisp-deployment/wisp.deployment/DeploymentLocation
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/#deploymentlocation","title":"DeploymentLocation","text":"interface DeploymentLocation
For information about the deployment location.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/#inheritors","title":"Inheritors","text":"EnvironmentVariableDeploymentLocation"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: StringDeployment identification, e.g. Kubernetes pod name or host name, etc."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/id/","title":"id - Misk","text":"//wisp-deployment/wisp.deployment/DeploymentLocation/id
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/id/#id","title":"id","text":"[jvm]\\ abstract val id: String
Deployment identification, e.g. Kubernetes pod name or host name, etc.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/","title":"EnvironmentVariableDeploymentLocation - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableDeploymentLocation
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/#environmentvariabledeploymentlocation","title":"EnvironmentVariableDeploymentLocation","text":"[jvm]\\ class EnvironmentVariableDeploymentLocation@JvmOverloadsconstructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real) : DeploymentLocation
Provides a deployment location id from the environment variable value.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/#constructors","title":"Constructors","text":"EnvironmentVariableDeploymentLocation [jvm]@JvmOverloadsconstructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real)"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: StringDeployment identification, e.g. Kubernetes pod name or host name, etc."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/-environment-variable-deployment-location/","title":"EnvironmentVariableDeploymentLocation - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableDeploymentLocation/EnvironmentVariableDeploymentLocation
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/-environment-variable-deployment-location/#environmentvariabledeploymentlocation","title":"EnvironmentVariableDeploymentLocation","text":"[jvm]\\
@JvmOverloads
constructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real)
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/id/","title":"id - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableDeploymentLocation/id
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/id/#id","title":"id","text":"[jvm]\\ open override val id: String
Deployment identification, e.g. Kubernetes pod name or host name, etc.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/","title":"EnvironmentVariableLoader - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#environmentvariableloader","title":"EnvironmentVariableLoader","text":"interface EnvironmentVariableLoader
Loads an environment variable value.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#inheritors","title":"Inheritors","text":"RealEnvironmentVariableLoader"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): StringGet the environment variable value that must exist getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): StringGet the environment variable value, or if it does not exist, use the defaultValue supplied."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable-or-default/","title":"getEnvironmentVariableOrDefault - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/getEnvironmentVariableOrDefault
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable-or-default/#getenvironmentvariableordefault","title":"getEnvironmentVariableOrDefault","text":"[jvm]\\ open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String
Get the environment variable value, or if it does not exist, use the defaultValue supplied.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable/","title":"getEnvironmentVariable - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/getEnvironmentVariable
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable/#getenvironmentvariable","title":"getEnvironmentVariable","text":"[jvm]\\ open fun getEnvironmentVariable(name: String): String
Get the environment variable value that must exist
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable/#throws","title":"Throws","text":"IllegalStateException if the environment variable is not found"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/","title":"Companion - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/Companion
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/#properties","title":"Properties","text":"Name Summary real [jvm]val real: RealEnvironmentVariableLoader"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/real/","title":"real - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/Companion/real
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/real/#real","title":"real","text":"[jvm]\\ val real: RealEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/","title":"RealEnvironmentVariableLoader - Misk","text":"//wisp-deployment/wisp.deployment/RealEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/#realenvironmentvariableloader","title":"RealEnvironmentVariableLoader","text":"[jvm]\\ class RealEnvironmentVariableLoader : EnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/#constructors","title":"Constructors","text":"RealEnvironmentVariableLoader [jvm]constructor()"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): StringGet the environment variable value that must exist getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): StringGet the environment variable value, or if it does not exist, use the defaultValue supplied."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/-real-environment-variable-loader/","title":"RealEnvironmentVariableLoader - Misk","text":"//wisp-deployment/wisp.deployment/RealEnvironmentVariableLoader/RealEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/-real-environment-variable-loader/#realenvironmentvariableloader","title":"RealEnvironmentVariableLoader","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-deployment-testing/","title":"wisp-deployment-testing - Misk","text":"//wisp-deployment-testing
"},{"location":"0.x/wisp-deployment-testing/#wisp-deployment-testing","title":"wisp-deployment-testing","text":""},{"location":"0.x/wisp-deployment-testing/#packages","title":"Packages","text":"Name wisp.deployment"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/","title":"Package-level declarations - Misk","text":"//wisp-deployment-testing/wisp.deployment
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/#types","title":"Types","text":"Name Summary FakeDeploymentLocation [jvm]class FakeDeploymentLocation@JvmOverloadsconstructor(deploymentLocation: String = \"FakeDeploymentLocation\") : DeploymentLocation FakeEnvironmentVariableLoader [jvm]class FakeEnvironmentVariableLoader@JvmOverloadsconstructor(val vars: MutableMap<String, String> = mutableMapOf()) : EnvironmentVariableLoaderA Fake EnvironmentVariableLoader that loads from an in memory map"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/","title":"FakeDeploymentLocation - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeDeploymentLocation
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/#fakedeploymentlocation","title":"FakeDeploymentLocation","text":"[jvm]\\ class FakeDeploymentLocation@JvmOverloadsconstructor(deploymentLocation: String = \"FakeDeploymentLocation\") : DeploymentLocation
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/#constructors","title":"Constructors","text":"FakeDeploymentLocation [jvm]@JvmOverloadsconstructor(deploymentLocation: String = \"FakeDeploymentLocation\")"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: StringDeployment identification, e.g. Kubernetes pod name or host name, etc."},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/-fake-deployment-location/","title":"FakeDeploymentLocation - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeDeploymentLocation/FakeDeploymentLocation
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/-fake-deployment-location/#fakedeploymentlocation","title":"FakeDeploymentLocation","text":"[jvm]\\
@JvmOverloads
constructor(deploymentLocation: String = \"FakeDeploymentLocation\")
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/id/","title":"id - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeDeploymentLocation/id
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/id/#id","title":"id","text":"[jvm]\\ open override val id: String
Deployment identification, e.g. Kubernetes pod name or host name, etc.
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/","title":"FakeEnvironmentVariableLoader - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#fakeenvironmentvariableloader","title":"FakeEnvironmentVariableLoader","text":"[jvm]\\ class FakeEnvironmentVariableLoader@JvmOverloadsconstructor(val vars: MutableMap<String, String> = mutableMapOf()) : EnvironmentVariableLoader
A Fake EnvironmentVariableLoader that loads from an in memory map
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#constructors","title":"Constructors","text":"FakeEnvironmentVariableLoader [jvm]@JvmOverloadsconstructor(vars: MutableMap<String, String> = mutableMapOf())"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#properties","title":"Properties","text":"Name Summary vars [jvm]val vars: MutableMap<String, String>"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open override fun getEnvironmentVariable(name: String): String getEnvironmentVariableOrDefault [jvm]open override fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/-fake-environment-variable-loader/","title":"FakeEnvironmentVariableLoader - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/FakeEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/-fake-environment-variable-loader/#fakeenvironmentvariableloader","title":"FakeEnvironmentVariableLoader","text":"[jvm]\\
@JvmOverloads
constructor(vars: MutableMap<String, String> = mutableMapOf())
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable-or-default/","title":"getEnvironmentVariableOrDefault - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/getEnvironmentVariableOrDefault
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable-or-default/#getenvironmentvariableordefault","title":"getEnvironmentVariableOrDefault","text":"[jvm]\\ open override fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable/","title":"getEnvironmentVariable - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/getEnvironmentVariable
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable/#getenvironmentvariable","title":"getEnvironmentVariable","text":"[jvm]\\ open override fun getEnvironmentVariable(name: String): String
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/vars/","title":"vars - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/vars
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/vars/#vars","title":"vars","text":"[jvm]\\ val vars: MutableMap<String, String>
"},{"location":"0.x/wisp-feature/","title":"wisp-feature - Misk","text":"//wisp-feature
"},{"location":"0.x/wisp-feature/#wisp-feature","title":"wisp-feature","text":""},{"location":"0.x/wisp-feature/#packages","title":"Packages","text":"Name wisp.feature"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/","title":"Package-level declarations - Misk","text":"//wisp-feature/wisp.feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/#types","title":"Types","text":"Name Summary Attributes [jvm]open class Attributes@JvmOverloadsconstructor(val text: Map<String, String> = mapOf(), val number: Map<String, Number>? = null, val anonymous: Boolean = false)Extra attributes to be used for evaluating features. BooleanFeatureFlag [jvm]interface BooleanFeatureFlag : FeatureFlag<Boolean> DoubleFeatureFlag [jvm]interface DoubleFeatureFlag : FeatureFlag<Double> DynamicConfig [jvm]interface DynamicConfigInterface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys. EnumFeatureFlag [jvm]interface EnumFeatureFlag<T : Enum<T>> : FeatureFlag<T> A Enumeration feature flag, when evaluated returns T Feature [jvm]open class Feature(val name: String)Typed feature string. FeatureFlag [jvm]sealed interface FeatureFlag<T : Any> FeatureFlags [jvm]interface FeatureFlags : StrongFeatureFlags, LegacyFeatureFlagsInterface for evaluating feature flags. FeatureFlagValidation [jvm]object FeatureFlagValidation IntFeatureFlag [jvm]interface IntFeatureFlag : FeatureFlag<Int> JsonFeatureFlag [jvm]interface JsonFeatureFlag<T : Any> : FeatureFlag<T> A JSON feature flag, when evaluated returns T. LegacyFeatureFlags [jvm]interface LegacyFeatureFlags StringFeatureFlag [jvm]interface StringFeatureFlag : FeatureFlag<String> StrongFeatureFlags [jvm]interface StrongFeatureFlags TrackerReference [jvm]interface TrackerReference"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/#functions","title":"Functions","text":"Name Summary fromSafeJson [jvm]fun <T> JsonAdapter<T>.fromSafeJson(value: String): T?fun <T> JsonAdapter<T>.fromSafeJson(json: String, onUnknownFields: (JsonDataException) -> Unit): T?Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields. getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): Tinline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): Tinline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T toSafeJson [jvm]fun <T> JsonAdapter<T>.toSafeJson(value: T): Stringfun <T> JsonAdapter<T>.toSafeJson(value: T, onUnknownFields: (JsonDataException) -> Unit): StringAttempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields. trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/from-safe-json/","title":"fromSafeJson - Misk","text":"//wisp-feature/wisp.feature/fromSafeJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/from-safe-json/#fromsafejson","title":"fromSafeJson","text":"[jvm]\\ fun <T> JsonAdapter<T>.fromSafeJson(value: String): T?
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
This overload is needed for JVM compatibility.
[jvm]\\ fun <T> JsonAdapter<T>.fromSafeJson(json: String, onUnknownFields: (JsonDataException) -> Unit): T?
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-enum/","title":"getEnum - Misk","text":"//wisp-feature/wisp.feature/getEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T
inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-json/","title":"getJson - Misk","text":"//wisp-feature/wisp.feature/getJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-json/#getjson","title":"getJson","text":"[jvm]\\ inline fun <T> DynamicConfig.getJson(feature: Feature): T
inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/to-safe-json/","title":"toSafeJson - Misk","text":"//wisp-feature/wisp.feature/toSafeJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/to-safe-json/#tosafejson","title":"toSafeJson","text":"[jvm]\\ fun <T> JsonAdapter<T>.toSafeJson(value: T): String
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
This overload is needed for JVM compatibility.
[jvm]\\ fun <T> JsonAdapter<T>.toSafeJson(value: T, onUnknownFields: (JsonDataException) -> Unit): String
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature/wisp.feature/trackEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-json/","title":"trackJson - Misk","text":"//wisp-feature/wisp.feature/trackJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/","title":"Attributes - Misk","text":"//wisp-feature/wisp.feature/Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#attributes","title":"Attributes","text":"[jvm]\\ open class Attributes@JvmOverloadsconstructor(val text: Map<String, String> = mapOf(), val number: Map<String, Number>? = null, val anonymous: Boolean = false)
Extra attributes to be used for evaluating features.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#constructors","title":"Constructors","text":"Attributes [jvm]@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#properties","title":"Properties","text":"Name Summary anonymous [jvm]val anonymous: Boolean = false number [jvm]val number: Map<String, Number>? = null text [jvm]val text: Map<String, String>"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#functions","title":"Functions","text":"Name Summary copy [jvm]@JvmOverloadsfun copy(text: Map<String, String> = this.text, number: Map<String, Number>? = this.number, anonymous: Boolean = this.anonymous): Attributes equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String with [jvm]fun with(name: String, value: Number): Attributesfun with(name: String, value: String): Attributes"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/-attributes/","title":"Attributes - Misk","text":"//wisp-feature/wisp.feature/Attributes/Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/-attributes/#attributes","title":"Attributes","text":"[jvm]\\
@JvmOverloads
constructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/anonymous/","title":"anonymous - Misk","text":"//wisp-feature/wisp.feature/Attributes/anonymous
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/anonymous/#anonymous","title":"anonymous","text":"[jvm]\\ val anonymous: Boolean = false
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/copy/","title":"copy - Misk","text":"//wisp-feature/wisp.feature/Attributes/copy
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/copy/#copy","title":"copy","text":"[jvm]\\
@JvmOverloads
fun copy(text: Map<String, String> = this.text, number: Map<String, Number>? = this.number, anonymous: Boolean = this.anonymous): Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/equals/","title":"equals - Misk","text":"//wisp-feature/wisp.feature/Attributes/equals
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/hash-code/","title":"hashCode - Misk","text":"//wisp-feature/wisp.feature/Attributes/hashCode
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/number/","title":"number - Misk","text":"//wisp-feature/wisp.feature/Attributes/number
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/number/#number","title":"number","text":"[jvm]\\ val number: Map<String, Number>? = null
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/text/","title":"text - Misk","text":"//wisp-feature/wisp.feature/Attributes/text
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/text/#text","title":"text","text":"[jvm]\\ val text: Map<String, String>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/to-string/","title":"toString - Misk","text":"//wisp-feature/wisp.feature/Attributes/toString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/with/","title":"with - Misk","text":"//wisp-feature/wisp.feature/Attributes/with
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/with/#with","title":"with","text":"[jvm]\\ fun with(name: String, value: String): Attributes
fun with(name: String, value: Number): Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-boolean-feature-flag/","title":"BooleanFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/BooleanFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-boolean-feature-flag/#booleanfeatureflag","title":"BooleanFeatureFlag","text":"[jvm]\\ interface BooleanFeatureFlag : FeatureFlag<Boolean>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-boolean-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-double-feature-flag/","title":"DoubleFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/DoubleFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-double-feature-flag/#doublefeatureflag","title":"DoubleFeatureFlag","text":"[jvm]\\ interface DoubleFeatureFlag : FeatureFlag<Double>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-double-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/","title":"DynamicConfig - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/#dynamicconfig","title":"DynamicConfig","text":"[jvm]\\ interface DynamicConfig
Interface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]abstract fun getBoolean(feature: Feature): BooleanReturns the value of a boolean dynamic flag. getDouble [jvm]abstract fun getDouble(feature: Feature): DoubleReturns the value of a double dynamic flag. getEnum [jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): TReturns the value of an enumerated dynamic flag. getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T getInt [jvm]abstract fun getInt(feature: Feature): IntReturns the value of an integer dynamic flag. getJson [jvm]abstract fun <T> getJson(feature: Feature, clazz: Class<T>): TReturns the value of a JSON dynamic flag. getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): T getJsonString [jvm]abstract fun getJsonString(feature: Feature): StringReturns the value of a JSON string value of the dynamic flag. getString [jvm]abstract fun getString(feature: Feature): StringReturns the value of a string dynamic flag. trackBoolean [jvm]abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value. trackDouble [jvm]abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a double dynamic config tracker which will be invoked whenever the double dynamic config changes value. trackEnum [jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value. trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value. trackJson [jvm]abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a json dynamic config tracker which will be invoked whenever the json dynamic config changes value. trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a string dynamic config tracker which will be invoked whenever the string dynamic config changes value."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature): Boolean
Returns the value of a boolean dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-double/","title":"getDouble - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature): Double
Returns the value of a double dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
Returns the value of an enumerated dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-int/","title":"getInt - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature): Int
Returns the value of an integer dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json-string/","title":"getJsonString - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getJsonString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ abstract fun getJsonString(feature: Feature): String
Returns the value of a JSON string value of the dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json/","title":"getJson - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, clazz: Class<T>): T
Returns the value of a JSON dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-string/","title":"getString - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature): String
Returns the value of a string dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a double dynamic config tracker which will be invoked whenever the double dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-int/","title":"trackInt - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-json/","title":"trackJson - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a json dynamic config tracker which will be invoked whenever the json dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-string/","title":"trackString - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a string dynamic config tracker which will be invoked whenever the string dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/","title":"EnumFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/EnumFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/#enumfeatureflag","title":"EnumFeatureFlag","text":"[jvm]\\ interface EnumFeatureFlag<T : Enum<T>> : FeatureFlag<T>
A Enumeration feature flag, when evaluated returns T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against. returnType [jvm]abstract val returnType: Class<T>"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/return-type/","title":"returnType - Misk","text":"//wisp-feature/wisp.feature/EnumFeatureFlag/returnType
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/return-type/#returntype","title":"returnType","text":"[jvm]\\ abstract val returnType: Class<T>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/","title":"Feature - Misk","text":"//wisp-feature/wisp.feature/Feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#feature","title":"Feature","text":"[jvm]\\ open class Feature(val name: String)
Typed feature string.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#constructors","title":"Constructors","text":"Feature [jvm]constructor(name: String)"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#functions","title":"Functions","text":"Name Summary equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/-feature/","title":"Feature - Misk","text":"//wisp-feature/wisp.feature/Feature/Feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/-feature/#feature","title":"Feature","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/equals/","title":"equals - Misk","text":"//wisp-feature/wisp.feature/Feature/equals
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/hash-code/","title":"hashCode - Misk","text":"//wisp-feature/wisp.feature/Feature/hashCode
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/name/","title":"name - Misk","text":"//wisp-feature/wisp.feature/Feature/name
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/to-string/","title":"toString - Misk","text":"//wisp-feature/wisp.feature/Feature/toString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/","title":"FeatureFlag - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/#featureflag","title":"FeatureFlag","text":"sealed interface FeatureFlag<T : Any>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/#inheritors","title":"Inheritors","text":"StringFeatureFlag BooleanFeatureFlag IntFeatureFlag DoubleFeatureFlag EnumFeatureFlag JsonFeatureFlag"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/attributes/","title":"attributes - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag/attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/attributes/#attributes","title":"attributes","text":"[jvm]\\ open val attributes: Attributes
The attributes of this feature flag, provided during flag evaluation
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/feature/","title":"feature - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag/feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/feature/#feature","title":"feature","text":"[jvm]\\ abstract val feature: Feature
Feature name of the feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/key/","title":"key - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag/key
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/key/#key","title":"key","text":"[jvm]\\ abstract val key: String
Unique primary key for the entity the flag should be evaluated against.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/","title":"FeatureFlagValidation - Misk","text":"//wisp-feature/wisp.feature/FeatureFlagValidation
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/#featureflagvalidation","title":"FeatureFlagValidation","text":"[jvm]\\ object FeatureFlagValidation
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/#functions","title":"Functions","text":"Name Summary checkValidKey [jvm]fun checkValidKey(feature: Feature, key: String)Validates the feature flags\u2019s hashing \"key\". Most implementation technically support arbitrary strings, but we still prefer to restrict valid input to prevent accidentally passing in the wrong value or potentially sensitive information."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/check-valid-key/","title":"checkValidKey - Misk","text":"//wisp-feature/wisp.feature/FeatureFlagValidation/checkValidKey
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/check-valid-key/#checkvalidkey","title":"checkValidKey","text":"[jvm]\\ fun checkValidKey(feature: Feature, key: String)
Validates the feature flags\u2019s hashing \"key\". Most implementation technically support arbitrary strings, but we still prefer to restrict valid input to prevent accidentally passing in the wrong value or potentially sensitive information.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flags/","title":"FeatureFlags - Misk","text":"//wisp-feature/wisp.feature/FeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flags/#featureflags","title":"FeatureFlags","text":"[jvm]\\ interface FeatureFlags : StrongFeatureFlags, LegacyFeatureFlags
Interface for evaluating feature flags.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(flag: BooleanFeatureFlag): BooleanCalculates the value of a boolean feature flag[jvm]abstract fun get(flag: DoubleFeatureFlag): DoubleCalculates the value of a double feature flag[jvm]abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): TCalculates the value of an enum feature flag[jvm]abstract fun get(flag: IntFeatureFlag): IntCalculates the value of an int feature flag[jvm]abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): TCalculates the value of a json feature flag[jvm]abstract fun get(flag: StringFeatureFlag): StringCalculates the value of a string feature flag getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Boolean[jvm]abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): BooleanCalculates the value of a boolean feature flag for the given key and attributes. getDouble [jvm]open fun getDouble(feature: Feature, key: String): Double[jvm]abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): DoubleCalculates the value of a double feature flag for the given key and attributes. getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of an enumerated feature flag for the given key and attributes. getEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getInt [jvm]open fun getInt(feature: Feature, key: String): Int[jvm]abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): IntCalculates the value of an integer feature flag for the given key and attributes. getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of a JSON feature flag for the given key and attributes. getJson [jvm]inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): String[jvm]abstract fun getJsonString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a JSON feature flag for the given key and attributes and returns it as a json string. getString [jvm]open fun getString(feature: Feature, key: String): String[jvm]abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a string feature flag for the given key and attributes. trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference[jvm]abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a tracker for the value of a boolean feature flag for the given key and attributes. trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference[jvm]abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a tracker for the value of a double feature flag for the given key and attributes. trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of an enumerated feature flag for the given key and attributes. trackEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference[jvm]abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a tracker for the value of an integer feature flag for the given key and attributes. trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of a JSON feature flag for the given key and attributes. trackJson [jvm]inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference[jvm]abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a tracker for the value of a string feature flag for the given key and attributes."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-int-feature-flag/","title":"IntFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/IntFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-int-feature-flag/#intfeatureflag","title":"IntFeatureFlag","text":"[jvm]\\ interface IntFeatureFlag : FeatureFlag<Int>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-int-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-json-feature-flag/","title":"JsonFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/JsonFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-json-feature-flag/#jsonfeatureflag","title":"JsonFeatureFlag","text":"[jvm]\\ interface JsonFeatureFlag<T : Any> : FeatureFlag<T>
A JSON feature flag, when evaluated returns T.
It is expected that a Moshi type adapter is registered for T.
Example definition:
// Step 1: Define the object we expect to get from the JSON flag\ndata class PaymentConfiguration(\n val fraudulent: Boolean,\n val vipTreatment: Boolean,\n val specialDescription: String\n)\n\n// Step 2: Define the feature flag\ndata class PaymentConfigurationFeature(\n // Put the `key` and `attributes` here\n val customerId: String,\n val extraAttribute: String\n) : JsonFeatureFlag<PaymentConfiguration> {\n override val feature = Feature(\"payment-configuration-feature\")\n override val key = customerId\n override val attributes = Attributes()\n .with(\"extraAttribute\", extraAttribute)\n override val returnType = PaymentConfiguration::class\n}\n//wisp-feature/wisp.feature/JsonFeatureFlag/returnType
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-json-feature-flag/return-type/#returntype","title":"returnType","text":"[jvm]\\ abstract val returnType: Class<out T>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/","title":"LegacyFeatureFlags - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/#legacyfeatureflags","title":"LegacyFeatureFlags","text":"interface LegacyFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/#inheritors","title":"Inheritors","text":"FeatureFlags"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Boolean[jvm]abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): BooleanCalculates the value of a boolean feature flag for the given key and attributes. getDouble [jvm]open fun getDouble(feature: Feature, key: String): Double[jvm]abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): DoubleCalculates the value of a double feature flag for the given key and attributes. getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of an enumerated feature flag for the given key and attributes. getInt [jvm]open fun getInt(feature: Feature, key: String): Int[jvm]abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): IntCalculates the value of an integer feature flag for the given key and attributes. getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of a JSON feature flag for the given key and attributes. getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): String[jvm]abstract fun getJsonString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a JSON feature flag for the given key and attributes and returns it as a json string. getString [jvm]open fun getString(feature: Feature, key: String): String[jvm]abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a string feature flag for the given key and attributes. trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference[jvm]abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a tracker for the value of a boolean feature flag for the given key and attributes. trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference[jvm]abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a tracker for the value of a double feature flag for the given key and attributes. trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of an enumerated feature flag for the given key and attributes. trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference[jvm]abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a tracker for the value of an integer feature flag for the given key and attributes. trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of a JSON feature flag for the given key and attributes. trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference[jvm]abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a tracker for the value of a string feature flag for the given key and attributes."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): Boolean
Calculates the value of a boolean feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-boolean/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getBoolean(feature: Feature, key: String): Boolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-double/","title":"getDouble - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): Double
Calculates the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-double/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getDouble(feature: Feature, key: String): Double
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/","title":"getEnum - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-int/","title":"getInt - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): Int
Calculates the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-int/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getInt(feature: Feature, key: String): Int
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json-string/","title":"getJsonString - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getJsonString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ abstract fun getJsonString(feature: Feature, key: String, attributes: Attributes = Attributes()): String
Calculates the value of a JSON feature flag for the given key and attributes and returns it as a json string.
is registered with the impl.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json-string/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getJsonString(feature: Feature, key: String): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/","title":"getJson - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-string/","title":"getString - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): String
Calculates the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-string/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getString(feature: Feature, key: String): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a tracker for the value of a boolean feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-boolean/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-double/","title":"trackDouble - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a tracker for the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-double/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#return","title":"Return","text":"a reference to the registered tracker allowing to un-register it
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation. tracker a tracker to be registered for processing of changed values"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-int/","title":"trackInt - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a tracker for the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-int/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/","title":"trackJson - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-string/","title":"trackString - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a tracker for the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-string/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-string-feature-flag/","title":"StringFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/StringFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-string-feature-flag/#stringfeatureflag","title":"StringFeatureFlag","text":"[jvm]\\ interface StringFeatureFlag : FeatureFlag<String>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-string-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/","title":"StrongFeatureFlags - Misk","text":"//wisp-feature/wisp.feature/StrongFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/#strongfeatureflags","title":"StrongFeatureFlags","text":"interface StrongFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/#inheritors","title":"Inheritors","text":"FeatureFlags"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(flag: BooleanFeatureFlag): BooleanCalculates the value of a boolean feature flag[jvm]abstract fun get(flag: DoubleFeatureFlag): DoubleCalculates the value of a double feature flag[jvm]abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): TCalculates the value of an enum feature flag[jvm]abstract fun get(flag: IntFeatureFlag): IntCalculates the value of an int feature flag[jvm]abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): TCalculates the value of a json feature flag[jvm]abstract fun get(flag: StringFeatureFlag): StringCalculates the value of a string feature flag"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/","title":"get - Misk","text":"//wisp-feature/wisp.feature/StrongFeatureFlags/get
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#get","title":"get","text":"[jvm]\\ abstract fun get(flag: BooleanFeatureFlag): Boolean
Calculates the value of a boolean feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: StringFeatureFlag): String
Calculates the value of a string feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_1","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_1","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: IntFeatureFlag): Int
Calculates the value of an int feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_2","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_2","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: DoubleFeatureFlag): Double
Calculates the value of a double feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_3","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_3","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
Calculates the value of an enum feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_4","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_4","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): T
Calculates the value of a json feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_5","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_5","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/","title":"TrackerReference - Misk","text":"//wisp-feature/wisp.feature/TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/#trackerreference","title":"TrackerReference","text":"[jvm]\\ interface TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/#functions","title":"Functions","text":"Name Summary unregister [jvm]abstract fun unregister()"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/unregister/","title":"unregister - Misk","text":"//wisp-feature/wisp.feature/TrackerReference/unregister
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/unregister/#unregister","title":"unregister","text":"[jvm]\\ abstract fun unregister()
"},{"location":"0.x/wisp-feature-testing/","title":"wisp-feature-testing - Misk","text":"//wisp-feature-testing
"},{"location":"0.x/wisp-feature-testing/#wisp-feature-testing","title":"wisp-feature-testing","text":""},{"location":"0.x/wisp-feature-testing/#packages","title":"Packages","text":"Name wisp.feature.testing"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/","title":"Package-level declarations - Misk","text":"//wisp-feature-testing/wisp.feature.testing
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/#types","title":"Types","text":"Name Summary FakeFeatureFlags [jvm]open class FakeFeatureFlags : FeatureFlags, LegacyFeatureFlags, DynamicConfig, StrongFeatureFlags, Configurable<FakeFeatureFlagsConfig> In-memory test implementation of FeatureFlags that allows flags to be overridden. FakeFeatureFlagsConfig [jvm]data class FakeFeatureFlagsConfig@JvmOverloadsconstructor(val featuresConfig: List<FeaturesConfig> = emptyList()) : Config FakeLegacyFeatureFlags [jvm]class FakeLegacyFeatureFlags : LegacyFeatureFlags, DynamicConfigIn-memory test implementation of FeatureFlags that allows flags to be overridden. FakeStrongFeatureFlags [jvm]class FakeStrongFeatureFlags : StrongFeatureFlagsIn-memory test implementation of FeatureFlags that allows for overriding strong feature flags FeaturesConfig [jvm]data class FeaturesConfig@JvmOverloadsconstructor(val featureName: String, val key: String? = null, val attributes: Attributes = Attributes(), val value: String, val type: String = \"String\")"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/","title":"FakeFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#fakefeatureflags","title":"FakeFeatureFlags","text":"[jvm]\\ open class FakeFeatureFlags : FeatureFlags, LegacyFeatureFlags, DynamicConfig, StrongFeatureFlags, Configurable<FakeFeatureFlagsConfig>
In-memory test implementation of FeatureFlags that allows flags to be overridden.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#constructors","title":"Constructors","text":"FakeFeatureFlags [jvm]constructor(moshi: Moshi = defaultKotlinMoshi)Preferred constructor for Wisp"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#properties","title":"Properties","text":"Name Summary legacyFeatureFlags [jvm]val legacyFeatureFlags: FakeLegacyFeatureFlags strongFeatureFlags [jvm]val strongFeatureFlags: FakeStrongFeatureFlags"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#functions","title":"Functions","text":"Name Summary configure [jvm]open override fun configure(config: FakeFeatureFlagsConfig)Configures the feature flags values from supplied config. get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String getBoolean [jvm]open override fun getBoolean(feature: Feature): Booleanopen override fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getConfigClass [jvm]open override fun getConfigClass(): KClass<FakeFeatureFlagsConfig> getDouble [jvm]open override fun getDouble(feature: Feature): Doubleopen override fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open override fun getInt(feature: Feature): Intopen override fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open override fun <T> getJson(feature: Feature, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getJsonString [jvm]open override fun getJsonString(feature: Feature): Stringopen override fun getJsonString(feature: Feature, key: String): Stringopen override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String getString [jvm]open override fun getString(feature: Feature): Stringopen override fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String override [jvm]@JvmOverloadsinline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlagsfun <T> override(feature: Feature, value: T)fun override(feature: Feature, value: Boolean)fun override(feature: Feature, value: Double)fun override(feature: Feature, value: Enum<*>)fun override(feature: Feature, value: Int)fun override(feature: Feature, value: String)fun <T> override(feature: Feature, value: T, clazz: Class<T>) overrideAny [jvm]@JvmOverloadsfun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags overrideJson [jvm]inline fun <T> overrideJson(feature: Feature, value: T) overrideJsonString [jvm]fun overrideJsonString(feature: Feature, json: String) overrideKey [jvm]fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)@JvmOverloadsfun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes) overrideKeyJson [jvm]@JvmOverloadsinline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes) overrideKeyJsonString [jvm]@JvmOverloadsfun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes) reset [jvm]fun reset() trackBoolean [jvm]open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-fake-feature-flags/","title":"FakeFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/FakeFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-fake-feature-flags/#fakefeatureflags","title":"FakeFeatureFlags","text":"[jvm]\\ constructor(moshi: Moshi = defaultKotlinMoshi)
Preferred constructor for Wisp
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/configure/","title":"configure - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/configure
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/configure/#configure","title":"configure","text":"[jvm]\\ open override fun configure(config: FakeFeatureFlagsConfig)
Configures the feature flags values from supplied config.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/get-config-class/","title":"getConfigClass - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/getConfigClass
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/get-config-class/#getconfigclass","title":"getConfigClass","text":"[jvm]\\ open override fun getConfigClass(): KClass<FakeFeatureFlagsConfig>
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/legacy-feature-flags/","title":"legacyFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/legacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/legacy-feature-flags/#legacyfeatureflags","title":"legacyFeatureFlags","text":"[jvm]\\ val legacyFeatureFlags: FakeLegacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-any/","title":"overrideAny - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideAny
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-any/#overrideany","title":"overrideAny","text":"[jvm]\\
@JvmOverloads
fun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json-string/","title":"overrideJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json-string/#overridejsonstring","title":"overrideJsonString","text":"[jvm]\\ fun overrideJsonString(feature: Feature, json: String)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json/","title":"overrideJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json/#overridejson","title":"overrideJson","text":"[jvm]\\ inline fun <T> overrideJson(feature: Feature, value: T)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json-string/","title":"overrideKeyJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideKeyJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json-string/#overridekeyjsonstring","title":"overrideKeyJsonString","text":"[jvm]\\
@JvmOverloads
fun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json/","title":"overrideKeyJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideKeyJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json/#overridekeyjson","title":"overrideKeyJson","text":"[jvm]\\
@JvmOverloads
inline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key/","title":"overrideKey - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideKey
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key/#overridekey","title":"overrideKey","text":"[jvm]\\
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)
fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)
@JvmOverloads
fun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override/","title":"override - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/override
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override/#override","title":"override","text":"[jvm]\\
@JvmOverloads
inline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
fun override(feature: Feature, value: Boolean)
fun override(feature: Feature, value: Double)
fun override(feature: Feature, value: Int)
fun override(feature: Feature, value: String)
fun override(feature: Feature, value: Enum<*>)
fun <T> override(feature: Feature, value: T)
fun <T> override(feature: Feature, value: T, clazz: Class<T>)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/reset/","title":"reset - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/reset
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/reset/#reset","title":"reset","text":"[jvm]\\ fun reset()
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/strong-feature-flags/","title":"strongFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/strongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/strong-feature-flags/#strongfeatureflags","title":"strongFeatureFlags","text":"[jvm]\\ val strongFeatureFlags: FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/","title":"Companion - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/#properties","title":"Properties","text":"Name Summary defaultAttributes [jvm]val defaultAttributes: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/-k-e-y/","title":"KEY - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/Companion/KEY
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/default-attributes/","title":"defaultAttributes - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/Companion/defaultAttributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/default-attributes/#defaultattributes","title":"defaultAttributes","text":"[jvm]\\ val defaultAttributes: Attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/","title":"FakeFeatureFlagsConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlagsConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/#fakefeatureflagsconfig","title":"FakeFeatureFlagsConfig","text":"[jvm]\\ data class FakeFeatureFlagsConfig@JvmOverloadsconstructor(val featuresConfig: List<FeaturesConfig> = emptyList()) : Config
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/#constructors","title":"Constructors","text":"FakeFeatureFlagsConfig [jvm]@JvmOverloadsconstructor(featuresConfig: List<FeaturesConfig> = emptyList())"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/#properties","title":"Properties","text":"Name Summary featuresConfig [jvm]val featuresConfig: List<FeaturesConfig>"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/-fake-feature-flags-config/","title":"FakeFeatureFlagsConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlagsConfig/FakeFeatureFlagsConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/-fake-feature-flags-config/#fakefeatureflagsconfig","title":"FakeFeatureFlagsConfig","text":"[jvm]\\
@JvmOverloads
constructor(featuresConfig: List<FeaturesConfig> = emptyList())
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/features-config/","title":"featuresConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlagsConfig/featuresConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/features-config/#featuresconfig","title":"featuresConfig","text":"[jvm]\\ val featuresConfig: List<FeaturesConfig>
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/","title":"FakeLegacyFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#fakelegacyfeatureflags","title":"FakeLegacyFeatureFlags","text":"[jvm]\\ class FakeLegacyFeatureFlags : LegacyFeatureFlags, DynamicConfig
In-memory test implementation of FeatureFlags that allows flags to be overridden.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#constructors","title":"Constructors","text":"FakeLegacyFeatureFlags [jvm]constructor(moshi: Moshi = defaultKotlinMoshi)Preferred constructor for Wisp"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: () -> Moshi"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getDouble [jvm]open fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): Stringopen override fun getJsonString(feature: Feature): Stringopen override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String getString [jvm]open fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String override [jvm]fun <T> override(feature: Feature, value: T)fun override(feature: Feature, value: Boolean)fun override(feature: Feature, value: Double)fun override(feature: Feature, value: Enum<*>)fun override(feature: Feature, value: Int)fun override(feature: Feature, value: String)fun <T> override(feature: Feature, value: T, clazz: Class<T>) overrideJson [jvm]inline fun <T> overrideJson(feature: Feature, value: T) overrideJsonString [jvm]fun overrideJsonString(feature: Feature, json: String) overrideKey [jvm]fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)@JvmOverloadsfun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)@JvmOverloadsfun <T, V> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes, mapper: (T) -> V?) overrideKeyJson [jvm]@JvmOverloadsinline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes) overrideKeyJsonString [jvm]@JvmOverloadsfun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes) reset [jvm]fun reset() trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-fake-legacy-feature-flags/","title":"FakeLegacyFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/FakeLegacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-fake-legacy-feature-flags/#fakelegacyfeatureflags","title":"FakeLegacyFeatureFlags","text":"[jvm]\\ constructor(moshi: Moshi = defaultKotlinMoshi)
Preferred constructor for Wisp
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getBoolean
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean
open override fun getBoolean(feature: Feature): Boolean
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-double/","title":"getDouble - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getDouble
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double
open override fun getDouble(feature: Feature): Double
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-enum/","title":"getEnum - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getEnum
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-int/","title":"getInt - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getInt
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature, key: String, attributes: Attributes): Int
open override fun getInt(feature: Feature): Int
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json-string/","title":"getJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ open override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String
open override fun getJsonString(feature: Feature): String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json/","title":"getJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
open override fun <T> getJson(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-string/","title":"getString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature, key: String, attributes: Attributes): String
open override fun getString(feature: Feature): String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/moshi/","title":"moshi - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/moshi
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: () -> Moshi
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json-string/","title":"overrideJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json-string/#overridejsonstring","title":"overrideJsonString","text":"[jvm]\\ fun overrideJsonString(feature: Feature, json: String)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json/","title":"overrideJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json/#overridejson","title":"overrideJson","text":"[jvm]\\ inline fun <T> overrideJson(feature: Feature, value: T)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json-string/","title":"overrideKeyJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideKeyJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json-string/#overridekeyjsonstring","title":"overrideKeyJsonString","text":"[jvm]\\
@JvmOverloads
fun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json/","title":"overrideKeyJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideKeyJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json/#overridekeyjson","title":"overrideKeyJson","text":"[jvm]\\
@JvmOverloads
inline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key/","title":"overrideKey - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideKey
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key/#overridekey","title":"overrideKey","text":"[jvm]\\
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)
fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)
@JvmOverloads
fun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun <T, V> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes, mapper: (T) -> V?)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override/","title":"override - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/override
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override/#override","title":"override","text":"[jvm]\\ fun override(feature: Feature, value: Boolean)
fun override(feature: Feature, value: Double)
fun override(feature: Feature, value: Int)
fun override(feature: Feature, value: String)
fun override(feature: Feature, value: Enum<*>)
fun <T> override(feature: Feature, value: T)
fun <T> override(feature: Feature, value: T, clazz: Class<T>)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/reset/","title":"reset - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/reset
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/reset/#reset","title":"reset","text":"[jvm]\\ fun reset()
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackBoolean
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-double/","title":"trackDouble - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackDouble
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference
open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackEnum
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-int/","title":"trackInt - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackInt
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference
open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-json/","title":"trackJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-string/","title":"trackString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference
open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/","title":"Companion - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/#properties","title":"Properties","text":"Name Summary defaultAttributes [jvm]val defaultAttributes: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/-k-e-y/","title":"KEY - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/Companion/KEY
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/default-attributes/","title":"defaultAttributes - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/Companion/defaultAttributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/default-attributes/#defaultattributes","title":"defaultAttributes","text":"[jvm]\\ val defaultAttributes: Attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/","title":"FakeStrongFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/#fakestrongfeatureflags","title":"FakeStrongFeatureFlags","text":"[jvm]\\ class FakeStrongFeatureFlags : StrongFeatureFlags
In-memory test implementation of FeatureFlags that allows for overriding strong feature flags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/#constructors","title":"Constructors","text":"FakeStrongFeatureFlags [jvm]constructor()"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String override [jvm]@JvmOverloadsinline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags overrideAny [jvm]@JvmOverloadsfun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlagsGeneric flag override function. reset [jvm]fun reset(): FakeStrongFeatureFlags"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/-fake-strong-feature-flags/","title":"FakeStrongFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/-fake-strong-feature-flags/#fakestrongfeatureflags","title":"FakeStrongFeatureFlags","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/get/","title":"get - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/get
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/get/#get","title":"get","text":"[jvm]\\ open override fun get(flag: BooleanFeatureFlag): Boolean
open override fun get(flag: StringFeatureFlag): String
open override fun get(flag: IntFeatureFlag): Int
open override fun get(flag: DoubleFeatureFlag): Double
open override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
open override fun <T : Any> get(flag: JsonFeatureFlag<T>): T
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override-any/","title":"overrideAny - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/overrideAny
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override-any/#overrideany","title":"overrideAny","text":"[jvm]\\
@JvmOverloads
fun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
Generic flag override function.
Prefer override instead for a more convenient interface.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override/","title":"override - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/override
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override/#override","title":"override","text":"[jvm]\\
@JvmOverloads
inline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/reset/","title":"reset - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/reset
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/reset/#reset","title":"reset","text":"[jvm]\\ fun reset(): FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/","title":"FeaturesConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/#featuresconfig","title":"FeaturesConfig","text":"[jvm]\\ data class FeaturesConfig@JvmOverloadsconstructor(val featureName: String, val key: String? = null, val attributes: Attributes = Attributes(), val value: String, val type: String = \"String\")
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/#constructors","title":"Constructors","text":"FeaturesConfig [jvm]@JvmOverloadsconstructor(featureName: String, key: String? = null, attributes: Attributes = Attributes(), value: String, type: String = \"String\")"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/#properties","title":"Properties","text":"Name Summary attributes [jvm]val attributes: Attributes featureName [jvm]val featureName: String key [jvm]val key: String? = null type [jvm]val type: String value [jvm]val value: String"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/-features-config/","title":"FeaturesConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/FeaturesConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/-features-config/#featuresconfig","title":"FeaturesConfig","text":"[jvm]\\
@JvmOverloads
constructor(featureName: String, key: String? = null, attributes: Attributes = Attributes(), value: String, type: String = \"String\")
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/attributes/","title":"attributes - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/attributes/#attributes","title":"attributes","text":"[jvm]\\ val attributes: Attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/feature-name/","title":"featureName - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/featureName
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/feature-name/#featurename","title":"featureName","text":"[jvm]\\ val featureName: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/key/","title":"key - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/key
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/key/#key","title":"key","text":"[jvm]\\ val key: String? = null
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/type/","title":"type - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/type
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/value/","title":"value - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/value
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/wisp-launchdarkly/","title":"wisp-launchdarkly - Misk","text":"//wisp-launchdarkly
"},{"location":"0.x/wisp-launchdarkly/#wisp-launchdarkly","title":"wisp-launchdarkly","text":""},{"location":"0.x/wisp-launchdarkly/#packages","title":"Packages","text":"Name wisp.launchdarkly"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/","title":"Package-level declarations - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/#types","title":"Types","text":"Name Summary LaunchDarklyClient [jvm]object LaunchDarklyClient LaunchDarklyClientMetrics [jvm]class LaunchDarklyClientMetrics(meterRegistry: MeterRegistry) LaunchDarklyConfig [jvm]data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val ssl: HttpClientSSLConfig? = null, val offline: Boolean = false) : Config LaunchDarklyDynamicConfig [jvm]class LaunchDarklyDynamicConfig(featureFlags: FeatureFlags) : DynamicConfig LaunchDarklyFeatureFlags [jvm]class LaunchDarklyFeatureFlags@JvmOverloadsconstructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry) : FeatureFlagsImplementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation."},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/","title":"LaunchDarklyClient - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClient
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/#launchdarklyclient","title":"LaunchDarklyClient","text":"[jvm]\\ object LaunchDarklyClient
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/#functions","title":"Functions","text":"Name Summary createLaunchDarklyClient [jvm]fun createLaunchDarklyClient(config: LaunchDarklyConfig, sslLoader: SslLoader, sslContextFactory: SslContextFactory, resourceLoader: ResourceLoader): LDClientInterfaceCreates the LaunchDarkly client interface with the supplied config"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/create-launch-darkly-client/","title":"createLaunchDarklyClient - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClient/createLaunchDarklyClient
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/create-launch-darkly-client/#createlaunchdarklyclient","title":"createLaunchDarklyClient","text":"[jvm]\\ fun createLaunchDarklyClient(config: LaunchDarklyConfig, sslLoader: SslLoader, sslContextFactory: SslContextFactory, resourceLoader: ResourceLoader): LDClientInterface
Creates the LaunchDarkly client interface with the supplied config
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/","title":"LaunchDarklyClientMetrics - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#launchdarklyclientmetrics","title":"LaunchDarklyClientMetrics","text":"[jvm]\\ class LaunchDarklyClientMetrics(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#constructors","title":"Constructors","text":"LaunchDarklyClientMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#functions","title":"Functions","text":"Name Summary onInitFailure [jvm]fun onInitFailure() onInitSuccess [jvm]fun onInitSuccess(duration: Long)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-launch-darkly-client-metrics/","title":"LaunchDarklyClientMetrics - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/LaunchDarklyClientMetrics
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-launch-darkly-client-metrics/#launchdarklyclientmetrics","title":"LaunchDarklyClientMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-failure/","title":"onInitFailure - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/onInitFailure
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-failure/#oninitfailure","title":"onInitFailure","text":"[jvm]\\ fun onInitFailure()
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-success/","title":"onInitSuccess - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/onInitSuccess
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-success/#oninitsuccess","title":"onInitSuccess","text":"[jvm]\\ fun onInitSuccess(duration: Long)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/","title":"Companion - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/#properties","title":"Properties","text":"Name Summary FAILED_COUNTER_NAME [jvm]const val FAILED_COUNTER_NAME: String INITIALIZATION_DURATION_NAME [jvm]const val INITIALIZATION_DURATION_NAME: String SUCCESS_COUNTER_NAME [jvm]const val SUCCESS_COUNTER_NAME: String"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/","title":"FAILED_COUNTER_NAME - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion/FAILED_COUNTER_NAME
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/#failed_counter_name","title":"FAILED_COUNTER_NAME","text":"[jvm]\\ const val FAILED_COUNTER_NAME: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-i-n-i-t-i-a-l-i-z-a-t-i-o-n_-d-u-r-a-t-i-o-n_-n-a-m-e/","title":"INITIALIZATION_DURATION_NAME - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion/INITIALIZATION_DURATION_NAME
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-i-n-i-t-i-a-l-i-z-a-t-i-o-n_-d-u-r-a-t-i-o-n_-n-a-m-e/#initialization_duration_name","title":"INITIALIZATION_DURATION_NAME","text":"[jvm]\\ const val INITIALIZATION_DURATION_NAME: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/","title":"SUCCESS_COUNTER_NAME - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion/SUCCESS_COUNTER_NAME
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/#success_counter_name","title":"SUCCESS_COUNTER_NAME","text":"[jvm]\\ const val SUCCESS_COUNTER_NAME: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\ data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val ssl: HttpClientSSLConfig? = null, val offline: Boolean = false) : Config
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/#constructors","title":"Constructors","text":"LaunchDarklyConfig [jvm]@JvmOverloadsconstructor(sdk_key: String, base_uri: String, ssl: HttpClientSSLConfig? = null, offline: Boolean = false)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/#properties","title":"Properties","text":"Name Summary base_uri [jvm]val base_uri: String offline [jvm]val offline: Boolean = false sdk_key [jvm]val sdk_key: String ssl [jvm]val ssl: HttpClientSSLConfig? = null"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/LaunchDarklyConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\
@JvmOverloads
constructor(sdk_key: String, base_uri: String, ssl: HttpClientSSLConfig? = null, offline: Boolean = false)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/base_uri/","title":"base_uri - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/base_uri
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/base_uri/#base_uri","title":"base_uri","text":"[jvm]\\ val base_uri: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/offline/","title":"offline - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/offline
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/offline/#offline","title":"offline","text":"[jvm]\\ val offline: Boolean = false
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/sdk_key/","title":"sdk_key - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/sdk_key
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/sdk_key/#sdk_key","title":"sdk_key","text":"[jvm]\\ val sdk_key: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/ssl/","title":"ssl - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/ssl
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\ class LaunchDarklyDynamicConfig(featureFlags: FeatureFlags) : DynamicConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#constructors","title":"Constructors","text":"LaunchDarklyDynamicConfig [jvm]constructor(featureFlags: FeatureFlags)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open override fun getBoolean(feature: Feature): Boolean getDouble [jvm]open override fun getDouble(feature: Feature): Double getEnum [jvm]open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T getInt [jvm]open override fun getInt(feature: Feature): Int getJson [jvm]open override fun <T> getJson(feature: Feature, clazz: Class<T>): T getJsonString [jvm]open override fun getJsonString(feature: Feature): String getString [jvm]open override fun getString(feature: Feature): String trackBoolean [jvm]open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/LaunchDarklyDynamicConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\ constructor(featureFlags: FeatureFlags)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature): Boolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-double/","title":"getDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature): Double
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-int/","title":"getInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature): Int
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json-string/","title":"getJsonString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getJsonString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ open override fun getJsonString(feature: Feature): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json/","title":"getJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-string/","title":"getString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-int/","title":"trackInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-json/","title":"trackJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-string/","title":"trackString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/","title":"Companion - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/#properties","title":"Properties","text":"Name Summary ATTRIBUTES [jvm]val ATTRIBUTES: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/","title":"ATTRIBUTES - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/Companion/ATTRIBUTES
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/#attributes","title":"ATTRIBUTES","text":"[jvm]\\ val ATTRIBUTES: Attributes
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/","title":"KEY - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/Companion/KEY
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\ class LaunchDarklyFeatureFlags@JvmOverloadsconstructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry) : FeatureFlags
Implementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation.
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#constructors","title":"Constructors","text":"LaunchDarklyFeatureFlags [jvm]@JvmOverloadsconstructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getDouble [jvm]open fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): Stringopen override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String getString [jvm]open fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String shutDown [jvm]fun shutDown() startUp [jvm]fun startUp(): LaunchDarklyFeatureFlags trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/LaunchDarklyFeatureFlags
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\
@JvmOverloads
constructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-double/","title":"getDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-enum/","title":"getEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-int/","title":"getInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature, key: String, attributes: Attributes): Int
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json-string/","title":"getJsonString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getJsonString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ open override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json/","title":"getJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-string/","title":"getString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature, key: String, attributes: Attributes): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get/","title":"get - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/get
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get/#get","title":"get","text":"[jvm]\\ open override fun get(flag: BooleanFeatureFlag): Boolean
open override fun get(flag: StringFeatureFlag): String
open override fun get(flag: IntFeatureFlag): Int
open override fun get(flag: DoubleFeatureFlag): Double
open override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
open override fun <T : Any> get(flag: JsonFeatureFlag<T>): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/shut-down/","title":"shutDown - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/shutDown
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/start-up/","title":"startUp - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/startUp
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/start-up/#startup","title":"startUp","text":"[jvm]\\ fun startUp(): LaunchDarklyFeatureFlags
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-double/","title":"trackDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-int/","title":"trackInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-json/","title":"trackJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-string/","title":"trackString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/","title":"Companion - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/logger/","title":"logger - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/Companion/logger
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/wisp-lease/","title":"wisp-lease - Misk","text":"//wisp-lease
"},{"location":"0.x/wisp-lease/#wisp-lease","title":"wisp-lease","text":""},{"location":"0.x/wisp-lease/#packages","title":"Packages","text":"Name wisp.lease wisp.lease.pool"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/","title":"Package-level declarations - Misk","text":"//wisp-lease/wisp.lease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/#types","title":"Types","text":"Name Summary AutoCloseableLease [jvm]class AutoCloseableLease(lease: Lease) : Lease, AutoCloseableConverts a lease into an AutoCloseable resource. Lease [jvm]interface LeaseA Lease is a cluster-wide time-based lock on a given resource. Leases are retrieved via LeaseManager.requestLease. LeaseManager [jvm]interface LeaseManager"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/#functions","title":"Functions","text":"Name Summary acquireOrNull [jvm]fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?Attempts to acquire an AutoCloseableLease."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/acquire-or-null/","title":"acquireOrNull - Misk","text":"//wisp-lease/wisp.lease/acquireOrNull
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/acquire-or-null/#acquireornull","title":"acquireOrNull","text":"[jvm]\\ fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?
Attempts to acquire an AutoCloseableLease.
Use like
leaseManager.acquireOrNull(\"some-lease\")?.use { lease ->\n // Do something with the lease.\n}\n//wisp-lease/wisp.lease/AutoCloseableLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#autocloseablelease","title":"AutoCloseableLease","text":"[jvm]\\ class AutoCloseableLease(lease: Lease) : Lease, AutoCloseable
Converts a lease into an AutoCloseable resource.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#constructors","title":"Constructors","text":"AutoCloseableLease [jvm]constructor(lease: Lease)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): BooleanAttempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified. addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener)Registers a listener that is called on lease state changes. checkHeld [jvm]open override fun checkHeld(): Boolean close [jvm]open override fun close() release [jvm]open override fun release(): BooleanRelease the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/-auto-closeable-lease/","title":"AutoCloseableLease - Misk","text":"//wisp-lease/wisp.lease/AutoCloseableLease/AutoCloseableLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/-auto-closeable-lease/#autocloseablelease","title":"AutoCloseableLease","text":"[jvm]\\ constructor(lease: Lease)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/close/","title":"close - Misk","text":"//wisp-lease/wisp.lease/AutoCloseableLease/close
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/close/#close","title":"close","text":"[jvm]\\ open override fun close()
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/","title":"Lease - Misk","text":"//wisp-lease/wisp.lease/Lease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#lease","title":"Lease","text":"interface Lease
A Lease is a cluster-wide time-based lock on a given resource. Leases are retrieved via LeaseManager.requestLease.
It should be assumed that calls to checkHeld, acquire and release could invoke remote calls, so consider usage carefully.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#inheritors","title":"Inheritors","text":"AutoCloseableLease PoolLease"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#types","title":"Types","text":"Name Summary StateChangeListener [jvm]interface StateChangeListener"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#properties","title":"Properties","text":"Name Summary name [jvm]abstract val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]abstract fun acquire(): BooleanAttempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified. addListener [jvm]abstract fun addListener(listener: Lease.StateChangeListener)Registers a listener that is called on lease state changes. checkHeld [jvm]abstract fun checkHeld(): Boolean release [jvm]abstract fun release(): BooleanRelease the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/acquire/","title":"acquire - Misk","text":"//wisp-lease/wisp.lease/Lease/acquire
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ abstract fun acquire(): Boolean
Attempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/acquire/#return","title":"Return","text":"true if this process acquires the lease.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/add-listener/","title":"addListener - Misk","text":"//wisp-lease/wisp.lease/Lease/addListener
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/add-listener/#addlistener","title":"addListener","text":"[jvm]\\ abstract fun addListener(listener: Lease.StateChangeListener)
Registers a listener that is called on lease state changes.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/check-held/","title":"checkHeld - Misk","text":"//wisp-lease/wisp.lease/Lease/checkHeld
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ abstract fun checkHeld(): Boolean
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/check-held/#return","title":"Return","text":"true if the lease is owned by this process instance.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/name/","title":"name - Misk","text":"//wisp-lease/wisp.lease/Lease/name
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/name/#name","title":"name","text":"[jvm]\\ abstract val name: String
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/release/","title":"release - Misk","text":"//wisp-lease/wisp.lease/Lease/release
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/release/#release","title":"release","text":"[jvm]\\ abstract fun release(): Boolean
Release the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/","title":"StateChangeListener - Misk","text":"//wisp-lease/wisp.lease/Lease/StateChangeListener
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/#statechangelistener","title":"StateChangeListener","text":"[jvm]\\ interface StateChangeListener
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/#functions","title":"Functions","text":"Name Summary afterAcquire [jvm]abstract fun afterAcquire(lease: Lease)Called immediately after the lease is acquired. Also called immediately if the lease is already owned by this process instance when the listener is registered. beforeRelease [jvm]abstract fun beforeRelease(lease: Lease)Called immediately before the lease is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/after-acquire/","title":"afterAcquire - Misk","text":"//wisp-lease/wisp.lease/Lease/StateChangeListener/afterAcquire
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/after-acquire/#afteracquire","title":"afterAcquire","text":"[jvm]\\ abstract fun afterAcquire(lease: Lease)
Called immediately after the lease is acquired. Also called immediately if the lease is already owned by this process instance when the listener is registered.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/after-acquire/#parameters","title":"Parameters","text":"jvm
lease the lease that is acquired"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/before-release/","title":"beforeRelease - Misk","text":"//wisp-lease/wisp.lease/Lease/StateChangeListener/beforeRelease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/before-release/#beforerelease","title":"beforeRelease","text":"[jvm]\\ abstract fun beforeRelease(lease: Lease)
Called immediately before the lease is released.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/before-release/#parameters","title":"Parameters","text":"jvm
lease the lease that is released"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/","title":"LeaseManager - Misk","text":"//wisp-lease/wisp.lease/LeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/#leasemanager","title":"LeaseManager","text":"interface LeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/#inheritors","title":"Inheritors","text":"PoolLeaseManager"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/#functions","title":"Functions","text":"Name Summary acquireOrNull [jvm]fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?Attempts to acquire an AutoCloseableLease. releaseAll [jvm]open fun releaseAll() requestLease [jvm]abstract fun requestLease(name: String): LeaseRegisters interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/release-all/","title":"releaseAll - Misk","text":"//wisp-lease/wisp.lease/LeaseManager/releaseAll
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ open fun releaseAll()
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/request-lease/","title":"requestLease - Misk","text":"//wisp-lease/wisp.lease/LeaseManager/requestLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ abstract fun requestLease(name: String): Lease
Registers interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/","title":"Package-level declarations - Misk","text":"//wisp-lease/wisp.lease.pool
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/#types","title":"Types","text":"Name Summary PoolLease [jvm]class PoolLease(delegateLease: Lease, poolLeaseManager: PoolLeaseManager) : Lease PoolLeaseConfig [jvm]data class PoolLeaseConfig(val name: String, val leaseNames: List<String>) PoolLeaseManager [jvm]class PoolLeaseManager(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>) : LeaseManagerA LeaseManager that ensures that leases that are in the same lease pool are acquired on different instances. It requires a delegate LeaseManager to handle the Lease implementation."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/","title":"PoolLease - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#poollease","title":"PoolLease","text":"[jvm]\\ class PoolLease(delegateLease: Lease, poolLeaseManager: PoolLeaseManager) : Lease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#constructors","title":"Constructors","text":"PoolLease [jvm]constructor(delegateLease: Lease, poolLeaseManager: PoolLeaseManager)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): BooleanAttempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified. addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener)Registers a listener that is called on lease state changes. checkHeld [jvm]open override fun checkHeld(): BooleanCan always use the delegate\u2019s result release [jvm]open override fun release(): BooleanRelease the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/-pool-lease/","title":"PoolLease - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/PoolLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/-pool-lease/#poollease","title":"PoolLease","text":"[jvm]\\ constructor(delegateLease: Lease, poolLeaseManager: PoolLeaseManager)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/acquire/","title":"acquire - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/acquire
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Boolean
Attempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/acquire/#return","title":"Return","text":"true if this process acquires the lease.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/check-held/","title":"checkHeld - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/checkHeld
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ open override fun checkHeld(): Boolean
Can always use the delegate\u2019s result
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/release/","title":"release - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/release
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/release/#release","title":"release","text":"[jvm]\\ open override fun release(): Boolean
Release the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/","title":"PoolLeaseConfig - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/#poolleaseconfig","title":"PoolLeaseConfig","text":"[jvm]\\ data class PoolLeaseConfig(val name: String, val leaseNames: List<String>)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/#constructors","title":"Constructors","text":"PoolLeaseConfig [jvm]constructor(name: String, leaseNames: List<String>)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/#properties","title":"Properties","text":"Name Summary leaseNames [jvm]val leaseNames: List<String> name [jvm]val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/-pool-lease-config/","title":"PoolLeaseConfig - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig/PoolLeaseConfig
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/-pool-lease-config/#poolleaseconfig","title":"PoolLeaseConfig","text":"[jvm]\\ constructor(name: String, leaseNames: List<String>)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/lease-names/","title":"leaseNames - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig/leaseNames
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/lease-names/#leasenames","title":"leaseNames","text":"[jvm]\\ val leaseNames: List<String>
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/name/","title":"name - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig/name
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/","title":"PoolLeaseManager - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/#poolleasemanager","title":"PoolLeaseManager","text":"[jvm]\\ class PoolLeaseManager(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>) : LeaseManager
A LeaseManager that ensures that leases that are in the same lease pool are acquired on different instances. It requires a delegate LeaseManager to handle the Lease implementation.
This lease acquisition restriction is applied when Deployment.isReal is true.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/#constructors","title":"Constructors","text":"PoolLeaseManager [jvm]constructor(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/#functions","title":"Functions","text":"Name Summary acquireOrNull [jvm]fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?Attempts to acquire an AutoCloseableLease. releaseAll [jvm]open override fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): LeaseRegisters interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/-pool-lease-manager/","title":"PoolLeaseManager - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager/PoolLeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/-pool-lease-manager/#poolleasemanager","title":"PoolLeaseManager","text":"[jvm]\\ constructor(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/release-all/","title":"releaseAll - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager/releaseAll
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ open override fun releaseAll()
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/request-lease/","title":"requestLease - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager/requestLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ open override fun requestLease(name: String): Lease
Registers interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system
"},{"location":"0.x/wisp-lease-testing/","title":"wisp-lease-testing - Misk","text":"//wisp-lease-testing
"},{"location":"0.x/wisp-lease-testing/#wisp-lease-testing","title":"wisp-lease-testing","text":""},{"location":"0.x/wisp-lease-testing/#packages","title":"Packages","text":"Name wisp.lease"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/","title":"Package-level declarations - Misk","text":"//wisp-lease-testing/wisp.lease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/#types","title":"Types","text":"Name Summary FakeLease [jvm]class FakeLease(val name: String, manager: FakeLeaseManager) : Lease FakeLeaseManager [jvm]open class FakeLeaseManager : LeaseManagerA FakeLeaseManager provides explicit control over leases for the purposes of testing. By default, a fake lease is considered held, but it can be explicitly marked as not held if desired"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/","title":"FakeLease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#fakelease","title":"FakeLease","text":"[jvm]\\ class FakeLease(val name: String, manager: FakeLeaseManager) : Lease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#constructors","title":"Constructors","text":"FakeLease [jvm]constructor(name: String, manager: FakeLeaseManager)"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): Boolean addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener) checkHeld [jvm]open override fun checkHeld(): Boolean notifyAfterAcquire [jvm]fun notifyAfterAcquire() notifyBeforeRelease [jvm]fun notifyBeforeRelease() release [jvm]open override fun release(): BooleanRelease the lease. This will return true if released. Note that it will return false if the lease was not held."},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/-fake-lease/","title":"FakeLease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/FakeLease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/-fake-lease/#fakelease","title":"FakeLease","text":"[jvm]\\ constructor(name: String, manager: FakeLeaseManager)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/acquire/","title":"acquire - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/acquire
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Boolean
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/acquire/#return","title":"Return","text":"true if this process acquires the lease.
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/add-listener/","title":"addListener - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/addListener
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/add-listener/#addlistener","title":"addListener","text":"[jvm]\\ open override fun addListener(listener: Lease.StateChangeListener)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/check-held/","title":"checkHeld - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/checkHeld
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ open override fun checkHeld(): Boolean
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/name/","title":"name - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/name
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/name/#name","title":"name","text":"[jvm]\\ open override val name: String
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-after-acquire/","title":"notifyAfterAcquire - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/notifyAfterAcquire
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-after-acquire/#notifyafteracquire","title":"notifyAfterAcquire","text":"[jvm]\\ fun notifyAfterAcquire()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-before-release/","title":"notifyBeforeRelease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/notifyBeforeRelease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-before-release/#notifybeforerelease","title":"notifyBeforeRelease","text":"[jvm]\\ fun notifyBeforeRelease()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/release/","title":"release - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/release
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/release/#release","title":"release","text":"[jvm]\\ open override fun release(): Boolean
Release the lease. This will return true if released. Note that it will return false if the lease was not held.
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\ open class FakeLeaseManager : LeaseManager
A FakeLeaseManager provides explicit control over leases for the purposes of testing. By default, a fake lease is considered held, but it can be explicitly marked as not held if desired
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/#constructors","title":"Constructors","text":"FakeLeaseManager [jvm]constructor()"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/#functions","title":"Functions","text":"Name Summary isLeaseHeld [jvm]fun isLeaseHeld(name: String): Boolean markLeaseHeld [jvm]fun markLeaseHeld(name: String) markLeaseHeldElsewhere [jvm]fun markLeaseHeldElsewhere(name: String) releaseAll [jvm]open override fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): Lease"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/FakeLeaseManager
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/is-lease-held/","title":"isLeaseHeld - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/isLeaseHeld
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/is-lease-held/#isleaseheld","title":"isLeaseHeld","text":"[jvm]\\ fun isLeaseHeld(name: String): Boolean
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held-elsewhere/","title":"markLeaseHeldElsewhere - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/markLeaseHeldElsewhere
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held-elsewhere/#markleaseheldelsewhere","title":"markLeaseHeldElsewhere","text":"[jvm]\\ fun markLeaseHeldElsewhere(name: String)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held/","title":"markLeaseHeld - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/markLeaseHeld
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held/#markleaseheld","title":"markLeaseHeld","text":"[jvm]\\ fun markLeaseHeld(name: String)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/release-all/","title":"releaseAll - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/releaseAll
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ open override fun releaseAll()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/request-lease/","title":"requestLease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/requestLease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ open override fun requestLease(name: String): Lease
"},{"location":"0.x/wisp-logging/","title":"wisp-logging - Misk","text":"//wisp-logging
"},{"location":"0.x/wisp-logging/#wisp-logging","title":"wisp-logging","text":""},{"location":"0.x/wisp-logging/#packages","title":"Packages","text":"Name wisp.logging"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/","title":"Package-level declarations - Misk","text":"//wisp-logging/wisp.logging
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/#types","title":"Types","text":"Name Summary Copyable [jvm]interface Copyable<out T : Copyable<T>> SampledLogger [jvm]open class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger Tag [jvm]typealias Tag = Pair<String, Any?> TaggedLogger [jvm]@ExperimentalMiskApiabstract class TaggedLogger<L : Any, out R : TaggedLogger<L, R>, Copyable<R>>(kLogger: KLogger, tags: Set<Tag>) : KLogger, Copyable<R> This is a logging class to help apply and remove MDC context tags from within calls in service code."},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/#functions","title":"Functions","text":"Name Summary debug [jvm]fun KLogger.debug(vararg tags: Tag, message: () -> Any?)fun KLogger.debug(th: Throwable, vararg tags: Tag, message: () -> Any?) error [jvm]fun KLogger.error(vararg tags: Tag, message: () -> Any?)fun KLogger.error(th: Throwable, vararg tags: Tag, message: () -> Any?) getLogger [jvm]inline fun <T> getLogger(): KLogger info [jvm]fun KLogger.info(vararg tags: Tag, message: () -> Any?)fun KLogger.info(th: Throwable, vararg tags: Tag, message: () -> Any?) log [jvm]fun KLogger.log(level: Level, vararg tags: Tag, message: () -> Any?)fun KLogger.log(level: Level, th: Throwable, vararg tags: Tag, message: () -> Any?) sampled [jvm]fun KLogger.sampled(sampler: Sampler = Sampler.rateLimiting(1L)): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton. trace [jvm]fun KLogger.trace(vararg tags: Tag, message: () -> Any?)fun KLogger.trace(th: Throwable, vararg tags: Tag, message: () -> Any?) warn [jvm]fun KLogger.warn(vararg tags: Tag, message: () -> Any?)fun KLogger.warn(th: Throwable, vararg tags: Tag, message: () -> Any?) withTags [jvm]fun withTags(vararg tags: Tag, f: () -> Unit)"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/debug/","title":"debug - Misk","text":"//wisp-logging/wisp.logging/debug
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/debug/#debug","title":"debug","text":"[jvm]\\ fun KLogger.debug(vararg tags: Tag, message: () -> Any?)
fun KLogger.debug(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/error/","title":"error - Misk","text":"//wisp-logging/wisp.logging/error
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/error/#error","title":"error","text":"[jvm]\\ fun KLogger.error(vararg tags: Tag, message: () -> Any?)
fun KLogger.error(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/get-logger/","title":"getLogger - Misk","text":"//wisp-logging/wisp.logging/getLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/get-logger/#getlogger","title":"getLogger","text":"[jvm]\\ inline fun <T> getLogger(): KLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/info/","title":"info - Misk","text":"//wisp-logging/wisp.logging/info
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/info/#info","title":"info","text":"[jvm]\\ fun KLogger.info(vararg tags: Tag, message: () -> Any?)
fun KLogger.info(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/log/","title":"log - Misk","text":"//wisp-logging/wisp.logging/log
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/log/#log","title":"log","text":"[jvm]\\ fun KLogger.log(level: Level, vararg tags: Tag, message: () -> Any?)
fun KLogger.log(level: Level, th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/sampled/","title":"sampled - Misk","text":"//wisp-logging/wisp.logging/sampled
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/sampled/#sampled","title":"sampled","text":"[jvm]\\ fun KLogger.sampled(sampler: Sampler = Sampler.rateLimiting(1L)): KLogger
Returns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton.
To use default sampler (rate limited to 1 log per second):
val logger = getLogger<MyClass>().sampled()\nTo get a rate limited logger:
val logger = getLogger<MyClass>().sampled((Sampler.rateLimiting(RATE_PER_SECOND))\nTo get a probabilistic sampler
val logger = getLogger<MyClass>().sampled(Sampler.percentage(PERCENTAGE_TO_ALLOW))\nwrapped logger instance
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/sampled/#parameters","title":"Parameters","text":"jvm
sampler Sampler to use to sample logs"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/trace/","title":"trace - Misk","text":"//wisp-logging/wisp.logging/trace
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/trace/#trace","title":"trace","text":"[jvm]\\ fun KLogger.trace(vararg tags: Tag, message: () -> Any?)
fun KLogger.trace(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/warn/","title":"warn - Misk","text":"//wisp-logging/wisp.logging/warn
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/warn/#warn","title":"warn","text":"[jvm]\\ fun KLogger.warn(vararg tags: Tag, message: () -> Any?)
fun KLogger.warn(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/with-tags/","title":"withTags - Misk","text":"//wisp-logging/wisp.logging/withTags
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/with-tags/#withtags","title":"withTags","text":"[jvm]\\ fun withTags(vararg tags: Tag, f: () -> Unit)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/","title":"Copyable - Misk","text":"//wisp-logging/wisp.logging/Copyable
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/#copyable","title":"Copyable","text":"interface Copyable<out T : Copyable<T>>
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/#inheritors","title":"Inheritors","text":"TaggedLogger"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/#functions","title":"Functions","text":"Name Summary copyWithNewTags [jvm]abstract fun copyWithNewTags(newTags: Set<Tag>): T"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/copy-with-new-tags/","title":"copyWithNewTags - Misk","text":"//wisp-logging/wisp.logging/Copyable/copyWithNewTags
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/copy-with-new-tags/#copywithnewtags","title":"copyWithNewTags","text":"[jvm]\\ abstract fun copyWithNewTags(newTags: Set<Tag>): T
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/","title":"SampledLogger - Misk","text":"//wisp-logging/wisp.logging/SampledLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ open class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#constructors","title":"Constructors","text":"SampledLogger [jvm]constructor(underlyingLogger: KLogger, sampler: Sampler)"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#properties","title":"Properties","text":"Name Summary underlyingLogger [jvm]open override val underlyingLogger: KLogger"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#functions","title":"Functions","text":"Name Summary atDebug [jvm]@CheckReturnValueopen fun atDebug(): LoggingEventBuilder atError [jvm]@CheckReturnValueopen fun atError(): LoggingEventBuilder atInfo [jvm]@CheckReturnValueopen fun atInfo(): LoggingEventBuilder atLevel [jvm]@CheckReturnValueopen fun atLevel(p0: Level): LoggingEventBuilder atTrace [jvm]@CheckReturnValueopen fun atTrace(): LoggingEventBuilder atWarn [jvm]@CheckReturnValueopen fun atWarn(): LoggingEventBuilder catching [jvm]open override fun <T : Throwable> catching(throwable: T) debug [jvm]open override fun debug(msg: () -> Any?)open override fun debug(msg: String?)open override fun debug(format: String?, arg: Any?)open override fun debug(format: String?, vararg arguments: Any?)open override fun debug(msg: String?, t: Throwable?)open override fun debug(t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: String?)open override fun debug(format: String?, arg1: Any?, arg2: Any?)open override fun debug(marker: Marker?, format: String?, arg: Any?)open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)open override fun debug(marker: Marker?, msg: String?, t: Throwable?)open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) debug [jvm]fun KLogger.debug(vararg tags: Tag, message: () -> Any?)fun KLogger.debug(th: Throwable, vararg tags: Tag, message: () -> Any?) entry [jvm]open override fun entry(vararg argArray: Any?) error [jvm]open override fun error(msg: () -> Any?)open override fun error(msg: String?)open override fun error(format: String?, arg: Any?)open override fun error(format: String?, vararg arguments: Any?)open override fun error(msg: String?, t: Throwable?)open override fun error(t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, msg: () -> Any?)open override fun error(marker: Marker?, msg: String?)open override fun error(format: String?, arg1: Any?, arg2: Any?)open override fun error(marker: Marker?, format: String?, arg: Any?)open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)open override fun error(marker: Marker?, msg: String?, t: Throwable?)open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) error [jvm]fun KLogger.error(vararg tags: Tag, message: () -> Any?)fun KLogger.error(th: Throwable, vararg tags: Tag, message: () -> Any?) exit [jvm]open override fun exit()open override fun <T> exit(result: T): T getName [jvm]open override fun getName(): String info [jvm]open override fun info(msg: () -> Any?)open override fun info(msg: String?)open override fun info(format: String?, arg: Any?)open override fun info(format: String?, vararg arguments: Any?)open override fun info(msg: String?, t: Throwable?)open override fun info(t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, msg: () -> Any?)open override fun info(marker: Marker?, msg: String?)open override fun info(format: String?, arg1: Any?, arg2: Any?)open override fun info(marker: Marker?, format: String?, arg: Any?)open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)open override fun info(marker: Marker?, msg: String?, t: Throwable?)open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) info [jvm]fun KLogger.info(vararg tags: Tag, message: () -> Any?)fun KLogger.info(th: Throwable, vararg tags: Tag, message: () -> Any?) isDebugEnabled [jvm]open override fun isDebugEnabled(): Booleanopen override fun isDebugEnabled(p0: Marker): Boolean isEnabledForLevel [jvm]open fun isEnabledForLevel(p0: Level): Boolean isErrorEnabled [jvm]open override fun isErrorEnabled(): Booleanopen override fun isErrorEnabled(p0: Marker): Boolean isInfoEnabled [jvm]open override fun isInfoEnabled(): Booleanopen override fun isInfoEnabled(p0: Marker): Boolean isTraceEnabled [jvm]open override fun isTraceEnabled(): Booleanopen override fun isTraceEnabled(p0: Marker): Boolean isWarnEnabled [jvm]open override fun isWarnEnabled(): Booleanopen override fun isWarnEnabled(p0: Marker): Boolean log [jvm]fun KLogger.log(level: Level, vararg tags: Tag, message: () -> Any?)fun KLogger.log(level: Level, th: Throwable, vararg tags: Tag, message: () -> Any?) makeLoggingEventBuilder [jvm]open fun makeLoggingEventBuilder(p0: Level): LoggingEventBuilder sampled [jvm]fun KLogger.sampled(sampler: Sampler = Sampler.rateLimiting(1L)): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton. throwing [jvm]open override fun <T : Throwable> throwing(throwable: T): T trace [jvm]open override fun trace(msg: () -> Any?)open override fun trace(msg: String?)open override fun trace(format: String?, arg: Any?)open override fun trace(format: String?, vararg arguments: Any?)open override fun trace(msg: String?, t: Throwable?)open override fun trace(t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: String?)open override fun trace(format: String?, arg1: Any?, arg2: Any?)open override fun trace(marker: Marker?, format: String?, arg: Any?)open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)open override fun trace(marker: Marker?, msg: String?, t: Throwable?)open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) trace [jvm]fun KLogger.trace(vararg tags: Tag, message: () -> Any?)fun KLogger.trace(th: Throwable, vararg tags: Tag, message: () -> Any?) warn [jvm]open override fun warn(msg: () -> Any?)open override fun warn(msg: String?)open override fun warn(format: String?, arg: Any?)open override fun warn(format: String?, vararg arguments: Any?)open override fun warn(msg: String?, t: Throwable?)open override fun warn(t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: String?)open override fun warn(format: String?, arg1: Any?, arg2: Any?)open override fun warn(marker: Marker?, format: String?, arg: Any?)open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)open override fun warn(marker: Marker?, msg: String?, t: Throwable?)open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) warn [jvm]fun KLogger.warn(vararg tags: Tag, message: () -> Any?)fun KLogger.warn(th: Throwable, vararg tags: Tag, message: () -> Any?)"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/-sampled-logger/","title":"SampledLogger - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/SampledLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ constructor(underlyingLogger: KLogger, sampler: Sampler)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/debug/","title":"debug - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/debug
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/debug/#debug","title":"debug","text":"[jvm]\\ open override fun debug(msg: () -> Any?)
open override fun debug(t: Throwable?, msg: () -> Any?)
open override fun debug(marker: Marker?, msg: () -> Any?)
open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun debug(msg: String?)
open override fun debug(format: String?, arg: Any?)
open override fun debug(format: String?, arg1: Any?, arg2: Any?)
open override fun debug(format: String?, vararg arguments: Any?)
open override fun debug(msg: String?, t: Throwable?)
open override fun debug(marker: Marker?, msg: String?)
open override fun debug(marker: Marker?, format: String?, arg: Any?)
open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun debug(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/error/","title":"error - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/error
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/error/#error","title":"error","text":"[jvm]\\ open override fun error(msg: () -> Any?)
open override fun error(t: Throwable?, msg: () -> Any?)
open override fun error(marker: Marker?, msg: () -> Any?)
open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun error(msg: String?)
open override fun error(format: String?, arg: Any?)
open override fun error(format: String?, arg1: Any?, arg2: Any?)
open override fun error(format: String?, vararg arguments: Any?)
open override fun error(msg: String?, t: Throwable?)
open override fun error(marker: Marker?, msg: String?)
open override fun error(marker: Marker?, format: String?, arg: Any?)
open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun error(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/info/","title":"info - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/info
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/info/#info","title":"info","text":"[jvm]\\ open override fun info(msg: () -> Any?)
open override fun info(t: Throwable?, msg: () -> Any?)
open override fun info(marker: Marker?, msg: () -> Any?)
open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun info(msg: String?)
open override fun info(format: String?, arg: Any?)
open override fun info(format: String?, arg1: Any?, arg2: Any?)
open override fun info(format: String?, vararg arguments: Any?)
open override fun info(msg: String?, t: Throwable?)
open override fun info(marker: Marker?, msg: String?)
open override fun info(marker: Marker?, format: String?, arg: Any?)
open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun info(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/trace/","title":"trace - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/trace
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/trace/#trace","title":"trace","text":"[jvm]\\ open override fun trace(msg: () -> Any?)
open override fun trace(t: Throwable?, msg: () -> Any?)
open override fun trace(marker: Marker?, msg: () -> Any?)
open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun trace(msg: String?)
open override fun trace(format: String?, arg: Any?)
open override fun trace(format: String?, arg1: Any?, arg2: Any?)
open override fun trace(format: String?, vararg arguments: Any?)
open override fun trace(msg: String?, t: Throwable?)
open override fun trace(marker: Marker?, msg: String?)
open override fun trace(marker: Marker?, format: String?, arg: Any?)
open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)
open override fun trace(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/underlying-logger/","title":"underlyingLogger - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/underlyingLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/underlying-logger/#underlyinglogger","title":"underlyingLogger","text":"[jvm]\\ open override val underlyingLogger: KLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/warn/","title":"warn - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/warn
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/warn/#warn","title":"warn","text":"[jvm]\\ open override fun warn(msg: () -> Any?)
open override fun warn(t: Throwable?, msg: () -> Any?)
open override fun warn(marker: Marker?, msg: () -> Any?)
open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun warn(msg: String?)
open override fun warn(format: String?, arg: Any?)
open override fun warn(format: String?, vararg arguments: Any?)
open override fun warn(format: String?, arg1: Any?, arg2: Any?)
open override fun warn(msg: String?, t: Throwable?)
open override fun warn(marker: Marker?, msg: String?)
open override fun warn(marker: Marker?, format: String?, arg: Any?)
open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun warn(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tag/","title":"Tag - Misk","text":"//wisp-logging/wisp.logging/Tag
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tag/#tag","title":"Tag","text":"[jvm]\\ typealias Tag = Pair<String, Any?>
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/","title":"TaggedLogger - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/#taggedlogger","title":"TaggedLogger","text":"[jvm]\\ @ExperimentalMiskApi
abstract class TaggedLogger<L : Any, out R : TaggedLogger<L, R>, Copyable<R>>(kLogger: KLogger, tags: Set<Tag>) : KLogger, Copyable<R>
This is a logging class to help apply and remove MDC context tags from within calls in service code.
In particular, it solves the problem with searching logs using the MDC context tags where an exception caught and thrown by misk doesn\u2019t include the MDC tags and doesn\u2019t show up in the search. Using this will mean exceptions will be visible in the sequence of logs relating to a tag. See the logging example below for usage and the logging output.
Usage:
First set up a logger class with relevant MDC functions for the code base:
data class MyServiceLogger<T: Any>(\n val loggerClass: KClass<T>,\n val tags: Set<Tag> = emptySet()\n): TaggedLogger<T, MyServiceLogger<T>>(loggerClass, tags) {\n fun processValue(value: String?) = tag(\"process_value\" to value)\n\n override fun copyWithNewTags(newTags: Set<Tag>): MyServiceLogger<T>\n = this.copy(tags = newTags)\n}\nCreate a global helper function to return the above class Can be called from companion objects or regular classes - will find correct logger
fun <T : Any> KClass<T>.getTaggedLogger(): MyServiceLogger<T> {\n return MyServiceLogger(this)\n}\nThen to use the tagged logger for example:
class ServiceAction (private val webClient: WebClient): WebAction {\n\n @Post(\"/api/resource\")\n fun executeWebAction(@RequestBody request: ServiceActionRequest) {\n logger\n .processValue(request.process_value)\n .asContext() {\n logger.info() { \"Received request\" }\n doSomething()\n }\n }\n\n private fun doSomething() {\n logger.info() { \"Start Process\" }\n\n client.someWebRequest() // Client throws exception to be caught and logged by misk framework\n\n logger.info() { \"Done\" }\n }\n\n companion object {\n val logger = this::class.getTaggedLogger()\n }\n}\nLogging result:
Log MDC context: [process_value: PV_123] Log message: \"Received request\"\nLog MDC context: [process_value: PV_123] Log message: \"Start Process\"\nLog MDC context: [process_value: PV_123] Log message: \"unexpected error dispatching to ServiceAction\" // This log would not normally include the MDC context\n//wisp-logging/wisp.logging/TaggedLogger/TaggedLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-tagged-logger/#taggedlogger","title":"TaggedLogger","text":"[jvm]\\ constructor(loggerClass: KClass<L>, tags: Set<Tag>)
constructor(kLogger: KLogger, tags: Set<Tag>)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/as-context/","title":"asContext - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/asContext
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/as-context/#ascontext","title":"asContext","text":"[jvm]\\ fun <T> asContext(f: () -> T): T
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/tag/","title":"tag - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/tag
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/tag/#tag","title":"tag","text":"[jvm]\\ fun tag(vararg newTags: Tag): R
fun tag(newTags: Collection<Tag>): R
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/","title":"Companion - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/Companion
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/#functions","title":"Functions","text":"Name Summary popThreadLocalMdcContext [jvm]fun popThreadLocalMdcContext(): Set<Tag>"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/pop-thread-local-mdc-context/","title":"popThreadLocalMdcContext - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/Companion/popThreadLocalMdcContext
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/pop-thread-local-mdc-context/#popthreadlocalmdccontext","title":"popThreadLocalMdcContext","text":"[jvm]\\ fun popThreadLocalMdcContext(): Set<Tag>
"},{"location":"0.x/wisp-logging-testing/","title":"wisp-logging-testing - Misk","text":"//wisp-logging-testing
"},{"location":"0.x/wisp-logging-testing/#wisp-logging-testing","title":"wisp-logging-testing","text":""},{"location":"0.x/wisp-logging-testing/#packages","title":"Packages","text":"Name org.assertj.core.api wisp.logging"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/","title":"Package-level declarations - Misk","text":"//wisp-logging-testing/org.assertj.core.api
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/#functions","title":"Functions","text":"Name Summary assertOrdering [jvm]fun <A : Comparable<A>> assertOrdering(vararg values: A) containsExactly [jvm]inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE> isEqualToAsJson [jvm]fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/assert-ordering/","title":"assertOrdering - Misk","text":"//wisp-logging-testing/org.assertj.core.api/assertOrdering
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/assert-ordering/#assertordering","title":"assertOrdering","text":"[jvm]\\ fun <A : Comparable<A>> assertOrdering(vararg values: A)
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/contains-exactly/","title":"containsExactly - Misk","text":"//wisp-logging-testing/org.assertj.core.api/containsExactly
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/contains-exactly/#containsexactly","title":"containsExactly","text":"[jvm]\\ inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE>
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/is-equal-to-as-json/","title":"isEqualToAsJson - Misk","text":"//wisp-logging-testing/org.assertj.core.api/isEqualToAsJson
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/is-equal-to-as-json/#isequaltoasjson","title":"isEqualToAsJson","text":"[jvm]\\ fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/","title":"Package-level declarations - Misk","text":"//wisp-logging-testing/wisp.logging
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/#types","title":"Types","text":"Name Summary LogCollector [jvm]interface LogCollectorCollects log messages, so they may be asserted on for testing. WispQueuedLogCollector [jvm]class WispQueuedLogCollector : LogCollector"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/","title":"LogCollector - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/#logcollector","title":"LogCollector","text":"interface LogCollector
Collects log messages, so they may be asserted on for testing.
Use the optional parameters of takeMessages to constrain which log messages are returned.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/#inheritors","title":"Inheritors","text":"WispQueuedLogCollector"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/#functions","title":"Functions","text":"Name Summary takeEvent [jvm]abstract fun takeEvent(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): ILoggingEventWaits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.[jvm]abstract fun takeEvent(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): ILoggingEventTake the first matching event, optionally leaving unmatched logs in this collector. takeEvents [jvm]abstract fun takeEvents(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<ILoggingEvent>Removes all currently-collected log events and returns those that match the requested criteria.[jvm]abstract fun takeEvents(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<ILoggingEvent>Takes all matching events, optionally leaving unmatched logs in this collector. takeMessage [jvm]abstract fun takeMessage(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): StringWaits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.[jvm]abstract fun takeMessage(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): StringTakes the first matching message, optionally leaving unmatched logs in this collector. takeMessages [jvm]abstract fun takeMessages(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<String>Removes all currently-collected log messages and returns those that match the requested criteria.[jvm]abstract fun takeMessages(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<String>Takes all matching messages, optionally leaving unmatched logs in this collector."},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-event/","title":"takeEvent - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeEvent
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-event/#takeevent","title":"takeEvent","text":"[jvm]\\ abstract fun takeEvent(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): ILoggingEvent
Waits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.
[jvm]\\ abstract fun takeEvent(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): ILoggingEvent
Take the first matching event, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-events/","title":"takeEvents - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeEvents
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-events/#takeevents","title":"takeEvents","text":"[jvm]\\ abstract fun takeEvents(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<ILoggingEvent>
Removes all currently-collected log events and returns those that match the requested criteria.
[jvm]\\ abstract fun takeEvents(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<ILoggingEvent>
Takes all matching events, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-message/","title":"takeMessage - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeMessage
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-message/#takemessage","title":"takeMessage","text":"[jvm]\\ abstract fun takeMessage(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): String
Waits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.
[jvm]\\ abstract fun takeMessage(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): String
Takes the first matching message, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-messages/","title":"takeMessages - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeMessages
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-messages/#takemessages","title":"takeMessages","text":"[jvm]\\ abstract fun takeMessages(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<String>
Removes all currently-collected log messages and returns those that match the requested criteria.
[jvm]\\ abstract fun takeMessages(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<String>
Takes all matching messages, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/","title":"WispQueuedLogCollector - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/#wispqueuedlogcollector","title":"WispQueuedLogCollector","text":"[jvm]\\ class WispQueuedLogCollector : LogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/#constructors","title":"Constructors","text":"WispQueuedLogCollector [jvm]constructor()"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/#functions","title":"Functions","text":"Name Summary shutDown [jvm]fun shutDown() startUp [jvm]fun startUp() takeEvent [jvm]open override fun takeEvent(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): ILoggingEventWaits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.[jvm]open override fun takeEvent(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): ILoggingEventTake the first matching event, optionally leaving unmatched logs in this collector. takeEvents [jvm]open override fun takeEvents(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): List<ILoggingEvent>Removes all currently-collected log events and returns those that match the requested criteria.[jvm]open override fun takeEvents(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<ILoggingEvent>Takes all matching events, optionally leaving unmatched logs in this collector. takeMessage [jvm]open override fun takeMessage(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): StringWaits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.[jvm]open override fun takeMessage(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): StringTakes the first matching message, optionally leaving unmatched logs in this collector. takeMessages [jvm]open override fun takeMessages(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): List<String>Removes all currently-collected log messages and returns those that match the requested criteria.[jvm]open override fun takeMessages(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<String>Takes all matching messages, optionally leaving unmatched logs in this collector."},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/-wisp-queued-log-collector/","title":"WispQueuedLogCollector - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/WispQueuedLogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/-wisp-queued-log-collector/#wispqueuedlogcollector","title":"WispQueuedLogCollector","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/shut-down/","title":"shutDown - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/shutDown
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/start-up/","title":"startUp - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/startUp
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/start-up/#startup","title":"startUp","text":"[jvm]\\ fun startUp()
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-event/","title":"takeEvent - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeEvent
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-event/#takeevent","title":"takeEvent","text":"[jvm]\\ open override fun takeEvent(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): ILoggingEvent
Waits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.
[jvm]\\ open override fun takeEvent(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): ILoggingEvent
Take the first matching event, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-events/","title":"takeEvents - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeEvents
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-events/#takeevents","title":"takeEvents","text":"[jvm]\\ open override fun takeEvents(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): List<ILoggingEvent>
Removes all currently-collected log events and returns those that match the requested criteria.
[jvm]\\ open override fun takeEvents(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<ILoggingEvent>
Takes all matching events, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-message/","title":"takeMessage - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeMessage
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-message/#takemessage","title":"takeMessage","text":"[jvm]\\ open override fun takeMessage(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): String
Waits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.
[jvm]\\ open override fun takeMessage(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): String
Takes the first matching message, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-messages/","title":"takeMessages - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeMessages
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-messages/#takemessages","title":"takeMessages","text":"[jvm]\\ open override fun takeMessages(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): List<String>
Removes all currently-collected log messages and returns those that match the requested criteria.
[jvm]\\ open override fun takeMessages(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<String>
Takes all matching messages, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-moshi/","title":"wisp-moshi - Misk","text":"//wisp-moshi
"},{"location":"0.x/wisp-moshi/#wisp-moshi","title":"wisp-moshi","text":""},{"location":"0.x/wisp-moshi/#packages","title":"Packages","text":"Name wisp.moshi"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/","title":"Package-level declarations - Misk","text":"//wisp-moshi/wisp.moshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/#properties","title":"Properties","text":"Name Summary defaultKotlinMoshi [jvm]val defaultKotlinMoshi: MoshiDefault build for Moshi using the Kotlin JSON adapter"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/#functions","title":"Functions","text":"Name Summary adapter [jvm]inline fun <T> Moshi.adapter(): JsonAdapter<T> buildMoshi [jvm]@JvmOverloadsfun buildMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any> = emptyList()): Moshi"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/adapter/","title":"adapter - Misk","text":"//wisp-moshi/wisp.moshi/adapter
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/adapter/#adapter","title":"adapter","text":"[jvm]\\ inline fun <T> Moshi.adapter(): JsonAdapter<T>
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/build-moshi/","title":"buildMoshi - Misk","text":"//wisp-moshi/wisp.moshi/buildMoshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/build-moshi/#buildmoshi","title":"buildMoshi","text":"[jvm]\\
@JvmOverloads
fun buildMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any> = emptyList()): Moshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/default-kotlin-moshi/","title":"defaultKotlinMoshi - Misk","text":"//wisp-moshi/wisp.moshi/defaultKotlinMoshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/default-kotlin-moshi/#defaultkotlinmoshi","title":"defaultKotlinMoshi","text":"[jvm]\\ val defaultKotlinMoshi: Moshi
Default build for Moshi using the Kotlin JSON adapter
"},{"location":"0.x/wisp-rate-limiting/","title":"wisp-rate-limiting - Misk","text":"//wisp-rate-limiting
"},{"location":"0.x/wisp-rate-limiting/#wisp-rate-limiting","title":"wisp-rate-limiting","text":""},{"location":"0.x/wisp-rate-limiting/#packages","title":"Packages","text":"Name wisp.ratelimiting"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/","title":"Package-level declarations - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/#types","title":"Types","text":"Name Summary RateLimitConfiguration [jvm]interface RateLimitConfigurationThe rate limit configuration applied to a rate limit bucket RateLimiter [jvm]interface RateLimiterAn interface for acquiring and releasing rate limit tokens RateLimiterMetrics [jvm]class RateLimiterMetrics(meterRegistry: MeterRegistry) RateLimitPruner [jvm]interface RateLimitPrunerA standard interface for pruning expired rate limits RateLimitPrunerMetrics [jvm]class RateLimitPrunerMetrics(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/","title":"RateLimitConfiguration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/#ratelimitconfiguration","title":"RateLimitConfiguration","text":"[jvm]\\ interface RateLimitConfiguration
The rate limit configuration applied to a rate limit bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/#properties","title":"Properties","text":"Name Summary capacity [jvm]abstract val capacity: LongThe maximum number of tokens that can accumulate in the bucket name [jvm]abstract val name: StringA name identifying the configuration, e.g. \"OriginationFileProcessing\" for a rate limit configuration governing the rate at which origination files can be processed refillAmount [jvm]abstract val refillAmount: LongThe amount of tokens added back to the limit bucket every refillPeriod refillPeriod [jvm]abstract val refillPeriod: DurationThe period of time over which refillAmount tokens are added back to the bucket"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/capacity/","title":"capacity - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/capacity
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/capacity/#capacity","title":"capacity","text":"[jvm]\\ abstract val capacity: Long
The maximum number of tokens that can accumulate in the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/name/","title":"name - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/name
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/name/#name","title":"name","text":"[jvm]\\ abstract val name: String
A name identifying the configuration, e.g. \"OriginationFileProcessing\" for a rate limit configuration governing the rate at which origination files can be processed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-amount/","title":"refillAmount - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/refillAmount
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-amount/#refillamount","title":"refillAmount","text":"[jvm]\\ abstract val refillAmount: Long
The amount of tokens added back to the limit bucket every refillPeriod
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-period/","title":"refillPeriod - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/refillPeriod
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-period/#refillperiod","title":"refillPeriod","text":"[jvm]\\ abstract val refillPeriod: Duration
The period of time over which refillAmount tokens are added back to the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/","title":"RateLimitPruner - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPruner
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/#ratelimitpruner","title":"RateLimitPruner","text":"[jvm]\\ interface RateLimitPruner
A standard interface for pruning expired rate limits
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]abstract fun prune()"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/prune/","title":"prune - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPruner/prune
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/prune/#prune","title":"prune","text":"[jvm]\\ abstract fun prune()
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/","title":"RateLimitPrunerMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#ratelimitprunermetrics","title":"RateLimitPrunerMetrics","text":"[jvm]\\ class RateLimitPrunerMetrics(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#constructors","title":"Constructors","text":"RateLimitPrunerMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#properties","title":"Properties","text":"Name Summary bucketsPruned [jvm]val bucketsPruned: Counter pruningDuration [jvm]val pruningDuration: DistributionSummary"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-rate-limit-pruner-metrics/","title":"RateLimitPrunerMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/RateLimitPrunerMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-rate-limit-pruner-metrics/#ratelimitprunermetrics","title":"RateLimitPrunerMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/buckets-pruned/","title":"bucketsPruned - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/bucketsPruned
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/buckets-pruned/#bucketspruned","title":"bucketsPruned","text":"[jvm]\\ val bucketsPruned: Counter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/pruning-duration/","title":"pruningDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/pruningDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/pruning-duration/#pruningduration","title":"pruningDuration","text":"[jvm]\\ val pruningDuration: DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/","title":"Companion - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/#properties","title":"Properties","text":"Name Summary PRUNED_BUCKETS_COUNTER_NAME [jvm]const val PRUNED_BUCKETS_COUNTER_NAME: String PRUNING_DURATION [jvm]const val PRUNING_DURATION: String"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-e-d_-b-u-c-k-e-t-s_-c-o-u-n-t-e-r_-n-a-m-e/","title":"PRUNED_BUCKETS_COUNTER_NAME - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/Companion/PRUNED_BUCKETS_COUNTER_NAME
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-e-d_-b-u-c-k-e-t-s_-c-o-u-n-t-e-r_-n-a-m-e/#pruned_buckets_counter_name","title":"PRUNED_BUCKETS_COUNTER_NAME","text":"[jvm]\\ const val PRUNED_BUCKETS_COUNTER_NAME: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-i-n-g_-d-u-r-a-t-i-o-n/","title":"PRUNING_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/Companion/PRUNING_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-i-n-g_-d-u-r-a-t-i-o-n/#pruning_duration","title":"PRUNING_DURATION","text":"[jvm]\\ const val PRUNING_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/","title":"RateLimiter - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\ interface RateLimiter
An interface for acquiring and releasing rate limit tokens
Terms:
key - a unique identifier for the entity or operation being rate limitedbucket - a container for rate limit tokens applied to a specific keytoken - a unit of rate limit capacity. When we go to perform a rate limited operation, we attempt to consume a token from the bucket. If successful, we can perform the operation.See also: https://en.wikipedia.org/wiki/Token_bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/#types","title":"Types","text":"Name Summary ConsumptionData [jvm]data class ConsumptionData(val didConsume: Boolean, val remaining: Long, val resetTime: Instant) ExecutionResult [jvm]data class ExecutionResult<T>(val result: T?, val consumptionData: RateLimiter.ConsumptionData) TestConsumptionResult [jvm]data class TestConsumptionResult(val couldHaveConsumed: Boolean, val remaining: Long, val resetTime: Instant)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/#functions","title":"Functions","text":"Name Summary availableTokens [jvm]abstract fun availableTokens(key: String, configuration: RateLimitConfiguration): LongReturns how many tokens remain in the bucket. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime. consumeToken [jvm]abstract fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.ConsumptionDataConsumes amount tokens from the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation. releaseToken [jvm]abstract fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1)Releases amount tokens back to the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation. resetBucket [jvm]abstract fun resetBucket(key: String, configuration: RateLimitConfiguration)Resets the bucket back to its maximum capacity testConsumptionAttempt [jvm]abstract fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.TestConsumptionResultThis tests whether amount tokens are available in the bucket associated with the given key. It is essentially a dry run of consumeToken. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime. withToken [jvm]open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>Executes the given function if a token is available This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/available-tokens/","title":"availableTokens - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/availableTokens
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/available-tokens/#availabletokens","title":"availableTokens","text":"[jvm]\\ abstract fun availableTokens(key: String, configuration: RateLimitConfiguration): Long
Returns how many tokens remain in the bucket. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/consume-token/","title":"consumeToken - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/consumeToken
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/consume-token/#consumetoken","title":"consumeToken","text":"[jvm]\\ abstract fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.ConsumptionData
Consumes amount tokens from the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/release-token/","title":"releaseToken - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/releaseToken
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/release-token/#releasetoken","title":"releaseToken","text":"[jvm]\\ abstract fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1)
Releases amount tokens back to the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/reset-bucket/","title":"resetBucket - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/resetBucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/reset-bucket/#resetbucket","title":"resetBucket","text":"[jvm]\\ abstract fun resetBucket(key: String, configuration: RateLimitConfiguration)
Resets the bucket back to its maximum capacity
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/test-consumption-attempt/","title":"testConsumptionAttempt - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/testConsumptionAttempt
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/test-consumption-attempt/#testconsumptionattempt","title":"testConsumptionAttempt","text":"[jvm]\\ abstract fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.TestConsumptionResult
This tests whether amount tokens are available in the bucket associated with the given key. It is essentially a dry run of consumeToken. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/with-token/","title":"withToken - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/withToken
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/with-token/#withtoken","title":"withToken","text":"[jvm]\\ open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>
Executes the given function if a token is available This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/","title":"ConsumptionData - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/#consumptiondata","title":"ConsumptionData","text":"[jvm]\\ data class ConsumptionData(val didConsume: Boolean, val remaining: Long, val resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/#constructors","title":"Constructors","text":"ConsumptionData [jvm]constructor(didConsume: Boolean, remaining: Long, resetTime: Instant)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/#properties","title":"Properties","text":"Name Summary didConsume [jvm]val didConsume: BooleanWhether a token was consumed remaining [jvm]val remaining: LongCount of tokens remaining in the bucket resetTime [jvm]val resetTime: InstantThe time at which the bucket will be reset."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/-consumption-data/","title":"ConsumptionData - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/ConsumptionData
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/-consumption-data/#consumptiondata","title":"ConsumptionData","text":"[jvm]\\ constructor(didConsume: Boolean, remaining: Long, resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/did-consume/","title":"didConsume - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/didConsume
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/did-consume/#didconsume","title":"didConsume","text":"[jvm]\\ val didConsume: Boolean
Whether a token was consumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/remaining/","title":"remaining - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/remaining
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/remaining/#remaining","title":"remaining","text":"[jvm]\\ val remaining: Long
Count of tokens remaining in the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/reset-time/","title":"resetTime - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/resetTime
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/reset-time/#resettime","title":"resetTime","text":"[jvm]\\ val resetTime: Instant
The time at which the bucket will be reset.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/","title":"ExecutionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/#executionresult","title":"ExecutionResult","text":"[jvm]\\ data class ExecutionResult<T>(val result: T?, val consumptionData: RateLimiter.ConsumptionData)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/#constructors","title":"Constructors","text":"ExecutionResult [jvm]constructor(result: T?, consumptionData: RateLimiter.ConsumptionData)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/#properties","title":"Properties","text":"Name Summary consumptionData [jvm]val consumptionData: RateLimiter.ConsumptionDatatrue if a token was consumed, false otherwise result [jvm]val result: T?The result of the execution if a token was consumed, null otherwise"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/-execution-result/","title":"ExecutionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult/ExecutionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/-execution-result/#executionresult","title":"ExecutionResult","text":"[jvm]\\ constructor(result: T?, consumptionData: RateLimiter.ConsumptionData)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/consumption-data/","title":"consumptionData - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult/consumptionData
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/consumption-data/#consumptiondata","title":"consumptionData","text":"[jvm]\\ val consumptionData: RateLimiter.ConsumptionData
true if a token was consumed, false otherwise
//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult/result
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/result/#result","title":"result","text":"[jvm]\\ val result: T?
The result of the execution if a token was consumed, null otherwise
//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/#testconsumptionresult","title":"TestConsumptionResult","text":"[jvm]\\ data class TestConsumptionResult(val couldHaveConsumed: Boolean, val remaining: Long, val resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/#constructors","title":"Constructors","text":"TestConsumptionResult [jvm]constructor(couldHaveConsumed: Boolean, remaining: Long, resetTime: Instant)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/#properties","title":"Properties","text":"Name Summary couldHaveConsumed [jvm]val couldHaveConsumed: BooleanWhether a token could have been consumed remaining [jvm]val remaining: LongCount of tokens remaining in the bucket Note - this is the actual amount remaining, not the amount that would be remaining if the test consumption had been a real consumption resetTime [jvm]val resetTime: InstantThe time at which the bucket will be reset."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/-test-consumption-result/","title":"TestConsumptionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/TestConsumptionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/-test-consumption-result/#testconsumptionresult","title":"TestConsumptionResult","text":"[jvm]\\ constructor(couldHaveConsumed: Boolean, remaining: Long, resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/could-have-consumed/","title":"couldHaveConsumed - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/couldHaveConsumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/could-have-consumed/#couldhaveconsumed","title":"couldHaveConsumed","text":"[jvm]\\ val couldHaveConsumed: Boolean
Whether a token could have been consumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/remaining/","title":"remaining - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/remaining
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/remaining/#remaining","title":"remaining","text":"[jvm]\\ val remaining: Long
Count of tokens remaining in the bucket Note - this is the actual amount remaining, not the amount that would be remaining if the test consumption had been a real consumption
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/reset-time/","title":"resetTime - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/resetTime
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/reset-time/#resettime","title":"resetTime","text":"[jvm]\\ val resetTime: Instant
The time at which the bucket will be reset.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/","title":"RateLimiterMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#ratelimitermetrics","title":"RateLimiterMetrics","text":"[jvm]\\ class RateLimiterMetrics(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#constructors","title":"Constructors","text":"RateLimiterMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ConsumptionResult [jvm]enum ConsumptionResult : Enum<RateLimiterMetrics.ConsumptionResult>"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#functions","title":"Functions","text":"Name Summary consumptionAttempts [jvm]fun consumptionAttempts(configuration: RateLimitConfiguration, consumptionResult: RateLimiterMetrics.ConsumptionResult): Counter limitAvailabilityDuration [jvm]fun limitAvailabilityDuration(configuration: RateLimitConfiguration): DistributionSummary limitConsumptionDuration [jvm]fun limitConsumptionDuration(configuration: RateLimitConfiguration): DistributionSummary limitReleaseDuration [jvm]fun limitReleaseDuration(configuration: RateLimitConfiguration): DistributionSummary limitResetDuration [jvm]fun limitResetDuration(configuration: RateLimitConfiguration): DistributionSummary limitTestDuration [jvm]fun limitTestDuration(configuration: RateLimitConfiguration): DistributionSummary tokensConsumed [jvm]fun tokensConsumed(configuration: RateLimitConfiguration): Counter"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-rate-limiter-metrics/","title":"RateLimiterMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/RateLimiterMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-rate-limiter-metrics/#ratelimitermetrics","title":"RateLimiterMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/consumption-attempts/","title":"consumptionAttempts - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/consumptionAttempts
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/consumption-attempts/#consumptionattempts","title":"consumptionAttempts","text":"[jvm]\\ fun consumptionAttempts(configuration: RateLimitConfiguration, consumptionResult: RateLimiterMetrics.ConsumptionResult): Counter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-availability-duration/","title":"limitAvailabilityDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitAvailabilityDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-availability-duration/#limitavailabilityduration","title":"limitAvailabilityDuration","text":"[jvm]\\ fun limitAvailabilityDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-consumption-duration/","title":"limitConsumptionDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitConsumptionDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-consumption-duration/#limitconsumptionduration","title":"limitConsumptionDuration","text":"[jvm]\\ fun limitConsumptionDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-release-duration/","title":"limitReleaseDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitReleaseDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-release-duration/#limitreleaseduration","title":"limitReleaseDuration","text":"[jvm]\\ fun limitReleaseDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-reset-duration/","title":"limitResetDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitResetDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-reset-duration/#limitresetduration","title":"limitResetDuration","text":"[jvm]\\ fun limitResetDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-test-duration/","title":"limitTestDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitTestDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-test-duration/#limittestduration","title":"limitTestDuration","text":"[jvm]\\ fun limitTestDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/tokens-consumed/","title":"tokensConsumed - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/tokensConsumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/tokens-consumed/#tokensconsumed","title":"tokensConsumed","text":"[jvm]\\ fun tokensConsumed(configuration: RateLimitConfiguration): Counter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/","title":"Companion - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/#properties","title":"Properties","text":"Name Summary ATTEMPT_COUNTER_NAME [jvm]const val ATTEMPT_COUNTER_NAME: String LIMIT_AVAILABILITY_DURATION [jvm]const val LIMIT_AVAILABILITY_DURATION: String LIMIT_CONSUMPTION_DURATION [jvm]const val LIMIT_CONSUMPTION_DURATION: String LIMIT_RELEASE_DURATION [jvm]const val LIMIT_RELEASE_DURATION: String LIMIT_RESET_DURATION [jvm]const val LIMIT_RESET_DURATION: String LIMIT_TEST_DURATION [jvm]const val LIMIT_TEST_DURATION: String RATE_LIMIT_TAG [jvm]const val RATE_LIMIT_TAG: String RESULT_TAG [jvm]const val RESULT_TAG: String TOTAL_CONSUMED_COUNTER_NAME [jvm]const val TOTAL_CONSUMED_COUNTER_NAME: String"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-a-t-t-e-m-p-t_-c-o-u-n-t-e-r_-n-a-m-e/","title":"ATTEMPT_COUNTER_NAME - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/ATTEMPT_COUNTER_NAME
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-a-t-t-e-m-p-t_-c-o-u-n-t-e-r_-n-a-m-e/#attempt_counter_name","title":"ATTEMPT_COUNTER_NAME","text":"[jvm]\\ const val ATTEMPT_COUNTER_NAME: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-a-v-a-i-l-a-b-i-l-i-t-y_-d-u-r-a-t-i-o-n/","title":"LIMIT_AVAILABILITY_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_AVAILABILITY_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-a-v-a-i-l-a-b-i-l-i-t-y_-d-u-r-a-t-i-o-n/#limit_availability_duration","title":"LIMIT_AVAILABILITY_DURATION","text":"[jvm]\\ const val LIMIT_AVAILABILITY_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-c-o-n-s-u-m-p-t-i-o-n_-d-u-r-a-t-i-o-n/","title":"LIMIT_CONSUMPTION_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_CONSUMPTION_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-c-o-n-s-u-m-p-t-i-o-n_-d-u-r-a-t-i-o-n/#limit_consumption_duration","title":"LIMIT_CONSUMPTION_DURATION","text":"[jvm]\\ const val LIMIT_CONSUMPTION_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-l-e-a-s-e_-d-u-r-a-t-i-o-n/","title":"LIMIT_RELEASE_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_RELEASE_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-l-e-a-s-e_-d-u-r-a-t-i-o-n/#limit_release_duration","title":"LIMIT_RELEASE_DURATION","text":"[jvm]\\ const val LIMIT_RELEASE_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-s-e-t_-d-u-r-a-t-i-o-n/","title":"LIMIT_RESET_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_RESET_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-s-e-t_-d-u-r-a-t-i-o-n/#limit_reset_duration","title":"LIMIT_RESET_DURATION","text":"[jvm]\\ const val LIMIT_RESET_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-t-e-s-t_-d-u-r-a-t-i-o-n/","title":"LIMIT_TEST_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_TEST_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-t-e-s-t_-d-u-r-a-t-i-o-n/#limit_test_duration","title":"LIMIT_TEST_DURATION","text":"[jvm]\\ const val LIMIT_TEST_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-a-t-e_-l-i-m-i-t_-t-a-g/","title":"RATE_LIMIT_TAG - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/RATE_LIMIT_TAG
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-a-t-e_-l-i-m-i-t_-t-a-g/#rate_limit_tag","title":"RATE_LIMIT_TAG","text":"[jvm]\\ const val RATE_LIMIT_TAG: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-e-s-u-l-t_-t-a-g/","title":"RESULT_TAG - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/RESULT_TAG
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-e-s-u-l-t_-t-a-g/#result_tag","title":"RESULT_TAG","text":"[jvm]\\ const val RESULT_TAG: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-t-o-t-a-l_-c-o-n-s-u-m-e-d_-c-o-u-n-t-e-r_-n-a-m-e/","title":"TOTAL_CONSUMED_COUNTER_NAME - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/TOTAL_CONSUMED_COUNTER_NAME
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-t-o-t-a-l_-c-o-n-s-u-m-e-d_-c-o-u-n-t-e-r_-n-a-m-e/#total_consumed_counter_name","title":"TOTAL_CONSUMED_COUNTER_NAME","text":"[jvm]\\ const val TOTAL_CONSUMED_COUNTER_NAME: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/","title":"ConsumptionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#consumptionresult","title":"ConsumptionResult","text":"[jvm]\\ enum ConsumptionResult : Enum<RateLimiterMetrics.ConsumptionResult>
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#entries","title":"Entries","text":"SUCCESS [jvm]SUCCESSA token was consumed successfully REJECTED [jvm]REJECTEDThere were insufficient tokens in the bucket EXCEPTION [jvm]EXCEPTIONAn exception was thrown while attempting to consume a token"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<RateLimiterMetrics.ConsumptionResult>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): RateLimiterMetrics.ConsumptionResultReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<RateLimiterMetrics.ConsumptionResult>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/entries/","title":"entries - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/entries
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<RateLimiterMetrics.ConsumptionResult>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/value-of/","title":"valueOf - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/valueOf
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): RateLimiterMetrics.ConsumptionResult
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/values/","title":"values - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/values
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<RateLimiterMetrics.ConsumptionResult>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-e-x-c-e-p-t-i-o-n/","title":"EXCEPTION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/EXCEPTION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-e-x-c-e-p-t-i-o-n/#exception","title":"EXCEPTION","text":"[jvm]\\ EXCEPTION
An exception was thrown while attempting to consume a token
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-e-x-c-e-p-t-i-o-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-r-e-j-e-c-t-e-d/","title":"REJECTED - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/REJECTED
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-r-e-j-e-c-t-e-d/#rejected","title":"REJECTED","text":"[jvm]\\ REJECTED
There were insufficient tokens in the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-r-e-j-e-c-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-s-u-c-c-e-s-s/","title":"SUCCESS - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/SUCCESS
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-s-u-c-c-e-s-s/#success","title":"SUCCESS","text":"[jvm]\\ SUCCESS
A token was consumed successfully
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-s-u-c-c-e-s-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-resource-loader/","title":"wisp-resource-loader - Misk","text":"//wisp-resource-loader
"},{"location":"0.x/wisp-resource-loader/#wisp-resource-loader","title":"wisp-resource-loader","text":""},{"location":"0.x/wisp-resource-loader/#packages","title":"Packages","text":"Name wisp.resources"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/","title":"Package-level declarations - Misk","text":"//wisp-resource-loader/wisp.resources
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/#types","title":"Types","text":"Name Summary ClasspathResourceLoaderBackend [jvm]object ClasspathResourceLoaderBackend : ResourceLoader.BackendRead-only resources that are fetched from either the deployed .jar file or the local filesystem. EnvironmentResourceLoaderBackend [jvm]object EnvironmentResourceLoaderBackend : ResourceLoader.BackendRead-only resources that are fetched from environment variables. FilesystemLoaderBackend [jvm]object FilesystemLoaderBackend : ResourceLoader.BackendRead-only resources that are fetched from the local filesystem using absolute paths. MemoryResourceLoaderBackend [jvm]class MemoryResourceLoaderBackend : ResourceLoader.BackendRead-write resources stored only in memory. Most useful for testing. It is possible to have multiple instances of this backend. ResourceLoader [jvm]open class ResourceLoader(backends: Map<String, ResourceLoader.Backend>)ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source."},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/","title":"ClasspathResourceLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/#classpathresourceloaderbackend","title":"ClasspathResourceLoaderBackend","text":"[jvm]\\ object ClasspathResourceLoaderBackend : ResourceLoader.Backend
Read-only resources that are fetched from either the deployed .jar file or the local filesystem.
This uses the scheme classpath:.
//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/list/#list","title":"list","text":"[jvm]\\ open override fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/","title":"EnvironmentResourceLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/#environmentresourceloaderbackend","title":"EnvironmentResourceLoaderBackend","text":"[jvm]\\ object EnvironmentResourceLoaderBackend : ResourceLoader.Backend
Read-only resources that are fetched from environment variables.
This uses the scheme environment:.
//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/check-path/","title":"checkPath - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/checkPath
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/check-path/#checkpath","title":"checkPath","text":"[jvm]\\ open override fun checkPath(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/list/#list","title":"list","text":"[jvm]\\ open override fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/","title":"FilesystemLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/#filesystemloaderbackend","title":"FilesystemLoaderBackend","text":"[jvm]\\ object FilesystemLoaderBackend : ResourceLoader.Backend
Read-only resources that are fetched from the local filesystem using absolute paths.
This uses the scheme filesystem:.
//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/list/#list","title":"list","text":"[jvm]\\ open override fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open override fun unwatch(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(path: String, resourceChangedListener: (address: String) -> Unit)
For changes to the file that have been done externally, since this is a read-only ResourceLoader.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/","title":"MemoryResourceLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/#memoryresourceloaderbackend","title":"MemoryResourceLoaderBackend","text":"[jvm]\\ class MemoryResourceLoaderBackend : ResourceLoader.Backend
Read-write resources stored only in memory. Most useful for testing. It is possible to have multiple instances of this backend.
This uses the scheme memory:.
//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/MemoryResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-memory-resource-loader-backend/#memoryresourceloaderbackend","title":"MemoryResourceLoaderBackend","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/all/","title":"all - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/all
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/all/#all","title":"all","text":"[jvm]\\ open override fun all(): Set<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/put/","title":"put - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/put
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/put/#put","title":"put","text":"[jvm]\\ open override fun put(path: String, data: ByteString)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/resource-changed/","title":"resourceChanged - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/resourceChanged
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/resource-changed/#resourcechanged","title":"resourceChanged","text":"[jvm]\\ fun resourceChanged(scheme: String, path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open override fun unwatch(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(path: String, resourceChangedListener: (address: String) -> Unit)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/","title":"Companion - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/#properties","title":"Properties","text":"Name Summary SCHEME [jvm]const val SCHEME: String"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/-s-c-h-e-m-e/","title":"SCHEME - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/Companion/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/","title":"ResourceLoader - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\ open class ResourceLoader(backends: Map<String, ResourceLoader.Backend>)
ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source.
Resource addresses have a scheme name, a colon, and an absolute filesystem-like path: classpath:/migrations/v1.sql. Schemes identify backends classpath: or memory:. Paths start with a slash and have any number of segments.
Classpath resources use the scheme classpath:. The backend reads data from the src/main/resources of the project\u2019s modules and the contents of all library .jar files. Classpath resources are read-only.
Filesystem resources use the scheme filesystem:. The backend reads data from the host machine\u2019s local filesystem. It is read-only and does not support list.
Memory resources use the scheme memory:. The backend starts empty and is populated by calls to put.
Other backends are permitted. They should be registered with a MapBinder with the backend scheme like classpath: as the key.
address as bytes, or null if no such resource exists. Note that this method reads the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently. copyTo [jvm]fun copyTo(root: String, dir: Path)Copies all resources with root as a prefix to the directory dir. exists [jvm]fun exists(address: String): BooleanReturns true if a resource at address exists. list [jvm]fun list(address: String): List<String>Returns the full path of the resources that are immediate children of address. open [jvm]fun open(address: String): BufferedSource?Return a buffered source for address, or null if no such resource exists. put [jvm]fun put(address: String, utf8: String)Writes a resource as UTF-8. Throws if the backend is readonly.[jvm]fun put(address: String, data: ByteString)Writes a resource. Throws if the backend is readonly. requireBytes [jvm]fun requireBytes(address: String): ByteStringLike bytes, but throws IllegalStateException if the resource is missing. requireUtf8 [jvm]fun requireUtf8(address: String): StringLike utf8, but throws IllegalStateException if the resource is missing. unwatch [jvm]fun unwatch(address: String) utf8 [jvm]fun utf8(address: String): String?Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently. walk [jvm]fun walk(address: String): List<String> watch [jvm]fun watch(address: String, resourceChangedListener: (address: String) -> Unit)"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-resource-loader/","title":"ResourceLoader - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/ResourceLoader
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\ constructor(backends: Map<String, ResourceLoader.Backend>)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/bytes/","title":"bytes - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/bytes
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/bytes/#bytes","title":"bytes","text":"[jvm]\\ fun bytes(address: String): ByteString?
Return the contents of address as bytes, or null if no such resource exists. Note that this method reads the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently.
//wisp-resource-loader/wisp.resources/ResourceLoader/copyTo
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/copy-to/#copyto","title":"copyTo","text":"[jvm]\\ fun copyTo(root: String, dir: Path)
Copies all resources with root as a prefix to the directory dir.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/exists/#exists","title":"exists","text":"[jvm]\\ fun exists(address: String): Boolean
Returns true if a resource at address exists.
//wisp-resource-loader/wisp.resources/ResourceLoader/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/list/#list","title":"list","text":"[jvm]\\ fun list(address: String): List<String>
Returns the full path of the resources that are immediate children of address.
//wisp-resource-loader/wisp.resources/ResourceLoader/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/open/#open","title":"open","text":"[jvm]\\ fun open(address: String): BufferedSource?
Return a buffered source for address, or null if no such resource exists.
//wisp-resource-loader/wisp.resources/ResourceLoader/put
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/put/#put","title":"put","text":"[jvm]\\ fun put(address: String, utf8: String)
Writes a resource as UTF-8. Throws if the backend is readonly.
[jvm]\\ fun put(address: String, data: ByteString)
Writes a resource. Throws if the backend is readonly.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-bytes/","title":"requireBytes - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/requireBytes
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-bytes/#requirebytes","title":"requireBytes","text":"[jvm]\\ fun requireBytes(address: String): ByteString
Like bytes, but throws IllegalStateException if the resource is missing.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-utf8/","title":"requireUtf8 - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/requireUtf8
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-utf8/#requireutf8","title":"requireUtf8","text":"[jvm]\\ fun requireUtf8(address: String): String
Like utf8, but throws IllegalStateException if the resource is missing.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ fun unwatch(address: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/utf8/","title":"utf8 - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/utf8
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/utf8/#utf8","title":"utf8","text":"[jvm]\\ fun utf8(address: String): String?
Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently.
//wisp-resource-loader/wisp.resources/ResourceLoader/walk
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/walk/#walk","title":"walk","text":"[jvm]\\ fun walk(address: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/watch/#watch","title":"watch","text":"[jvm]\\ fun watch(address: String, resourceChangedListener: (address: String) -> Unit)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/","title":"Backend - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#backend","title":"Backend","text":"abstract class Backend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#inheritors","title":"Inheritors","text":"ClasspathResourceLoaderBackend EnvironmentResourceLoaderBackend FilesystemLoaderBackend MemoryResourceLoaderBackend"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#constructors","title":"Constructors","text":"Backend [jvm]constructor()"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#functions","title":"Functions","text":"Name Summary all [jvm]open fun all(): Set<String> checkPath [jvm]open fun checkPath(path: String) exists [jvm]abstract fun exists(path: String): Boolean list [jvm]open fun list(path: String): List<String> open [jvm]abstract fun open(path: String): BufferedSource? put [jvm]open fun put(path: String, data: ByteString) unwatch [jvm]open fun unwatch(path: String) watch [jvm]open fun watch(path: String, resourceChangedListener: (address: String) -> Unit)"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/-backend/","title":"Backend - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/Backend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/-backend/#backend","title":"Backend","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/all/","title":"all - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/all
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/all/#all","title":"all","text":"[jvm]\\ open fun all(): Set<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/check-path/","title":"checkPath - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/checkPath
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/check-path/#checkpath","title":"checkPath","text":"[jvm]\\ open fun checkPath(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/exists/#exists","title":"exists","text":"[jvm]\\ abstract fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/list/#list","title":"list","text":"[jvm]\\ open fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/open/#open","title":"open","text":"[jvm]\\ abstract fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/put/","title":"put - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/put
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/put/#put","title":"put","text":"[jvm]\\ open fun put(path: String, data: ByteString)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open fun unwatch(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/watch/#watch","title":"watch","text":"[jvm]\\ open fun watch(path: String, resourceChangedListener: (address: String) -> Unit)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/","title":"Companion - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/#properties","title":"Properties","text":"Name Summary SYSTEM [jvm]val SYSTEM: ResourceLoader"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/-s-y-s-t-e-m/","title":"SYSTEM - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Companion/SYSTEM
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/-s-y-s-t-e-m/#system","title":"SYSTEM","text":"[jvm]\\ val SYSTEM: ResourceLoader
"},{"location":"0.x/wisp-resource-loader-testing/","title":"wisp-resource-loader-testing - Misk","text":"//wisp-resource-loader-testing
"},{"location":"0.x/wisp-resource-loader-testing/#wisp-resource-loader-testing","title":"wisp-resource-loader-testing","text":""},{"location":"0.x/wisp-resource-loader-testing/#packages","title":"Packages","text":"Name wisp.resources"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/","title":"Package-level declarations - Misk","text":"//wisp-resource-loader-testing/wisp.resources
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/#types","title":"Types","text":"Name Summary FakeFilesystemLoaderBackend [jvm]class FakeFilesystemLoaderBackend(files: Map<String, String>) : ResourceLoader.BackendA fake FilesystemLoaderBackend that loads file contents from an in-memory map. The map can be populated by adding to the ForFakeFiles map."},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/","title":"FakeFilesystemLoaderBackend - Misk","text":"//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/#fakefilesystemloaderbackend","title":"FakeFilesystemLoaderBackend","text":"[jvm]\\ class FakeFilesystemLoaderBackend(files: Map<String, String>) : ResourceLoader.Backend
A fake FilesystemLoaderBackend that loads file contents from an in-memory map. The map can be populated by adding to the ForFakeFiles map.
newMapBinder<String, String>(ForFakeFiles::class).addBinding(\"/etc/foo.txt\").toInstance(\"hello!\")\n//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend/FakeFilesystemLoaderBackend
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/-fake-filesystem-loader-backend/#fakefilesystemloaderbackend","title":"FakeFilesystemLoaderBackend","text":"[jvm]\\ constructor(files: Map<String, String>)
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-sampling/","title":"wisp-sampling - Misk","text":"//wisp-sampling
"},{"location":"0.x/wisp-sampling/#wisp-sampling","title":"wisp-sampling","text":""},{"location":"0.x/wisp-sampling/#packages","title":"Packages","text":"Name wisp.sampling"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/","title":"Package-level declarations - Misk","text":"//wisp-sampling/wisp.sampling
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/#types","title":"Types","text":"Name Summary AlwaysSampler [jvm]class AlwaysSampler : Sampler PercentageSampler [jvm]class PercentageSampler(samplePercentage: Int, random: () -> Int) : Sampler RateLimiter [jvm]class RateLimiter@JvmOverloadsconstructor(var permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)A deterministic testable rate limiter that uses two variables: RateLimitingSampler [jvm]class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler Sampler [jvm]interface SamplerA Sampler is used to \"sample\" whether an action is allowed to occur or not. Sleeper [jvm]interface SleeperAbstraction forThread.sleep() that allows for testing. Ticker [jvm]interface TickerAbstraction for System.nanoTime() that allows for testing."},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/","title":"AlwaysSampler - Misk","text":"//wisp-sampling/wisp.sampling/AlwaysSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\ class AlwaysSampler : Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/#constructors","title":"Constructors","text":"AlwaysSampler [jvm]constructor()"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanTests if a sample is allowed or not"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/-always-sampler/","title":"AlwaysSampler - Misk","text":"//wisp-sampling/wisp.sampling/AlwaysSampler/AlwaysSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/sample/","title":"sample - Misk","text":"//wisp-sampling/wisp.sampling/AlwaysSampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/PercentageSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/#percentagesampler","title":"PercentageSampler","text":"[jvm]\\ class PercentageSampler(samplePercentage: Int, random: () -> Int) : Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/#constructors","title":"Constructors","text":"PercentageSampler [jvm]constructor(samplePercentage: Int, random: () -> Int)"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanTests if a sample is allowed or not"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/-percentage-sampler/","title":"PercentageSampler - Misk","text":"//wisp-sampling/wisp.sampling/PercentageSampler/PercentageSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/-percentage-sampler/#percentagesampler","title":"PercentageSampler","text":"[jvm]\\ constructor(samplePercentage: Int, random: () -> Int)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/sample/","title":"sample - Misk","text":"//wisp-sampling/wisp.sampling/PercentageSampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/RateLimiter
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\ class RateLimiter@JvmOverloadsconstructor(var permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)
A deterministic testable rate limiter that uses two variables:
The implementation tracks a future timestamp that permits are consumed until.
This class is similar to Guava\u2019s rate limiter. Unlike Guava\u2019s rate limiter this class is testable by application code using the rate limiter. It also has very predictable behavior because its internal mechanisms are simpler than Guava\u2019s.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#constructors","title":"Constructors","text":"RateLimiter [jvm]@JvmOverloadsconstructor(permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#properties","title":"Properties","text":"Name Summary permitsPerSecond [jvm]@Volatilevar permitsPerSecond: Long"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#functions","title":"Functions","text":"Name Summary getPermitsRemaining [jvm]fun getPermitsRemaining(unit: TimeUnit, timeout: Long): LongReturns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit. tryAcquire [jvm]fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): BooleanAttempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available."},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/-rate-limiter/","title":"RateLimiter - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/RateLimiter
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\
@JvmOverloads
constructor(permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/get-permits-remaining/","title":"getPermitsRemaining - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/getPermitsRemaining
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/get-permits-remaining/#getpermitsremaining","title":"getPermitsRemaining","text":"[jvm]\\ fun getPermitsRemaining(unit: TimeUnit, timeout: Long): Long
Returns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/permits-per-second/","title":"permitsPerSecond - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/permitsPerSecond
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/permits-per-second/#permitspersecond","title":"permitsPerSecond","text":"[jvm]\\
@Volatile
var permitsPerSecond: Long
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/tryAcquire
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"[jvm]\\ fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): Boolean
Attempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available.
Returns true if permits were acquired.
This always returns false if you request more than 1 window size worth of permits. If you need many permits, shrink your batch size. This is intended to smooth out consumption of the resources guarded by this rate limiter.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//wisp-sampling/wisp.sampling/RateLimitingSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/#constructors","title":"Constructors","text":"RateLimitingSampler [jvm]constructor(rateLimiter: RateLimiter)"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanTests if a sample is allowed or not"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//wisp-sampling/wisp.sampling/RateLimitingSampler/RateLimitingSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ constructor(rateLimiter: RateLimiter)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/sample/","title":"sample - Misk","text":"//wisp-sampling/wisp.sampling/RateLimitingSampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/#sampler","title":"Sampler","text":"interface Sampler
A Sampler is used to \"sample\" whether an action is allowed to occur or not.
A common usage of the sampler would look like:
if (sampler.sample()) {\n performAction()\n}\nThe frequency at which sample returns true or false is based on the implementation\u2019s policy. For example, Sampler.always creates a Sampler that only returns true, while Sampler.percentage will only return true for a given percentage of samples. For a more complex example, Sampler.rateLimiting will limit the number of true samples to a given rate per second.
//wisp-sampling/wisp.sampling/Sampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/sample/#sample","title":"sample","text":"[jvm]\\ abstract fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/Sampler/Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/#functions","title":"Functions","text":"Name Summary always [jvm]fun always(): SamplerCreates a Sampler that always returns positive results. percentage [jvm]fun percentage(samplePercentage: Int): SamplerCreates a Sampler that limits positive results to a percentage chance. rateLimiting [jvm]fun rateLimiting(ratePerSecond: Long): SamplerCreates a Sampler that limits positive results to a limited rate per second."},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/always/","title":"always - Misk","text":"//wisp-sampling/wisp.sampling/Sampler/Companion/always
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/always/#always","title":"always","text":"[jvm]\\ fun always(): Sampler
Creates a Sampler that always returns positive results.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/always/#return","title":"Return","text":"always Sampler instance
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/","title":"percentage - Misk","text":"//wisp-sampling/wisp.sampling/Sampler/Companion/percentage
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/#percentage","title":"percentage","text":"[jvm]\\ fun percentage(samplePercentage: Int): Sampler
Creates a Sampler that limits positive results to a percentage chance.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/#return","title":"Return","text":"percentage Sampler instance
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/#parameters","title":"Parameters","text":"jvm
samplePercentage percentage chance of positive results"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/","title":"rateLimiting - Misk","text":"//wisp-sampling/wisp.sampling/Sampler/Companion/rateLimiting
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/#ratelimiting","title":"rateLimiting","text":"[jvm]\\ fun rateLimiting(ratePerSecond: Long): Sampler
Creates a Sampler that limits positive results to a limited rate per second.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/#return","title":"Return","text":"rate limiting Sampler instance
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/#parameters","title":"Parameters","text":"jvm
ratePerSecond the number of positive results per second"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/","title":"Sleeper - Misk","text":"//wisp-sampling/wisp.sampling/Sleeper
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/#sleeper","title":"Sleeper","text":"[jvm]\\ interface Sleeper
Abstraction for Thread.sleep() that allows for testing.
//wisp-sampling/wisp.sampling/Sleeper/sleep
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/sleep/#sleep","title":"sleep","text":"[jvm]\\ abstract fun sleep(duration: Duration)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/","title":"Companion - Misk","text":"//wisp-sampling/wisp.sampling/Sleeper/Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT [jvm]val DEFAULT: Sleeper"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/-d-e-f-a-u-l-t/","title":"DEFAULT - Misk","text":"//wisp-sampling/wisp.sampling/Sleeper/Companion/DEFAULT
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/-d-e-f-a-u-l-t/#default","title":"DEFAULT","text":"[jvm]\\ val DEFAULT: Sleeper
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/","title":"Ticker - Misk","text":"//wisp-sampling/wisp.sampling/Ticker
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/#ticker","title":"Ticker","text":"[jvm]\\ interface Ticker
Abstraction for System.nanoTime() that allows for testing.
//wisp-sampling/wisp.sampling/Ticker/read
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/read/#read","title":"read","text":"[jvm]\\ abstract fun read(): Long
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/","title":"Companion - Misk","text":"//wisp-sampling/wisp.sampling/Ticker/Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT [jvm]val DEFAULT: Ticker"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/-d-e-f-a-u-l-t/","title":"DEFAULT - Misk","text":"//wisp-sampling/wisp.sampling/Ticker/Companion/DEFAULT
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/-d-e-f-a-u-l-t/#default","title":"DEFAULT","text":"[jvm]\\ val DEFAULT: Ticker
"},{"location":"0.x/wisp-ssl/","title":"wisp-ssl - Misk","text":"//wisp-ssl
"},{"location":"0.x/wisp-ssl/#wisp-ssl","title":"wisp-ssl","text":""},{"location":"0.x/wisp-ssl/#packages","title":"Packages","text":"Name wisp.security.ssl"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/","title":"Package-level declarations - Misk","text":"//wisp-ssl/wisp.security.ssl
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#types","title":"Types","text":"Name Summary CertificateAndKey [jvm]data class CertificateAndKey(val certificate: X509Certificate, val privateKey: PrivateKey) CertStore [jvm]data class CertStore(val keyStore: KeyStore)A certificate and its private key. CertStoreConfig [jvm]data class CertStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS) PemComboFile [jvm]data class PemComboFile(val certificates: List<ByteString>, val privateRsaKeys: List<ByteString>, val privateKeys: List<ByteString>, val passphrase: String)A file containing a mix of PEM-encoded certificates and PEM-encoded private keys. Can be used both for trust stores (which certificate authorities a TLS client trusts) and also for TLS servers (which certificate chain a TLS server serves). SslContextFactory [jvm]open class SslContextFactory(sslLoader: SslLoader) SslLoader [jvm]open class SslLoader(resourceLoader: ResourceLoader)Loads keys and certificates from the file system. TrustStore [jvm]data class TrustStore(val keyStore: KeyStore)A set of trusted root certificates. TrustStoreConfig [jvm]data class TrustStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#properties","title":"Properties","text":"Name Summary onlyAlias [jvm]val KeyStore.onlyAlias: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#functions","title":"Functions","text":"Name Summary aliasesOfType [jvm]inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String> getCertificateAndKey [jvm]fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey? getPrivateKey [jvm]fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKeyfun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey getX509Certificate [jvm]fun KeyStore.getX509Certificate(): X509Certificatefun KeyStore.getX509Certificate(alias: String): X509Certificate getX509CertificateChain [jvm]fun KeyStore.getX509CertificateChain(): Array<X509Certificate>fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/aliases-of-type/","title":"aliasesOfType - Misk","text":"//wisp-ssl/wisp.security.ssl/aliasesOfType
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/aliases-of-type/#aliasesoftype","title":"aliasesOfType","text":"[jvm]\\ fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/aliases-of-type/#return","title":"Return","text":"all aliases present in the keystore of a given entry type.
[jvm]\\ inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/","title":"getCertificateAndKey - Misk","text":"//wisp-ssl/wisp.security.ssl/getCertificateAndKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/#getcertificateandkey","title":"getCertificateAndKey","text":"[jvm]\\ fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/#return","title":"Return","text":"the certificate and key pair for the given alias
[jvm]\\ fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/#return_1","title":"Return","text":"the one and only CertificateAndKey in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/","title":"getPrivateKey - Misk","text":"//wisp-ssl/wisp.security.ssl/getPrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/#getprivatekey","title":"getPrivateKey","text":"[jvm]\\ fun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/#return","title":"Return","text":"the PrivateKey with the given alias
[jvm]\\ fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/#return_1","title":"Return","text":"the one and only PrivateKey in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/","title":"getX509CertificateChain - Misk","text":"//wisp-ssl/wisp.security.ssl/getX509CertificateChain
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/#getx509certificatechain","title":"getX509CertificateChain","text":"[jvm]\\ fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/#return","title":"Return","text":"the X509Certificate chain with the provided alias
[jvm]\\ fun KeyStore.getX509CertificateChain(): Array<X509Certificate>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/#return_1","title":"Return","text":"the one and only X509Certificate chain in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/","title":"getX509Certificate - Misk","text":"//wisp-ssl/wisp.security.ssl/getX509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/#getx509certificate","title":"getX509Certificate","text":"[jvm]\\ fun KeyStore.getX509Certificate(alias: String): X509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/#return","title":"Return","text":"The X509Certificate with the provided alias
[jvm]\\ fun KeyStore.getX509Certificate(): X509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/#return_1","title":"Return","text":"the one and only X509Certificate in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/only-alias/","title":"onlyAlias - Misk","text":"//wisp-ssl/wisp.security.ssl/onlyAlias
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/only-alias/#onlyalias","title":"onlyAlias","text":"[jvm]\\ val KeyStore.onlyAlias: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/only-alias/#return","title":"Return","text":"the only alias in the keystore, if the keystore only has a single entry
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/","title":"CertStore - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/#certstore","title":"CertStore","text":"[jvm]\\ data class CertStore(val keyStore: KeyStore)
A certificate and its private key.
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/#constructors","title":"Constructors","text":"CertStore [jvm]constructor(keyStore: KeyStore)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/#properties","title":"Properties","text":"Name Summary keyStore [jvm]val keyStore: KeyStore"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/-cert-store/","title":"CertStore - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStore/CertStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/-cert-store/#certstore","title":"CertStore","text":"[jvm]\\ constructor(keyStore: KeyStore)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/key-store/","title":"keyStore - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStore/keyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/key-store/#keystore","title":"keyStore","text":"[jvm]\\ val keyStore: KeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\ data class CertStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/#constructors","title":"Constructors","text":"CertStoreConfig [jvm]@JvmOverloadsconstructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/CertStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\
@JvmOverloads
constructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/format/","title":"format - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/format
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/passphrase/","title":"passphrase - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/passphrase
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/resource/","title":"resource - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/resource
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/","title":"CertificateAndKey - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/#certificateandkey","title":"CertificateAndKey","text":"[jvm]\\ data class CertificateAndKey(val certificate: X509Certificate, val privateKey: PrivateKey)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/#constructors","title":"Constructors","text":"CertificateAndKey [jvm]constructor(certificate: X509Certificate, privateKey: PrivateKey)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/#properties","title":"Properties","text":"Name Summary certificate [jvm]val certificate: X509Certificate privateKey [jvm]val privateKey: PrivateKey"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/-certificate-and-key/","title":"CertificateAndKey - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey/CertificateAndKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/-certificate-and-key/#certificateandkey","title":"CertificateAndKey","text":"[jvm]\\ constructor(certificate: X509Certificate, privateKey: PrivateKey)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/certificate/","title":"certificate - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey/certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/certificate/#certificate","title":"certificate","text":"[jvm]\\ val certificate: X509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/private-key/","title":"privateKey - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey/privateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/private-key/#privatekey","title":"privateKey","text":"[jvm]\\ val privateKey: PrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/","title":"PemComboFile - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#pemcombofile","title":"PemComboFile","text":"[jvm]\\ data class PemComboFile(val certificates: List<ByteString>, val privateRsaKeys: List<ByteString>, val privateKeys: List<ByteString>, val passphrase: String)
A file containing a mix of PEM-encoded certificates and PEM-encoded private keys. Can be used both for trust stores (which certificate authorities a TLS client trusts) and also for TLS servers (which certificate chain a TLS server serves).
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#constructors","title":"Constructors","text":"PemComboFile [jvm]constructor(certificates: List<ByteString>, privateRsaKeys: List<ByteString>, privateKeys: List<ByteString>, passphrase: String)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#properties","title":"Properties","text":"Name Summary certificates [jvm]val certificates: List<ByteString> passphrase [jvm]val passphrase: String privateKeys [jvm]val privateKeys: List<ByteString> privateRsaKeys [jvm]val privateRsaKeys: List<ByteString>"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#functions","title":"Functions","text":"Name Summary decodeCertificates [jvm]fun decodeCertificates(): List<Certificate> newEmptyKeyStore [jvm]fun newEmptyKeyStore(): KeyStore"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-pem-combo-file/","title":"PemComboFile - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/PemComboFile
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-pem-combo-file/#pemcombofile","title":"PemComboFile","text":"[jvm]\\ constructor(certificates: List<ByteString>, privateRsaKeys: List<ByteString>, privateKeys: List<ByteString>, passphrase: String)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/certificates/","title":"certificates - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/certificates
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/certificates/#certificates","title":"certificates","text":"[jvm]\\ val certificates: List<ByteString>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/decode-certificates/","title":"decodeCertificates - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/decodeCertificates
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/decode-certificates/#decodecertificates","title":"decodeCertificates","text":"[jvm]\\ fun decodeCertificates(): List<Certificate>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/new-empty-key-store/","title":"newEmptyKeyStore - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/newEmptyKeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/new-empty-key-store/#newemptykeystore","title":"newEmptyKeyStore","text":"[jvm]\\ fun newEmptyKeyStore(): KeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/passphrase/","title":"passphrase - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/passphrase
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-keys/","title":"privateKeys - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/privateKeys
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-keys/#privatekeys","title":"privateKeys","text":"[jvm]\\ val privateKeys: List<ByteString>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-rsa-keys/","title":"privateRsaKeys - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/privateRsaKeys
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-rsa-keys/#privatersakeys","title":"privateRsaKeys","text":"[jvm]\\ val privateRsaKeys: List<ByteString>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/","title":"Companion - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/#functions","title":"Functions","text":"Name Summary convertPKCS1toPKCS8 [jvm]fun convertPKCS1toPKCS8(pkcs1Key: ByteString): KeySpec parse [jvm]fun parse(certKeyComboSource: BufferedSource, passphrase: String? = null): PemComboFile"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/convert-p-k-c-s1to-p-k-c-s8/","title":"convertPKCS1toPKCS8 - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/Companion/convertPKCS1toPKCS8
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/convert-p-k-c-s1to-p-k-c-s8/#convertpkcs1topkcs8","title":"convertPKCS1toPKCS8","text":"[jvm]\\ fun convertPKCS1toPKCS8(pkcs1Key: ByteString): KeySpec
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/parse/","title":"parse - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/Companion/parse
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(certKeyComboSource: BufferedSource, passphrase: String? = null): PemComboFile
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\ open class SslContextFactory(sslLoader: SslLoader)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/#constructors","title":"Constructors","text":"SslContextFactory [jvm]constructor(sslLoader: SslLoader)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsfun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext@JvmOverloadsfun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext loadTrustManagers [jvm]fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory/SslContextFactory
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\ constructor(sslLoader: SslLoader)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/create/","title":"create - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory/create
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/create/#create","title":"create","text":"[jvm]\\
@JvmOverloads
fun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext
@JvmOverloads
fun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/create/#return","title":"Return","text":"A new SSLContext for the given certstore and optional truststore config
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/load-trust-managers/","title":"loadTrustManagers - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory/loadTrustManagers
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/load-trust-managers/#loadtrustmanagers","title":"loadTrustManagers","text":"[jvm]\\ fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/load-trust-managers/#return","title":"Return","text":"a set of TrustManagers based on the certificates in the given truststore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/","title":"SslLoader - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#sslloader","title":"SslLoader","text":"[jvm]\\ open class SslLoader(resourceLoader: ResourceLoader)
Loads keys and certificates from the file system.
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#constructors","title":"Constructors","text":"SslLoader [jvm]constructor(resourceLoader: ResourceLoader)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#functions","title":"Functions","text":"Name Summary loadCertStore [jvm]fun loadCertStore(config: CertStoreConfig): CertStore?@JvmOverloadsfun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore? loadTrustStore [jvm]fun loadTrustStore(config: TrustStoreConfig): TrustStore?@JvmOverloadsfun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-ssl-loader/","title":"SslLoader - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/SslLoader
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-ssl-loader/#sslloader","title":"SslLoader","text":"[jvm]\\ constructor(resourceLoader: ResourceLoader)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-cert-store/","title":"loadCertStore - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/loadCertStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-cert-store/#loadcertstore","title":"loadCertStore","text":"[jvm]\\
@JvmOverloads
fun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore?
fun loadCertStore(config: CertStoreConfig): CertStore?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-trust-store/","title":"loadTrustStore - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/loadTrustStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-trust-store/#loadtruststore","title":"loadTrustStore","text":"[jvm]\\
@JvmOverloads
fun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?
fun loadTrustStore(config: TrustStoreConfig): TrustStore?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/","title":"Companion - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/#properties","title":"Properties","text":"Name Summary FORMAT_JCEKS [jvm]const val FORMAT_JCEKS: String FORMAT_JKS [jvm]const val FORMAT_JKS: String FORMAT_PEM [jvm]const val FORMAT_PEM: String FORMAT_PKCS12 [jvm]const val FORMAT_PKCS12: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/","title":"FORMAT_JCEKS - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_JCEKS
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/#format_jceks","title":"FORMAT_JCEKS","text":"[jvm]\\ const val FORMAT_JCEKS: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/","title":"FORMAT_JKS - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_JKS
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/#format_jks","title":"FORMAT_JKS","text":"[jvm]\\ const val FORMAT_JKS: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/","title":"FORMAT_PEM - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_PEM
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/#format_pem","title":"FORMAT_PEM","text":"[jvm]\\ const val FORMAT_PEM: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-k-c-s12/","title":"FORMAT_PKCS12 - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_PKCS12
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-k-c-s12/#format_pkcs12","title":"FORMAT_PKCS12","text":"[jvm]\\ const val FORMAT_PKCS12: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/","title":"TrustStore - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/#truststore","title":"TrustStore","text":"[jvm]\\ data class TrustStore(val keyStore: KeyStore)
A set of trusted root certificates.
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/#constructors","title":"Constructors","text":"TrustStore [jvm]constructor(keyStore: KeyStore)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/#properties","title":"Properties","text":"Name Summary keyStore [jvm]val keyStore: KeyStore"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/-trust-store/","title":"TrustStore - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStore/TrustStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/-trust-store/#truststore","title":"TrustStore","text":"[jvm]\\ constructor(keyStore: KeyStore)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/key-store/","title":"keyStore - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStore/keyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/key-store/#keystore","title":"keyStore","text":"[jvm]\\ val keyStore: KeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\ data class TrustStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/#constructors","title":"Constructors","text":"TrustStoreConfig [jvm]@JvmOverloadsconstructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/TrustStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\
@JvmOverloads
constructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/format/","title":"format - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/format
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/passphrase/","title":"passphrase - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/passphrase
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/resource/","title":"resource - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/resource
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/wisp-task/","title":"wisp-task - Misk","text":"//wisp-task
"},{"location":"0.x/wisp-task/#wisp-task","title":"wisp-task","text":""},{"location":"0.x/wisp-task/#packages","title":"Packages","text":"Name wisp.task wisp.task.exception"},{"location":"0.x/wisp-task/wisp-task/wisp.task/","title":"Package-level declarations - Misk","text":"//wisp-task/wisp.task
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-task/wisp-task/wisp.task/#types","title":"Types","text":"Name Summary RepeatedTask [jvm]class RepeatedTask@JvmOverloadsconstructor(val name: String, meterRegistry: MeterRegistry = Metrics.globalRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status)A RepeatedTask runs a repeated task at the user controlled rate. RepeatedTaskConfig [jvm]data class RepeatedTaskConfig@JvmOverloadsconstructor(val timeBetweenRunsMs: Long = 30000, val initialDelayMs: Long = 0, val defaultJitterMs: Long = 50, val defaultMaxDelayMs: Long = 60000) : Config RepeatedTaskManager [jvm]class RepeatedTaskManager@JvmOverloadsconstructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)Basic management of repeated tasks. RepeatedTaskMetrics [jvm]class RepeatedTaskMetrics(meterRegistry: MeterRegistry)Metrics for repeated tasks: Status [jvm]enum Status : Enum<Status> TaskConfig [jvm]open class TaskConfig : ConfigConfig to pass to the task. Extend this to pass in anything else your task may need."},{"location":"0.x/wisp-task/wisp-task/wisp.task/#properties","title":"Properties","text":"Name Summary defaultThrowableRetryPolicy [jvm]val defaultThrowableRetryPolicy: RetryPolicy<Throwable>By default, continue retrying"},{"location":"0.x/wisp-task/wisp-task/wisp.task/default-throwable-retry-policy/","title":"defaultThrowableRetryPolicy - Misk","text":"//wisp-task/wisp.task/defaultThrowableRetryPolicy
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/default-throwable-retry-policy/#defaultthrowableretrypolicy","title":"defaultThrowableRetryPolicy","text":"[jvm]\\ val defaultThrowableRetryPolicy: RetryPolicy<Throwable>
By default, continue retrying
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/","title":"RepeatedTask - Misk","text":"//wisp-task/wisp.task/RepeatedTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/#repeatedtask","title":"RepeatedTask","text":"[jvm]\\ class RepeatedTask@JvmOverloadsconstructor(val name: String, meterRegistry: MeterRegistry = Metrics.globalRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status)
A RepeatedTask runs a repeated task at the user controlled rate.
Tasks are called with a TaskConfig and are expected to return a Status or throw an exception. By default, the retry policy will try again if an exception is thrown and will apply a binaryExponentialBackoff using the supplied RepeatedTaskConfig. A Status.NO_WORK or Status.FAILED will be mapped to NoWorkForTaskException and FailedTaskException and thrown to apply the retry policy.
If the Status.NO_RESCHEDULE is returned, the RepeatedTask is shutdown.
Example usage:
val repeatedTask = RepeatedTask(\"task\") {\n // do task stuff...\n return Status.OK\n}\n\nrepeatedTask.startUp()\n//wisp-task/wisp.task/RepeatedTask/RepeatedTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/-repeated-task/#repeatedtask","title":"RepeatedTask","text":"[jvm]\\
@JvmOverloads
constructor(name: String, meterRegistry: MeterRegistry = Metrics.globalRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/is-running/","title":"isRunning - Misk","text":"//wisp-task/wisp.task/RepeatedTask/isRunning
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/is-running/#isrunning","title":"isRunning","text":"[jvm]\\ fun isRunning(): Boolean
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/name/","title":"name - Misk","text":"//wisp-task/wisp.task/RepeatedTask/name
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/shut-down/","title":"shutDown - Misk","text":"//wisp-task/wisp.task/RepeatedTask/shutDown
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/start-up/","title":"startUp - Misk","text":"//wisp-task/wisp.task/RepeatedTask/startUp
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/start-up/#startup","title":"startUp","text":"[jvm]\\ fun startUp()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/-companion/","title":"Companion - Misk","text":"//wisp-task/wisp.task/RepeatedTask/Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/","title":"RepeatedTaskConfig - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/#repeatedtaskconfig","title":"RepeatedTaskConfig","text":"[jvm]\\ data class RepeatedTaskConfig@JvmOverloadsconstructor(val timeBetweenRunsMs: Long = 30000, val initialDelayMs: Long = 0, val defaultJitterMs: Long = 50, val defaultMaxDelayMs: Long = 60000) : Config
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/#constructors","title":"Constructors","text":"RepeatedTaskConfig [jvm]@JvmOverloadsconstructor(timeBetweenRunsMs: Long = 30000, initialDelayMs: Long = 0, defaultJitterMs: Long = 50, defaultMaxDelayMs: Long = 60000)"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/#properties","title":"Properties","text":"Name Summary defaultJitterMs [jvm]val defaultJitterMs: Long = 50The default amount of jitter to use when scheduling backoffs. defaultMaxDelayMs [jvm]val defaultMaxDelayMs: Long = 60000The default maximum backoff time. initialDelayMs [jvm]val initialDelayMs: Long = 0Initial delay before starting the first task run, defaults to no delay, i.e. immediate start timeBetweenRunsMs [jvm]val timeBetweenRunsMs: Long = 30000Time between runs of tasks, set to 0 if immediately repeat task"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/-repeated-task-config/","title":"RepeatedTaskConfig - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/RepeatedTaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/-repeated-task-config/#repeatedtaskconfig","title":"RepeatedTaskConfig","text":"[jvm]\\
@JvmOverloads
constructor(timeBetweenRunsMs: Long = 30000, initialDelayMs: Long = 0, defaultJitterMs: Long = 50, defaultMaxDelayMs: Long = 60000)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-jitter-ms/","title":"defaultJitterMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/defaultJitterMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-jitter-ms/#defaultjitterms","title":"defaultJitterMs","text":"[jvm]\\ val defaultJitterMs: Long = 50
The default amount of jitter to use when scheduling backoffs.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-max-delay-ms/","title":"defaultMaxDelayMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/defaultMaxDelayMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-max-delay-ms/#defaultmaxdelayms","title":"defaultMaxDelayMs","text":"[jvm]\\ val defaultMaxDelayMs: Long = 60000
The default maximum backoff time.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/initial-delay-ms/","title":"initialDelayMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/initialDelayMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/initial-delay-ms/#initialdelayms","title":"initialDelayMs","text":"[jvm]\\ val initialDelayMs: Long = 0
Initial delay before starting the first task run, defaults to no delay, i.e. immediate start
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/time-between-runs-ms/","title":"timeBetweenRunsMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/timeBetweenRunsMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/time-between-runs-ms/#timebetweenrunsms","title":"timeBetweenRunsMs","text":"[jvm]\\ val timeBetweenRunsMs: Long = 30000
Time between runs of tasks, set to 0 if immediately repeat task
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/","title":"RepeatedTaskManager - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/#repeatedtaskmanager","title":"RepeatedTaskManager","text":"[jvm]\\ class RepeatedTaskManager@JvmOverloadsconstructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)
Basic management of repeated tasks.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/#constructors","title":"Constructors","text":"RepeatedTaskManager [jvm]@JvmOverloadsconstructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/#functions","title":"Functions","text":"Name Summary createTask [jvm]@JvmOverloadsfun createTask(name: String, meterRegistry: MeterRegistry = this.meterRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status): RepeatedTaskCreates the repeated task with the details supplied. If the repeated task already exists, a TaskAlreadyExistsException is thrown. getTask [jvm]fun getTask(taskName: String): RepeatedTask isTaskRunning [jvm]fun isTaskRunning(taskName: String): BooleanReturns true if a repeated task with the name supplied is running. If the task does not exist or is not running, return false. shutDown [jvm]fun shutDown() taskExists [jvm]fun taskExists(taskName: String): Boolean"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/-repeated-task-manager/","title":"RepeatedTaskManager - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/RepeatedTaskManager
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/-repeated-task-manager/#repeatedtaskmanager","title":"RepeatedTaskManager","text":"[jvm]\\
@JvmOverloads
constructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/create-task/","title":"createTask - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/createTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/create-task/#createtask","title":"createTask","text":"[jvm]\\
@JvmOverloads
fun createTask(name: String, meterRegistry: MeterRegistry = this.meterRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status): RepeatedTask
Creates the repeated task with the details supplied. If the repeated task already exists, a TaskAlreadyExistsException is thrown.
Does not start the task.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/get-task/","title":"getTask - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/getTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/get-task/#gettask","title":"getTask","text":"[jvm]\\ fun getTask(taskName: String): RepeatedTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/is-task-running/","title":"isTaskRunning - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/isTaskRunning
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/is-task-running/#istaskrunning","title":"isTaskRunning","text":"[jvm]\\ fun isTaskRunning(taskName: String): Boolean
Returns true if a repeated task with the name supplied is running. If the task does not exist or is not running, return false.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/shut-down/","title":"shutDown - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/shutDown
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/task-exists/","title":"taskExists - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/taskExists
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/task-exists/#taskexists","title":"taskExists","text":"[jvm]\\ fun taskExists(taskName: String): Boolean
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/","title":"RepeatedTaskMetrics - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/#repeatedtaskmetrics","title":"RepeatedTaskMetrics","text":"[jvm]\\ class RepeatedTaskMetrics(meterRegistry: MeterRegistry)
Metrics for repeated tasks:
Duration Success Count Failures Count Count of No Work Required
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/#constructors","title":"Constructors","text":"RepeatedTaskMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-repeated-task-metrics/","title":"RepeatedTaskMetrics - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/RepeatedTaskMetrics
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-repeated-task-metrics/#repeatedtaskmetrics","title":"RepeatedTaskMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/","title":"Companion - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/#properties","title":"Properties","text":"Name Summary DURATION_SUMMARY_NAME [jvm]const val DURATION_SUMMARY_NAME: String FAILED_COUNTER_NAME [jvm]const val FAILED_COUNTER_NAME: String NO_WORK_COUNTER_NAME [jvm]const val NO_WORK_COUNTER_NAME: String SUCCESS_COUNTER_NAME [jvm]const val SUCCESS_COUNTER_NAME: String"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-d-u-r-a-t-i-o-n_-s-u-m-m-a-r-y_-n-a-m-e/","title":"DURATION_SUMMARY_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/DURATION_SUMMARY_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-d-u-r-a-t-i-o-n_-s-u-m-m-a-r-y_-n-a-m-e/#duration_summary_name","title":"DURATION_SUMMARY_NAME","text":"[jvm]\\ const val DURATION_SUMMARY_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/","title":"FAILED_COUNTER_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/FAILED_COUNTER_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/#failed_counter_name","title":"FAILED_COUNTER_NAME","text":"[jvm]\\ const val FAILED_COUNTER_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-n-o_-w-o-r-k_-c-o-u-n-t-e-r_-n-a-m-e/","title":"NO_WORK_COUNTER_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/NO_WORK_COUNTER_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-n-o_-w-o-r-k_-c-o-u-n-t-e-r_-n-a-m-e/#no_work_counter_name","title":"NO_WORK_COUNTER_NAME","text":"[jvm]\\ const val NO_WORK_COUNTER_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/","title":"SUCCESS_COUNTER_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/SUCCESS_COUNTER_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/#success_counter_name","title":"SUCCESS_COUNTER_NAME","text":"[jvm]\\ const val SUCCESS_COUNTER_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/","title":"Status - Misk","text":"//wisp-task/wisp.task/Status
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#status","title":"Status","text":"[jvm]\\ enum Status : Enum<Status>
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#entries","title":"Entries","text":"OK [jvm]OKThe task completed successfully and processed work NO_WORK [jvm]NO_WORKThe task had no work to complete FAILED [jvm]FAILEDThe task resulted in an error NO_RESCHEDULE [jvm]NO_RESCHEDULEThe task should not be rescheduled"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Status>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored. valueOf [jvm]fun valueOf(value: String): StatusReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Status>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/entries/","title":"entries - Misk","text":"//wisp-task/wisp.task/Status/entries
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Status>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/metric-label/","title":"metricLabel - Misk","text":"//wisp-task/wisp.task/Status/metricLabel
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/metric-label/#metriclabel","title":"metricLabel","text":"[jvm]\\ fun metricLabel(): String
The metric label for the status. This is used instead of name() in case the code is refactored.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/value-of/","title":"valueOf - Misk","text":"//wisp-task/wisp.task/Status/valueOf
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Status
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/values/","title":"values - Misk","text":"//wisp-task/wisp.task/Status/values
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Status>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/","title":"FAILED - Misk","text":"//wisp-task/wisp.task/Status/FAILED
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/#failed","title":"FAILED","text":"[jvm]\\ FAILED
The task resulted in an error
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/","title":"NO_RESCHEDULE - Misk","text":"//wisp-task/wisp.task/Status/NO_RESCHEDULE
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#no_reschedule","title":"NO_RESCHEDULE","text":"[jvm]\\ NO_RESCHEDULE
The task should not be rescheduled
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/","title":"NO_WORK - Misk","text":"//wisp-task/wisp.task/Status/NO_WORK
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/#no_work","title":"NO_WORK","text":"[jvm]\\ NO_WORK
The task had no work to complete
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/","title":"OK - Misk","text":"//wisp-task/wisp.task/Status/OK
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/#ok","title":"OK","text":"[jvm]\\ OK
The task completed successfully and processed work
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/","title":"TaskConfig - Misk","text":"//wisp-task/wisp.task/TaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/#taskconfig","title":"TaskConfig","text":"[jvm]\\ open class TaskConfig : Config
Config to pass to the task. Extend this to pass in anything else your task may need.
Note that this extends Config, so you can load your task\u2019s config if required.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/#constructors","title":"Constructors","text":"TaskConfig [jvm]constructor()"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/-task-config/","title":"TaskConfig - Misk","text":"//wisp-task/wisp.task/TaskConfig/TaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/-task-config/#taskconfig","title":"TaskConfig","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/","title":"Package-level declarations - Misk","text":"//wisp-task/wisp.task.exception
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/#types","title":"Types","text":"Name Summary FailedTaskException [jvm]class FailedTaskException : ExceptionCan be thrown by a task to indicate it has failed. NoTaskFoundException [jvm]class NoTaskFoundException(taskName: String) : ExceptionThrown if an attempt to retrieve a non-existent RepeatedTask. NoWorkForTaskException [jvm]class NoWorkForTaskException : ExceptionCan be thrown by a task to indicate it has no work to do at this time. TaskAlreadyExistsException [jvm]class TaskAlreadyExistsException(taskName: String) : ExceptionThrown if an attempt to create a RepeatedTask that already exists with the name supplied."},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/","title":"FailedTaskException - Misk","text":"//wisp-task/wisp.task.exception/FailedTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#failedtaskexception","title":"FailedTaskException","text":"[jvm]\\ class FailedTaskException : Exception
Can be thrown by a task to indicate it has failed.
If a task returns Status.FAILED, it is mapped to this exception and thrown.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#constructors","title":"Constructors","text":"FailedTaskException [jvm]constructor()"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/-failed-task-exception/","title":"FailedTaskException - Misk","text":"//wisp-task/wisp.task.exception/FailedTaskException/FailedTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/-failed-task-exception/#failedtaskexception","title":"FailedTaskException","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/","title":"NoTaskFoundException - Misk","text":"//wisp-task/wisp.task.exception/NoTaskFoundException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#notaskfoundexception","title":"NoTaskFoundException","text":"[jvm]\\ class NoTaskFoundException(taskName: String) : Exception
Thrown if an attempt to retrieve a non-existent RepeatedTask.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#constructors","title":"Constructors","text":"NoTaskFoundException [jvm]constructor(taskName: String)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/-no-task-found-exception/","title":"NoTaskFoundException - Misk","text":"//wisp-task/wisp.task.exception/NoTaskFoundException/NoTaskFoundException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/-no-task-found-exception/#notaskfoundexception","title":"NoTaskFoundException","text":"[jvm]\\ constructor(taskName: String)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/","title":"NoWorkForTaskException - Misk","text":"//wisp-task/wisp.task.exception/NoWorkForTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#noworkfortaskexception","title":"NoWorkForTaskException","text":"[jvm]\\ class NoWorkForTaskException : Exception
Can be thrown by a task to indicate it has no work to do at this time.
If a task returns Status.NO_WORK, it is mapped to this exception and thrown.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#constructors","title":"Constructors","text":"NoWorkForTaskException [jvm]constructor()"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/-no-work-for-task-exception/","title":"NoWorkForTaskException - Misk","text":"//wisp-task/wisp.task.exception/NoWorkForTaskException/NoWorkForTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/-no-work-for-task-exception/#noworkfortaskexception","title":"NoWorkForTaskException","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/","title":"TaskAlreadyExistsException - Misk","text":"//wisp-task/wisp.task.exception/TaskAlreadyExistsException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#taskalreadyexistsexception","title":"TaskAlreadyExistsException","text":"[jvm]\\ class TaskAlreadyExistsException(taskName: String) : Exception
Thrown if an attempt to create a RepeatedTask that already exists with the name supplied.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#constructors","title":"Constructors","text":"TaskAlreadyExistsException [jvm]constructor(taskName: String)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/-task-already-exists-exception/","title":"TaskAlreadyExistsException - Misk","text":"//wisp-task/wisp.task.exception/TaskAlreadyExistsException/TaskAlreadyExistsException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/-task-already-exists-exception/#taskalreadyexistsexception","title":"TaskAlreadyExistsException","text":"[jvm]\\ constructor(taskName: String)
"},{"location":"0.x/wisp-time-testing/","title":"wisp-time-testing - Misk","text":"//wisp-time-testing
"},{"location":"0.x/wisp-time-testing/#wisp-time-testing","title":"wisp-time-testing","text":""},{"location":"0.x/wisp-time-testing/#packages","title":"Packages","text":"Name wisp.time"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/","title":"Package-level declarations - Misk","text":"//wisp-time-testing/wisp.time
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/#types","title":"Types","text":"Name Summary FakeClock [jvm]open class FakeClock@JvmOverloadsconstructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\")) : Clock, TestFixtureControllable clock for testing."},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/","title":"FakeClock - Misk","text":"//wisp-time-testing/wisp.time/FakeClock
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\ open class FakeClock@JvmOverloadsconstructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\")) : Clock, TestFixture
Controllable clock for testing.
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#constructors","title":"Constructors","text":"FakeClock [jvm]@JvmOverloadsconstructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\"))"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(d: Duration): LongAdvance the clock by specified Duration.[jvm]fun add(p: Period): LongAdvance the clock by the specified Period. Note that unlike adding a Duration the exact amount that is added to the clock will depend on its current time and timezone. Not all days, months or years have the same length. See the documentation for Period.[jvm]fun add(n: Long, unit: TimeUnit): LongAdvance the clock by specified amountn of TimeUnit. equals [jvm]open operator override fun equals(other: Any?): Boolean getZone [jvm]open override fun getZone(): ZoneId hashCode [jvm]open override fun hashCode(): Int instant [jvm]open override fun instant(): Instant millis [jvm]open override fun millis(): Long reset [jvm]open override fun reset() setNow [jvm]fun setNow(instant: Instant)Set the clock to the specified Instant. withZone [jvm]open override fun withZone(zone: ZoneId): Clock"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-fake-clock/","title":"FakeClock - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/FakeClock
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\
@JvmOverloads
constructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\"))
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/add/","title":"add - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/add
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/add/#add","title":"add","text":"[jvm]\\ fun add(d: Duration): Long
Advance the clock by specified Duration.
[jvm]\\ fun add(p: Period): Long
Advance the clock by the specified Period. Note that unlike adding a Duration the exact amount that is added to the clock will depend on its current time and timezone. Not all days, months or years have the same length. See the documentation for Period.
[jvm]\\ fun add(n: Long, unit: TimeUnit): Long
Advance the clock by specified amount n of TimeUnit.
//wisp-time-testing/wisp.time/FakeClock/getZone
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/get-zone/#getzone","title":"getZone","text":"[jvm]\\ open override fun getZone(): ZoneId
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/instant/","title":"instant - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/instant
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/instant/#instant","title":"instant","text":"[jvm]\\ open override fun instant(): Instant
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/reset/","title":"reset - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/reset
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/set-now/","title":"setNow - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/setNow
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/set-now/#setnow","title":"setNow","text":"[jvm]\\ fun setNow(instant: Instant)
Set the clock to the specified Instant.
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/with-zone/","title":"withZone - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/withZone
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/with-zone/#withzone","title":"withZone","text":"[jvm]\\ open override fun withZone(zone: ZoneId): Clock
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-companion/","title":"Companion - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/Companion
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-token/","title":"wisp-token - Misk","text":"//wisp-token
"},{"location":"0.x/wisp-token/#wisp-token","title":"wisp-token","text":""},{"location":"0.x/wisp-token/#packages","title":"Packages","text":"Name wisp.token"},{"location":"0.x/wisp-token/wisp-token/wisp.token/","title":"Package-level declarations - Misk","text":"//wisp-token/wisp.token
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-token/wisp-token/wisp.token/#types","title":"Types","text":"Name Summary RealTokenGenerator [jvm]class RealTokenGenerator : TokenGenerator TokenGenerator [jvm]interface TokenGeneratorGenerates an secure, unguessable, alphanumeric token for use as a universally unique ID. Tokens are encoded with a https://www.crockford.com/wrmg/base32.html. This alphabet contains a mix of lowercase characters and digits and is resistant to decoding errors; for example0, o, and \u2018O\u2019 are equivalent."},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//wisp-token/wisp.token/RealTokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\ class RealTokenGenerator : TokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/#constructors","title":"Constructors","text":"RealTokenGenerator [jvm]constructor()"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//wisp-token/wisp.token/RealTokenGenerator/RealTokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/generate/","title":"generate - Misk","text":"//wisp-token/wisp.token/RealTokenGenerator/generate
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/","title":"TokenGenerator - Misk","text":"//wisp-token/wisp.token/TokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/#tokengenerator","title":"TokenGenerator","text":"interface TokenGenerator
Generates an secure, unguessable, alphanumeric token for use as a universally unique ID. Tokens are encoded with a https://www.crockford.com/wrmg/base32.html. This alphabet contains a mix of lowercase characters and digits and is resistant to decoding errors; for example 0, o, and \u2018O\u2019 are equivalent.
For strength similar to a random UUID (122 bits of entropy), most callers should use the default length of 25 characters (125 bits). Using fewer characters risks collision, which may be acceptable for some use-cases. There is no practical benefit to using more than 25 characters.
In production, staging, and development environments tokens are always created using SecureRandom. These are some sample production tokens:
75dsma7kscyvbgz7ea1yy3qe8\n3zg6svk9hcpvqyhej41tdkaa0\ngv7s8nkevt9d7aw2eb06g640e\na17f7h6t853kzdqpc29qa8mnw\nIn tests tokens are sequential and predictable. They are prefixed with an optional label that appears in the returned string and can be used as a namespace. It is okay to hardcode expected tokens in test cases! These are some sample testing tokens:
cst0mer000000000000000035\npayment000000000000000034\ncst0mer000000000000000036\npayment000000000000000035\n//wisp-token/wisp.token/TokenGenerator/generate
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/generate/#generate","title":"generate","text":"[jvm]\\ abstract fun generate(label: String? = null, length: Int = 25): String
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/","title":"Companion - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/#properties","title":"Properties","text":"Name Summary CANONICALIZE_LENGTH_MAX [jvm]const val CANONICALIZE_LENGTH_MAX: Int = 25 CANONICALIZE_LENGTH_MIN [jvm]const val CANONICALIZE_LENGTH_MIN: Int = 4"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/#functions","title":"Functions","text":"Name Summary canonicalize [jvm]fun canonicalize(token: String): StringReturns a token semantically equal totoken but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted."},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-a-x/","title":"CANONICALIZE_LENGTH_MAX - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion/CANONICALIZE_LENGTH_MAX
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-a-x/#canonicalize_length_max","title":"CANONICALIZE_LENGTH_MAX","text":"[jvm]\\ const val CANONICALIZE_LENGTH_MAX: Int = 25
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-i-n/","title":"CANONICALIZE_LENGTH_MIN - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion/CANONICALIZE_LENGTH_MIN
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-i-n/#canonicalize_length_min","title":"CANONICALIZE_LENGTH_MIN","text":"[jvm]\\ const val CANONICALIZE_LENGTH_MIN: Int = 4
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/canonicalize/","title":"canonicalize - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion/canonicalize
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/canonicalize/#canonicalize","title":"canonicalize","text":"[jvm]\\ fun canonicalize(token: String): String
Returns a token semantically equal to token but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted.
Call this when accepting tokens that may have been transcribed by a user. It is not necessary to canonicalize tokens that haven\u2019t been manually entered; they will already be in canonical form.
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/canonicalize/#throws","title":"Throws","text":"IllegalArgumentException iftoken contains a character that cannot be mapped and that is not a space."},{"location":"0.x/wisp-token-testing/","title":"wisp-token-testing - Misk","text":"//wisp-token-testing
"},{"location":"0.x/wisp-token-testing/#wisp-token-testing","title":"wisp-token-testing","text":""},{"location":"0.x/wisp-token-testing/#packages","title":"Packages","text":"Name wisp.token"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/","title":"Package-level declarations - Misk","text":"//wisp-token-testing/wisp.token
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/#types","title":"Types","text":"Name Summary FakeTokenGenerator [jvm]class FakeTokenGenerator : TokenGenerator"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//wisp-token-testing/wisp.token/FakeTokenGenerator
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\ class FakeTokenGenerator : TokenGenerator
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/#constructors","title":"Constructors","text":"FakeTokenGenerator [jvm]constructor()"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//wisp-token-testing/wisp.token/FakeTokenGenerator/FakeTokenGenerator
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/generate/","title":"generate - Misk","text":"//wisp-token-testing/wisp.token/FakeTokenGenerator/generate
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/wisp-tracing/","title":"wisp-tracing - Misk","text":"//wisp-tracing
"},{"location":"0.x/wisp-tracing/#wisp-tracing","title":"wisp-tracing","text":""},{"location":"0.x/wisp-tracing/#packages","title":"Packages","text":"Name wisp.tracing"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/","title":"Package-level declarations - Misk","text":"//wisp-tracing/wisp.tracing
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/#types","title":"Types","text":"Name Summary SpanAndScope [jvm]data class SpanAndScope(val span: Span, val scope: Scope) Tag [jvm]data class Tag<T>(val name: String, val value: T)A Tag is a name-value pair which will be added to a Span. Only primitive types are supported like Booleans, Numbers, and Strings."},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/#functions","title":"Functions","text":"Name Summary setBaggageItems [jvm]fun Span.setBaggageItems(baggage: Map<String, Any>)Conveniently sets baggage items all at once. Baggage values come from Any.toString. setTag [jvm]fun Span.setTag(tag: Tag<*>) setTags [jvm]fun Span.setTags(tags: Collection<Tag<*>>)Conveniently set tags all at once. trace [jvm]fun <T> Tracer.trace(spanName: String, tags: Map<String, String> = mapOf(), f: () -> T): TTraces a function f, using a span called spanName, which is automatically finished when the function completes execution. traceWithNewRootSpan [jvm]fun <T> Tracer.traceWithNewRootSpan(spanName: String, tags: Map<String, String> = mapOf(), retainBaggage: Boolean = false, f: (Span) -> T): TLike traceWithSpan, but always starts a new independent (root) span. If you\u2019d like to continue propagating baggage that was set on the previous active span, set retainBaggage to true. traceWithSpan [jvm]fun <T> Tracer.traceWithSpan(spanName: String, tags: Map<String, String> = mapOf(), f: (Span) -> T): TLike trace, but exposes the new active Span to f. withNewScope [jvm]inline fun <T> Tracer.withNewScope(span: Span, crossinline f: () -> T): TInstruments a function f with a new scope. This is helpful if you need to create a new Scope for an existing Span, for example, if you are switching threads (since Scopes are not thread-safe)."},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-baggage-items/","title":"setBaggageItems - Misk","text":"//wisp-tracing/wisp.tracing/setBaggageItems
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-baggage-items/#setbaggageitems","title":"setBaggageItems","text":"[jvm]\\ fun Span.setBaggageItems(baggage: Map<String, Any>)
Conveniently sets baggage items all at once. Baggage values come from Any.toString.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tag/","title":"setTag - Misk","text":"//wisp-tracing/wisp.tracing/setTag
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tag/#settag","title":"setTag","text":"[jvm]\\ fun Span.setTag(tag: Tag<*>)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tags/","title":"setTags - Misk","text":"//wisp-tracing/wisp.tracing/setTags
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tags/#settags","title":"setTags","text":"[jvm]\\ fun Span.setTags(tags: Collection<Tag<*>>)
Conveniently set tags all at once.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-new-root-span/","title":"traceWithNewRootSpan - Misk","text":"//wisp-tracing/wisp.tracing/traceWithNewRootSpan
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-new-root-span/#tracewithnewrootspan","title":"traceWithNewRootSpan","text":"[jvm]\\ fun <T> Tracer.traceWithNewRootSpan(spanName: String, tags: Map<String, String> = mapOf(), retainBaggage: Boolean = false, f: (Span) -> T): T
Like traceWithSpan, but always starts a new independent (root) span. If you\u2019d like to continue propagating baggage that was set on the previous active span, set retainBaggage to true.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-span/","title":"traceWithSpan - Misk","text":"//wisp-tracing/wisp.tracing/traceWithSpan
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-span/#tracewithspan","title":"traceWithSpan","text":"[jvm]\\ fun <T> Tracer.traceWithSpan(spanName: String, tags: Map<String, String> = mapOf(), f: (Span) -> T): T
Like trace, but exposes the new active Span to f.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace/","title":"trace - Misk","text":"//wisp-tracing/wisp.tracing/trace
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace/#trace","title":"trace","text":"[jvm]\\ fun <T> Tracer.trace(spanName: String, tags: Map<String, String> = mapOf(), f: () -> T): T
Traces a function f, using a span called spanName, which is automatically finished when the function completes execution.
If a span is already active, the new span is made a child of the existing one. If you want to manipulate the Span (e.g. to attach baggage), use traceWithSpan instead.
If you want a new independent span, use traceWithNewRootSpan.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/with-new-scope/","title":"withNewScope - Misk","text":"//wisp-tracing/wisp.tracing/withNewScope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/with-new-scope/#withnewscope","title":"withNewScope","text":"[jvm]\\ inline fun <T> Tracer.withNewScope(span: Span, crossinline f: () -> T): T
Instruments a function f with a new scope. This is helpful if you need to create a new Scope for an existing Span, for example, if you are switching threads (since Scopes are not thread-safe).
tracer.traceWithSpan(\"thread-switching-span\") {\n ...\n thread {\n tracer.withNewScope(span) { ... }\n }\n}\n//wisp-tracing/wisp.tracing/SpanAndScope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/#spanandscope","title":"SpanAndScope","text":"[jvm]\\ data class SpanAndScope(val span: Span, val scope: Scope)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/#constructors","title":"Constructors","text":"SpanAndScope [jvm]constructor(span: Span, scope: Scope)"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/#properties","title":"Properties","text":"Name Summary scope [jvm]val scope: Scope span [jvm]val span: Span"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/-span-and-scope/","title":"SpanAndScope - Misk","text":"//wisp-tracing/wisp.tracing/SpanAndScope/SpanAndScope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/-span-and-scope/#spanandscope","title":"SpanAndScope","text":"[jvm]\\ constructor(span: Span, scope: Scope)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/scope/","title":"scope - Misk","text":"//wisp-tracing/wisp.tracing/SpanAndScope/scope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/scope/#scope","title":"scope","text":"[jvm]\\ val scope: Scope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/span/","title":"span - Misk","text":"//wisp-tracing/wisp.tracing/SpanAndScope/span
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/span/#span","title":"span","text":"[jvm]\\ val span: Span
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/","title":"Tag - Misk","text":"//wisp-tracing/wisp.tracing/Tag
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/#tag","title":"Tag","text":"[jvm]\\ data class Tag<T>(val name: String, val value: T)
A Tag is a name-value pair which will be added to a Span. Only primitive types are supported like Booleans, Numbers, and Strings.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/#constructors","title":"Constructors","text":"Tag [jvm]constructor(name: String, value: T)"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String value [jvm]val value: T"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/-tag/","title":"Tag - Misk","text":"//wisp-tracing/wisp.tracing/Tag/Tag
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/-tag/#tag","title":"Tag","text":"[jvm]\\ constructor(name: String, value: T)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/name/","title":"name - Misk","text":"//wisp-tracing/wisp.tracing/Tag/name
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/value/","title":"value - Misk","text":"//wisp-tracing/wisp.tracing/Tag/value
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/value/#value","title":"value","text":"[jvm]\\ val value: T
"},{"location":"internals/graceful-shutdown/","title":"Shutdown Management","text":"In any application it is important to shut down gracefully, to avoid dropping already accepted work or creating inconsistent state. Misk handles this through use of a special ReadyService and its Service Manager Module
Misk ensures a graceful shutdown by dividing services into those that ingest or create work (e.g. SQS, Cron, Jetty), and those that are needed to process work (e.g. JDBC, Redis). To ensure the work created by an incoming API request, SQS subscription, cron job, or other work producing service is handled correctly even during shutdown, these services need
Because Misk cannot know ahead of time which services an application might or might not need, we cannot create hard dependencies from these work producing services to the various services needed for work processing. Instead, we configure the work producing services to depend on - and services needed for work processing to be enhanced by - the ReadyService, a special service that does no work but exists only to orchestrate a graceful shutdown.
By having work producing services depend on the ReadyService and work processing services enhanced by it, Misk will guarantee that services startup as follows:
ReadyServiceAt shutdown time, we walk the dependency graph in reverse, shutting down services as follows:
ReadyServiceThis ensures services that are needed for work processing remain up until all ingested work has been processed.
"},{"location":"internals/graceful-shutdown/#notes","title":"Notes","text":"Services in Misk can depend on other services. We need to reconcile these dependencies to ensure an orderly application startup and shutdown.
In the Misk framework, a service represents a component that starts and stops in coordination with the application\u2019s lifecycle. Services in Misk are typically used to manage tasks such as database connections, HTTP servers, or other long-running processes. They ensure that resources are correctly initialized when the application starts and properly released when it stops. Misk uses Google\u2019s Guava ServiceManager to handle these services, allowing for graceful startup, shutdown, and dependency management between different services.
"},{"location":"internals/service-management/#dependencies","title":"Dependencies","text":"Suppose we have a DatabaseService and a MovieService, with the MovieService depending on the DatabaseService.
DatabaseService\n depended on by MovieService\nWhen you install a service via this module, start-up and shut-down of its dependencies are handled automatically, so that a service can only run when the services it depends on are running. In the example above, the MovieService doesn\u2019t enter the STARTING state until the DatabaseService has entered the RUNNING state. Conversely, the MovieService must enter the TERMINATED state before the DatabaseService enters the STOPPING state.
Dependencies can have their own dependencies, so there\u2019s an entire graph to manage of what starts and stops when.
"},{"location":"internals/service-management/#enhancements","title":"Enhancements","text":"Some services exist to enhance the behavior of another service.
For example, a DatabaseService may manage a generic connection to a MySQL database, and the SchemaMigrationService may create tables specific to the application.
We treat such enhancements as implementation details of the enhanced service: they depend on the service, but downstream dependencies like the MovieService don\u2019t need to know that they exist.
DatabaseService\n enhanced by SchemaMigrationService\n depended on by MovieService\nIn the above service graph we start the DatabaseService first, the SchemaMigrationService second, and finally the MovieService. The MovieService doesn\u2019t need to express a dependency on the SchemaMigrationService, that happens automatically for enhancements.
This is a symbolic service that\u2019s useful to define the relationship, generally, between services which process traffic (i.e. Jetty) and infrastructure services (i.e. persistence stores).
By having the former depend on ReadyService and the latter enhanced by ReadyService we can force, for example, JettyService to stop before our feature flag service without having to intertwine our dependency graph.
In general, infrastructure services should enhance ReadyService and application services should depend on ReadyService.
See more information here here.
"},{"location":"internals/service-management/#what-does-this-look-like","title":"What does this look like?","text":""},{"location":"internals/service-management/#configuration","title":"Configuration","text":"Instead of using the regular service multi-bindings you might be used to, in the configure block of a Guice [KAbstractModule], you would set up the above relationship as follows:
override fun configure() {\n install(ServiceModule<SchemaMigrationService())\n install(\n ServiceModule<DatabaseService>()\n .enhancedBy<SchemaMigrationService>()\n )\n install(\n ServiceModule<MoviesService>()\n .dependsOn<DatabaseService>()\n )\n}\nBindings are hooked up for a ServiceManager provider, which decorates the service with its dependencies and enhancements to defer its start up and shut down until its dependent services are ready.
This service will stall in the STARTING state until all upstream services are RUNNING. Symmetrically it stalls in the STOPPING state until all dependent services are TERMINATED.
ServiceModule classTo migrate from Misk Metrics v1 to v2, please apply the following openrewrite recipe:
type: specs.openrewrite.org/v1beta/recipe\nname: misk.metrics.Migrator\ndisplayName: Migrate Misk Metrics V1\ndescription: Migrate from Misk Metrics v1 to v2\nrecipeList:\n - org.openrewrite.java.ChangeMethodName:\n methodPattern: misk.metrics.Metrics histogram(..)\n newMethodName: legacyHistogram\n matchOverrides: true\n - org.openrewrite.java.ChangeType:\n oldFullyQualifiedTypeName: misk.metrics.Metrics\n newFullyQualifiedTypeName: misk.metrics.v2.Metrics\nWisp is a collection of Misk modules providing various features and utilities, including config, logging, feature flags and more, but notably implemented generally without the use of Guice Direct Injection.
"},{"location":"wisp/#modules","title":"Modules","text":"Modules that are named ending in \u201cTesting\u201d are for test code and should never be used or included in production code.
For AWS information from the environment, with easy means for overrides for testing. Currently supports AWS Region and Account ID information.
Also see wisp-deployment-testing for the FakeEnvironmentVariableLoader to use in tests to set Fake environment variables.
"},{"location":"wisp/wisp-aws-environment/#usage","title":"Usage","text":"By default, the AWS Region will be read from either \u201cREGION\u201d or \u201cAWS_REGION\u201d environment variables.
val awsRegion: AwsRegion = AwsEnvironment.awsRegion() \nBy default, the AWS Account ID will be read from the \u201cACCOUNT_ID\u201d environment variable.
val awsAccountId: AccountId = AwsEnvironment.awsAccountId()\nUsing your own custom environment variables
val awsRegion: AwsRegion = AwsEnvironment.awsRegion(environmentVariables = listOf(\"MY_REGION_ENV_VAR\"))\nval awsAccountId: AccountId = AwsEnvironment.awsAccountId(environmentVariable = \"MY_ACCOUNT_ID_ENV_VAR\")\nDefault fallback for the AWS Region if the environment variable(s) are not set
val awsRegion: AwsRegion = AwsEnvironment.awsRegion(defaultAwsRegion = \"us-west-2\") \nHTTP clients with support for Envoy.
"},{"location":"wisp/wisp-client/src/main/java/wisp/client/","title":"Index","text":"We include java classes here as they\u2019re direct copies from okhttp\u2019s samples. These were taken from https://github.com/square/okhttp/tree/main/samples/unixdomainMaps/src/main/java/okhttp3/unixdomainsockets .
"},{"location":"wisp/wisp-config/","title":"wisp-config","text":"wisp-config is a wrapper for the Hoplite config library.
Config precedence is in order of sources added for loading, so if you want an environment config file to override values in the default file, it has to be added first.
Note that config values from Environment Variables, System Properties and User Settings are always loaded first, see: https://github.com/sksamuel/hoplite#property-sources for details.
Secrets in config are automatically handled, see: https://github.com/sksamuel/hoplite#masked-values
Note that if you are passing configuration fragments within Wisp, your config class should implement Config.
"},{"location":"wisp/wisp-config/#usage","title":"Usage","text":"The following example will load the config in the 2 files located on the classpath into the user defined MyConfig class.
data class MyConfig(\n val foo: Foo,\n val baz: String\n) : Config\n\ndata class Foo(\n val enabled: Boolean,\n val bar: Int\n)\n\nval configSources = listOf(\n ConfigSource(\"classpath:/myapp-config.yaml\"),\n ConfigSource(\"classpath:/myapp-defaults.yml\")\n)\nval myConfig : MyConfig = WispConfig.builder()\n .addWispConfigSources(configSources)\n .build()\n .loadConfigOrThrow<MyConfig>()\nAssume myapp-defaults.yml contains:
foo:\n enabled: true\n bar: 72\nbaz: \"abc\"\nAnd myapp-config.yaml contains:
foo:\n enabled: false\nThen the loaded MyConfig from the example above would be equivalent to:
val myConfig : MyConfig = MyConfig(\n foo = Foo(\n enabled = false,\n bar = 72\n ),\n baz = \"abc\"\n)\nCreate, start and stop containers for use in tests.
"},{"location":"wisp/wisp-containers-testing/#usage","title":"Usage","text":"The following example creates the \u201calpine\u201d container, starts and stops it.
val container = Container {\n withImage(\"alpine\")\n withName(\"alpine\")\n}\n\nval composer = Composer(\"alpine\", container)\ncomposer.start()\nassertTrue(composer.running.get())\ncomposer.stop()\nassertFalse(composer.running.get())\nThe following example composes Kafka and Zookeeper containers for testing. Kafka is exposed to the jUnit test via 127.0.0.1:9102. In this example, Zookeeper is not exposed to the test.
val zkContainer = Container {\n withImage(\"confluentinc/cp-zookeeper\")\n withName(\"zookeeper\")\n withEnv(\"ZOOKEEPER_CLIENT_PORT=2181\")\n}\nval kafka = Container {\n withImage(\"confluentinc/cp-kafka\")\n withName(\"kafka\")\n withExposedPorts(ExposedPort.tcp(port))\n withPortBindings(\n Ports().apply {\n bind(ExposedPort.tcp(9102), Ports.Binding.bindPort(9102))\n }\n )\n withEnv(\n \"KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181\",\n \"KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9102\"\n )\n}\nval composer = Composer(\"e-kafka\", zkContainer, kafka)\ncomposer.start()\nThis module provides information about the applications deployment and environment.
Deployment contains information on where the application is deployed, that is, in Production, Staging, Testing or Development environments.
Deployments can be created manually, or by examining an environment variable (default environment variable is ENVIRONMENT).
Also see wisp-deployment-testing for the FakeEnvironmentVariableLoader to use in tests to set Fake environment variables.
"},{"location":"wisp/wisp-deployment/#usage","title":"Usage","text":"The following manually creates a production Deployment
val deployment: Deployment = Deployment(\n \"My Deployment Name\",\n isProduction = true,\n isStaging = false,\n isTest = false,\n isLocalDevelopment = false\n)\nThere are 4 preset deployments: PRODUCTION, STAGING, TESTING and DEVELOPMENT. One of these will be returned if creating a deployment from the environment variable, with a default of DEVELOPMENT if the environment variable is not set.
val deployment: Deployment = Deployment.getDeploymentFromEnvironmentVariable()\n\nif (deployment.isProduction) {\n // this path will be executed\n}\n\nif (deployment.isDevelopment) {\n // this path will not be executed\n}\nFor testing, to set a specific Deployment, you can either create it manually, or override the environment variable using a FakeEnvironmentVariableLoader.
val environmentVariableLoader: FakeEnvironmentVariableLoader = \n FakeEnvironmentVariableLoader(mutableMapOf(\"ENVIRONMENT\" to \"Staging\"))\n\nval deployment = getDeploymentFromEnvironmentVariable(\n environmentVariableLoader = environmentVariableLoader\n)\n\nif (deployment.isStaging) {\n // this path will be executed\n}\nThis module provides a FakeEnvironmentVariableLoader as an implementation of the EnvironmentVariableLoader to use in tests to set Fake environment variables. Ideally, you should not use this package in any production code, but for test purposes only.
Also see wisp-deployment.
"},{"location":"wisp/wisp-deployment-testing/#usage","title":"Usage","text":"val environmentVariableLoader: FakeEnvironmentVariableLoader = \n FakeEnvironmentVariableLoader(\n mutableMapOf(\n \"ENVIRONMENT\" to \"Staging\",\n \"FOO\" to \"Bar\"\n )\n )\n\nval deployment = getDeploymentFromEnvironmentVariable(\n environmentVariableLoader = environmentVariableLoader\n)\n\nif (deployment.isStaging) {\n // this path will be executed\n}\n\n// foo will be \"Bar\"\nval foo = environmentVariableLoader.getEnvironmentVariable(\"FOO\")\n\n// Unknown env var will throw IllegalStateException\nval unknown = environmentVariableLoader.getEnvironmentVariable(\"Unknown\")\n\n// Unknown env var with a fallback value will return fallback instead of throwing IllegalStateException\nval unknownWithDefaultFallback = environmentVariableLoader.getEnvironmentVariable(\"UNKNOWN\", \"FALLBACK\") // \"FALLBACK\"\nFeatureFlags ....
See wisp-launchdarkly for more an implementation of FeatureFlags using LaunchDarkly.
See wisp-feature-testing for details on a Fake implementation for use in tests.
"},{"location":"wisp/wisp-feature/#usage-strongly-typed","title":"Usage - Strongly Typed","text":""},{"location":"wisp/wisp-feature/#basic-usage","title":"Basic Usage","text":"Step 1: Define your feature flag in Launch Darkly
Step 2: Define the flag in your code:
data class MissleButtonShouldBeEnabled(\n // Put the launch darkly key and attributes here, use real types!\n val customerId: String,\n val region: Region,\n val cardBin: CardBIN,\n) : BooleanFeatureFlag { // Also available: String, Double, Int, Enum, Json\n // `feature` needs to match the feature name in LaunchDarkly\n override val feature = Feature(\"missle-button-should-be-enabled\")\n\n // `key` should be the field you want to use as the LaunchDarkly key\n override val key = customerId\n\n // `attributes` should contain all the other fields, except for `key`. \n //\n // If using LaunchDarkly, these will be sent as custom attributes.\n override val attributes = Attributes()\n .with(\"cardBin\", cardBin.toString()) // `with` supports `String` and `Number`\n .with(\"region\", region.toString())\n}\nStep 3: Use your flag (MissleButtonShouldBeEnabled) with a wisp-feature client (i.e. wisp-launchdarkly or wisp-feature-testing):
val featureFlags: FeatureFlags = ??? // see `wisp-launchdarkly` or `wisp-feature-testing` for how to get `featureFlags`\n\n// `get`s return type depends on the flag type, in this case it's `Boolean`\nval enableMissleButton = featureFlags.get(\n MissileButtonShouldBeEnabled(\n customerId = \"customer-1234\",\n region = Region.Australia,\n cardBin = CardBIN(\"451213\")\n )\n)\n\n// ... do things with `enableMissleButton`\ndata class DomainObject(val name: String, val age: Int)\n\ndata class FeatureFlagThatReturnsJson(\n // Put launch darkly key and attributes here, same as usual. \n val customerId: String,\n val region: Region\n) : JsonFeatureFlag<DomainObject> {\n // `feature` needs to match the feature name in LaunchDarkly\n override val feature = Feature(\"missle-button-should-be-enabled\")\n\n // `key` should be the field you want to use as the LaunchDarkly key\n override val key = customerId\n\n // `attributes` should contain all the other fields, except for `key`. \n //\n // If using LaunchDarkly, these will be sent as custom attributes.\n override val attributes = Attributes()\n .with(\"region\", region.toString())\n\n // `returnType` need to match the generic type provided to `JsonFeatureFlag \n override val returnType = DomainObject::class.java \n}\nCalling get(FeatureFlagThatReturnsJson(...)) will return a DomainObject
Want to get on the strongly-typed hype train? Fantastic! Here\u2019s what you need to do:
getString/getBoolean/getX.getString/getBoolean/getX with a call to get using the flagoverride(String)/override(Boolean)/override(X) with override<MyStrongFlag>For example, consider this existing legacy implementation:
// FILE: ApplicationFeatureFlags.kt\nval MY_FEATURE_FLAG = Feature(\"my-feature-flag\")\n\n// FILE: MyService.kt\nclass MyService(private val featureFlags: FeatureFlags) {\n // Business logic function that uses feature flags\n fun getInstructions(customerId: String): String {\n val myFeatureFlagEnabled = featureFlags.getBoolean(\n feature = MY_FEATURE_FLAG,\n key = customerId,\n attributes = Attributes(\n mapOf(\n \"region\" to Region.Australia.toString()\n )\n )\n )\n\n return if (myFeatureFlagEnabled) {\n \"my feature is enabled\"\n } else {\n \"my feature is disabled\"\n }\n }\n}\n\n// FILE: MyServiceTest.kt\nclass MyServiceTest() {\n @Test fun `my service should say the feature is enabled for mary, but disabled otherwise`() {\n val featureFlags = FakeFeatureFlags()\n .override(MY_FEATURE_FLAG, false)\n .override(MY_FEATURE_FLAG, \"mary\", true)\n\n val service = MyService(featureFlags)\n service.getInstruction(\"bob\").shouldBe(false)\n service.getInstruction(\"mary\").shouldBe(true)\n }\n}\nLooking at MyService we can see that this is a Boolean flag (since we are using getBoolean), the key is customerId and we have one attribute called region. Now we can migrate:
// FILE: ApplicationFeatureFlags.kt\ndata class MyFeatureFlag(\n // We include the key and attributes we identified before\n customerId: String,\n region: Region\n): BooleanFeatureFlag { \n // `feature` should be whatever `MY_FEATURE_FLAG` was before\n override val feature = Feature(\"my-feature-flag\")\n\n // `key` should be the field we identified as the key from before\n override val key = customerId\n\n // `attributes` should contain all the other fields we identified\n // before\n override val attributes = Attributes()\n .with(\"region\", region.toString())\n}\n\n// FILE: MyService.kt\nclass MyService(private val featureFlags: FeatureFlags) {\n // Business logic function that uses feature flags\n fun getInstructions(customerId: String): String {\n val myFeatureFlagEnabled = featureFlags.get( // <-- `get` instead of `getBoolean`\n MyFeatureFlag(customerId, Region.Australia)\n )\n\n return if (myFeatureFlagEnabled) {\n \"my feature is enabled\"\n } else {\n \"my feature is disabled\"\n }\n }\n}\n\n// FILE: MyServiceTest.kt\nclass MyServiceTest() {\n @Test fun `my service should say the feature is enabled for mary, but disabled otherwise`() {\n val featureFlags = FakeFeatureFlags()\n .override<MyFeatureFlag>(false)\n .override<MyFeatureFlag>(true) { it.customerId == \"mary\" }\n\n val service = MyService(featureFlags)\n service.getInstruction(\"bob\").shouldBe(false)\n service.getInstruction(\"mary\").shouldBe(true)\n }\n}\n// TODO - usages...\nFake implementation of FeatureFlags.
See wisp-feature for more details on feature flags.
"},{"location":"wisp/wisp-feature-testing/#usage-strongly-typed","title":"Usage - Strongly Typed","text":""},{"location":"wisp/wisp-feature-testing/#step-1-define-a-feature-flag-as-described-in-wisp-feature","title":"Step 1: Define a feature flag as described in wisp-feature","text":""},{"location":"wisp/wisp-feature-testing/#step-2-use-the-feature-flag-in-your-code","title":"Step 2: Use the feature flag in your code:","text":"For example, you might have a service like this:
class ThingToTest(private val featureFlags: FeatureFlags) {\n fun getInstructions(customerId: String): String {\n val missileButtonEnabled = featureFlags.get(\n MissileButtonShouldBeEnabled(\n customerId = customerId,\n region = Region.Australia,\n cardBin = CardBIN(\"451213\") \n ) \n ) \n\n return if (missleButtonEnabled) {\n \"Press the missile button\" \n } else {\n \"Panic!\" \n }\n } \n}\nFakeFeatureFlags to test ThingToTest:","text":"class ThingToTestTests {\n @Test \n fun `it should tell me to press the button if the missile button is enabled`() {\n val featureFlags = FakeFeatureFlags()\n .override<MissileButtonShouldBeEnabled>(true)\n\n val thing = ThingToTest(featureFlags) \n\n thing.getInstructions(customerId = \"fred\").shouldBe(\"Press the missile button\")\n }\n\n @Test \n fun `it should tell me to panic if the missile button is not enabled`() {\n val featureFlags = FakeFeatureFlags()\n .override<MissileButtonShouldBeEnabled>(false)\n\n val thing = ThingToTest(featureFlags)\n\n thing.getInstructions(customerId = \"alice\").shouldBe(\"Panic!\")\n }\n}\nSometimes you want to say \u201conly enable the missile button for Mary\u201d. The override function has an optional matcher value that must be true for the override to match.
class ThingToTestTests {\n @Test\n fun `it should tell mary to press the button`() {\n val featureFlags = FakeFeatureFlags()\n .override<MissileButtonShouldBeEnabled>(true) { it.customerId == \"mary\" }\n\n val thing = ThingToTest(featureFlags)\n\n thing.getInstructions(customerId = \"mary\").shouldBe(\"Press the missile button\")\n }\n}\n// TODO - usages...\nFeatureFlags implementation using LaunchDarkly.
See wisp-feature for more details on feature flags.
See wisp-feature-testing for details on a Fake implementation for use in tests.
"},{"location":"wisp/wisp-launchdarkly/#usage","title":"Usage","text":"// create your LaunchDarkly config (or load it using wisp-config)\nval config = LaunchDarklyConfig(sdk_key = \"...\", base_uri = \"...\")\n\nval sslLoader = SslLoader(ResourceLoader.SYSTEM)\nval sslContextFactory = SslContextFactory(sslLoader)\n\n// create the LaunchDarkly client\nval ldClient = LaunchDarklyClient.createLaunchDarklyClient(\n config = config,\n sslLoader = sslLoader,\n sslContextFactory = sslContextFactory,\n resourceLoader = ResourceLoader.SYSTEM\n)\n\nval moshi = DEFAULT_KOTLIN_MOSHI\n\nval ldFeatureFlags = LaunchDarklyFeatureFlags(\n ldClient = ldClient,\n moshi = moshi\n)\n\n// TODO - usages...\nThis module contains the interfaces for leases. A lease can be used to fence code to ensure it is run only in the application holding the lease.
Also in this module is a lease pool implementation. Only one lease from a lease pool can be acquired on each application instance. It delegates as required to a real implementation for the lease operations.
TODO: Link to real implementation of wisp-lease\u2026
See wisp-lease-testing for a Fake lease implementation for use in tests.
"},{"location":"wisp/wisp-lease/#usage","title":"Usage","text":""},{"location":"wisp/wisp-lease/#general-lease-usage","title":"General Lease Usage","text":"val leaseManager: LeaseManager = SomeLeaseManagerImplementation()\n\n// request a lease\nval lease = leaseManager.requestLease(\"MY LEASE\")\n\n// acquire the lease\nif (lease.acquire()) {\n // got the lease....\n}\n\n// check if the lease is held (might have timed out, etc)\nif (lease.checkHeld()) {\n // lease is held\n}\n\n// add a listener and test if the lease is held...\nval leaseHeld = AtomicBoolean()\nlease.addListener(object : Lease.StateChangeListener {\n override fun afterAcquire(lease: Lease) {\n // lease should be held at this point, but it's best to check\n if (lease.checkHeld()) {\n leaseHeld.set(true)\n }\n }\n\n override fun beforeRelease(lease: Lease) {}\n})\n\nassertThat(leaseHeld.get()).isTrue()\n\n// release the lease explicitly\nlease.release()\nval deployment: Deployment = Deployment.getDeploymentFromEnvironmentVariable()\nval leaseManager: LeaseManager = SomeLeaseManagerImplementation()\n\nval poolLeaseConfig = PoolLeaseConfig(POOL_NAME, listOf(LEASE_NAME, ANOTHER_LEASE_NAME))\nval poolLeaseManager = PoolLeaseManager(leaseManager, deployment, listOf(poolLeaseConfig))\n\n// use as normal - only LEASE_NAME or ANOTHER_LEASE_NAME can ever be acquired, not both at the same time\nProvides a FakeLeaseManager as an implement of the LeaseManager for testing.
"},{"location":"wisp/wisp-lease-testing/#usage","title":"Usage","text":"val fakeLeaseManager = FakeLeaseManager()\n\n// use in tests instead of a real implementation of LeaseManager\nval myRealAppClass = MyRealAppClass(leaseManager = fakeLeaseManager)\n\n// requesting a lease gives a FakeLease (just use the interface in most cases)\nval lease: Lease = fakeLeaseManager.requestLease(\"YourLeaseName\")\nval fakeLease: FakeLease = lease as FakeLease\n\n// by default leases are held unless marked otherwise, so this would change nothing at this point\nfakeLeaseManager.markLeaseHeld(\"YourLeaseName\")\n\n// to mark the lease held somewhere else\nfakeLeaseManager.markLeaseHeldElsewhere(\"YourLeaseName\")\nassertThat(lease.checkHeld()).isFalse()\nassertThat(lease.acquire()).isFalse()\n\n// add a listener and test if the lease is held...\nval leaseHeld = AtomicBoolean()\nlease.addListener(object : Lease.StateChangeListener {\n override fun afterAcquire(lease: Lease) {\n if (lease.checkHeld()) {\n leaseHeld.set(true)\n }\n }\n\n override fun beforeRelease(lease: Lease) {}\n})\n\nassertThat(leaseHeld.get()).isTrue()\nConvenience functions on top of kotlin-logging.
"},{"location":"wisp/wisp-logging/#usage","title":"Usage","text":""},{"location":"wisp/wisp-logging/#mdc","title":"MDC","text":"Use this library to easily set MDC per log entry:
private val logger = getLogger<LoggingTest>()\n\nlogger.info(\n \"user-id\" to \"blerb\", \n \"alias-id\" to \"d6F1EF53\"\n) { \"tagged info\" }\nOtherwise, this library falls back to kotlin-logging:
logger.info { \"some logs\" }\nUse this library to sample down the volume of logs produced the logger:
private val logger = getLogger<LoggingTest>().sampled()\nBy default, this will logger will be rate limited to 1 log per second, but a custom Sampler can be provided if a different rate or policy is required:
private val logger = getLogger<LoggingTest>().sampled(Sampler.rateLimiting(500L))\nCaptures Logback logs to make it possible to do assertions on them.
"},{"location":"wisp/wisp-logging-testing/#usage","title":"Usage","text":"The sample code block below assumes AssertJ, but this library is not tied to a particular test framework or assertions library.
class MyClass {\n fun log() {\n val logger = getLogger<MyClass>()\n logger.info(\"this is a log message!\")\n }\n}\n\nfun `test that logs are captured`() {\n val logCollector = WispQueuedLogCollector()\n\n // Usually put this in a Before block.\n logCollector.startUp()\n\n // Test messages:\n MyClass().log()\n // takeMessages and takeEvents consume log entries.\n assertThat(logCollector.takeMessages()).containsExactly(\"this is a log message!\")\n\n // Test other log data, e.g. MDC:\n MyClass().log()\n // Because the first log() call was consumed, takeEvents only returns one event.\n assertThat(logCollector.takeEvents())\n .extracting(Function { it.mdcPropertyMap })\n .containsExactly(mapOf())\n\n // It's also possible to test that nothing is logged.\n assertThat(logCollector.takeMessages()).isEmpty()\n\n // Usually put this in an After block.\n logCollector.shutDown()\n}\nThis module provides Moshi related features, including a kotlin extension for JSON adapters and a default Moshi build that includes the KotlinJsonAdapterFactory
"},{"location":"wisp/wisp-resource-loader/","title":"wisp-resource-loader","text":"A testable way to load resources. See ResourceLoader for documentation.
Also see wisp-resource-loader-testing .
"},{"location":"wisp/wisp-resource-loader/#usage","title":"Usage","text":"val resourceLoader: ResourceLoader = ResourceLoader(\n mapOf(\n \"classpath:\" to ClasspathResourceLoaderBackend,\n \"memory:\" to MemoryResourceLoaderBackend(),\n \"filesystem:\" to FilesystemLoaderBackend,\n \"environment:\" to EnvironmentLoaderBackend,\n )\n)\n\nval resource = resourceLoader.utf8(\"classpath:/wisp/resources/ResourceLoaderTest.txt\")\nIncludes a way to fake filesystem resources loaded via wisp-resource-loader.
"},{"location":"wisp/wisp-resource-loader-testing/#usage","title":"Usage","text":"val loader = ResourceLoader(\n mapOf(\n \"filesystem:\" to FakeFilesystemLoaderBackend(\n mapOf(\n \"/some/test/file\" to \"test data!\"\n )\n )\n )\n)\n\n// This will load from the in-memory map rather than the filesystem.\nval data = loader.utf8(\"filesystem:/some/test/file\")\nUtilities for sampling and rate limiting actions.
"},{"location":"wisp/wisp-sampling/#usage","title":"Usage","text":"A Sampler can be used to test if an action is allowed based on a particular policy.
The rate limiting sampler allows a given number of samples per second:
val sampler = Sampler.rateLimiting(1L);\n\nif (sampler.sample()) {\n performAction()\n}\nThe percentage sampler allows the given percentage of samples:
val sampler = Sampler.percentage(50);\n\nif (sampler.sample()) {\n performAction()\n}\nThe always sampler allows all samples:
val sampler = Sampler.always();\n\nif (sampler.sample()) {\n performAction()\n}\nLoads and parses SSL certificates into a KeyStore . See SslLoader for a complete API.
This library is mostly only useful for other libraries that want to use ResourceLoader under the hood.
"},{"location":"wisp/wisp-ssl/#usage","title":"Usage","text":"val sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM)\n\nval certStore = sslLoader.loadCertStore(\n \"classpath:/ssl/client_cert_key_combo.pem\",\n SslLoader.Companion.FORMAT_PEM,\n \"password\"\n)\nThis module contains code to assist with running tasks.
RepeatedTask runs a repeated task at the user controlled rate based on the kotlin-retry library. For convenience a RepeatedTaskManager is available to help manage the RepeatedTasks.
It\u2019s possible to specify your own retry policy for the task. See kotlin-retry library for more details and examples. The default retry policy instructions are to retry on all exceptions with a Binary Exponential backoff delay - which itself is configured from the supplied RepeatedTaskConfig .
"},{"location":"wisp/wisp-task/#usage","title":"Usage","text":"Create a repeated task and start it running.
val repeatedTaskConfig = RepeatedTaskConfig(\n timeBetweenRunsMs = 10000L // 10 sec delay between task runs or retries\n)\n\nval manager = RepeatedTaskManager()\n\nval newTask = manager.createTask(\n name = \"taskName\",\n repeatedTaskConfig = repeatedTaskConfig,\n) { name: String, taskConfig: TaskConfig ->\n // do task stuff\n // ...\n\n // if the task completes correctly, return OK.\n Status.OK\n}\n\nnewTask.startUp()\nYou can shutdown a task or the manager which will shutdown all tasks. Using the above code:
// shut down the repeated task.\nnewTask.shutDown()\n\n// shut down all repeated tasks known by the manager.\nmanager.shutDown()\nThe task to be run takes a TaskConfig (which could be loaded using wisp-config).
class MyTaskConfig(\n val foo: String,\n val allResults: MutableList<String> = mutableListOf()\n): TaskConfig()\n\nval taskName = \"myTask\"\nval anotherTask = manager.createTask(\n name = taskName,\n repeatedTaskConfig = repeatedTaskConfig,\n taskConfig = MyTaskConfig(\"fooString\")\n) { name: String, taskConfig: TaskConfig ->\n val config = taskConfig as MyTaskConfig\n\n // access the taskConfig\n println(\"Foo is ${config.foo}\")\n\n // do task stuff\n // ...\n config.allResults.add(\"another result\")\n\n // if the task completes correctly, return OK.\n Status.OK\n}\nProvides a FakeClock, an implementation of java.time.Clock that can be manipulated for testing components with logic that relies on clocks.
val clock = FakeClock()\n\nval foo = ThingThatNeedsClock(clock)\nfoo.doSomething()\nclock.add(2, TimeUnit.SECOND)\nfoo.doSomething()\nThis module contains code to do token generation.
For details on the generation used, see TokenGenerator
"},{"location":"wisp/wisp-token/#usage","title":"Usage","text":"val tokenGenerator = RealTokenGenerator() \nval label = \"some label\"\nval length = 7 // 4 to 25\nval token = tokenGenerator.generate(label, length)\nThis module contains code to do token generation for testing.
For details on the generation used, see TokenGenerator
"},{"location":"wisp/wisp-token-testing/#usage","title":"Usage","text":"val tokenGenerator = FakeTokenGenerator() \nval label = \"some label\"\nval length = 7 // 4 to 25\nval token = tokenGenerator.generate(label, length)\nConvenience functions on top of opentracing Java APIs.
"},{"location":"wisp/wisp-tracing/#usage","title":"Usage","text":"Use this library to easily set up and manipulate traces.
import wisp.tracing.trace\n\ntracer.trace(\"span-name\") {\n // This block is instrumented with a scope and span.\n doSomething()\n // They are automatically closed and finished at the end.\n}\nThis module provides a concurrency-safe io.opentracing.mock.MockTracer as a testFixture. Use it with:
testImplementation(testFixtures(\"app.cash.wisp:wisp-tracing:$version\"))\nScopes are not thread-safe, so you need to set up a new scope before switching threads.
import wisp.tracing.traceWithSpan\nimport wisp.tracing.withNewScope\n\ntracer.traceWithSpan(\"multiple-threads\") { span ->\n thread { \n // withNewScope() gives you a new Scope with the same span.\n // the scope is closed at the end of the block. \n tracer.withNewScope(span) {\n doSomething()\n } \n }\n}\nEasily create child spans. Nested calls to trace/traceWithSpan implicitly create parent-child span relationships.
import wisp.tracing.trace\n\ntracer.trace(\"parent-span\") {\n // Create a new child span and finish it as soon as block finishes.\n tracer.trace(\"child-span\") {\n doSomething()\n }\n}\nNew root spans can be created from inside parent spans. These will show up independent of the parent context.
import wisp.tracing.trace\nimport wisp.tracing.traceWithNewRootSpan\n\ntracer.trace(\"universe\") {\n tracer.traceWithNewRootSpan(\"root\") {\n // Not a child.\n }\n}\nAdd all your tags at once, instead of processing and adding them one tag at a time. All primitive type tags are supported.
import wisp.tracing.traceWithSpan\nimport wisp.tracing.setTags\nimport wisp.tracing.Tag\n\n// Use typed tags.\ntracer.traceWithSpan(\"tags-example\") {\n span.setTags(listOf(\n Tag(\"string-tag\", \"string-value\"),\n Tag(\"int-tag\", 9999),\n Tag(\"bool-tag\", true)\n ))\n}\n\n// Or just use string tags.\ntracer.trace(\"tags-example\", tags = mapOf(\"a\" to \"b\")) {\n doSomething()\n}\nAdd all your baggage at once, instead of processing and adding it one piece at a time. This information will be available in downstream traces. Baggage can be anything, but will always be converted to a String.
import wisp.tracing.setBaggageItems\nimport wisp.tracing.traceWithSpan\n\ntracer.traceWithSpan(\"baggage-example\") { span ->\n span.setBaggageItems(\n mapOf(\n \"string-baggage\" to \"foo\",\n \"int-baggage\" to 9999,\n \"json-baggage\" to moshi.adapter(Dinosaur::class.java).toJson(trex)\n )\n )\n\n doSomething()\n}\nSometimes you may want to retain baggage from a parent context on smaller, independent traces.
import wisp.tracing.setBaggageItems\nimport wisp.tracing.traceWithSpan\nimport wisp.tracing.traceWithNewRootSpan\n\ntracer.traceWithSpan(\"has-baggage-context\") { span ->\n span.setBaggageItems(mapOf(\"string-baggage\" to \"foo\"))\n tracer.traceWithNewRootSpan(\"new-root-span\", retainBaggage = true) { newSpan ->\n assert(span.context().baggageItems().first() == newSpan.context().baggageItems().first())\n }\n}\nReleases
Documentation
Related
Misk (Microservice Container in Kotlin) is an open source microservice container from Cash App. It allows you to quickly create a microservice in Kotlin or Java, and provides libraries for common concerns like serving endpoints, caching, queueing, persistence, distributed leasing and clustering. It also includes the Wisp library, which is a collection of Kotlin modules providing various features and utilities, including config, logging, feature flags and more.
It has been powering hundreds of microservices within Cash App since 2018.
"},{"location":"#a-tour-of-features","title":"A Tour of Features","text":"Want to jump right into it? Check out our Getting Started Guide.
What to know more about each module, see Developer Guide.
"},{"location":"actions/","title":"Actions","text":"Actions are Misk\u2019s unit for an endpoint. Misk lets you make HTTP actions, and gRPC actions via Wire.
"},{"location":"actions/#web-actions","title":"Web Actions","text":"Below are some example Web action declarations. Note that many of the annotations are optional.
Calls are authenticated at the service-level (service is listed in the @Authenticated annotation) or at the user-level (user has at least one of the capabilities listed in the @Authenticated annotation).
GET:
@Singleton\nclass HelloWebAction @Inject constructor() : WebAction {\n @Get(\"/hello/{name}\") // Enclose path parameters in {}\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n @Authenticated(services = [\"my-other-app\"], capabilities = [\"my-app_owners\"])\n fun hello(\n // Use @PathParam with the name of the param. Required if there's a param in the path pattern.\n @PathParam name: String,\n // RequestHeaders is optional:\n @RequestHeaders headers: Headers,\n // QueryParams are optional:\n @QueryParam nickName: String?, // e.g. /hello/abc?nickName=def\n @QueryParam greetings: List<String>? // e.g. /hello/abc?greetings=def&greetings=ghi\n ): HelloResponse {\n return HelloResponse(name)\n }\n}\nPOST:
@Singleton\nclass HelloWebPostAction @Inject constructor() : WebAction {\n @Post(\"/hello/{name}\")\n @RequestContentType(MediaTypes.APPLICATION_JSON)\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n @Authenticated(services = [\"my-other-app\"], capabilities = [\"my-app_owners\"])\n fun hello(\n @PathParam name: String, \n // RequestBody is optional, and is automatically deserialized to the provided type.\n @RequestBody body: PostBody\n ): HelloPostResponse {\n return HelloPostResponse(body.greeting, name)\n }\n}\n\ndata class HelloPostResponse(val greeting: String, val name: String)\n\ndata class PostBody(val greeting: String)\nInstall the action into a module:
class HelloModule : KAbstractModule() {\n override fun configure() {\n install(WebActionModule.create<HelloWebAction>())\n install(WebActionModule.create<HelloWebPostAction>())\n }\n}\nAnd then put that module onto the top level MiskApplication.
fun main(args: Array<String>) {\n MiskApplication(\n // ...\n HelloModule(), // new!\n ).run(args)\n}\nIf you change the action\u2019s response type to Response<T>, it gives you better control over the response status code and headers.
@Singleton\nclass HelloWebResponseAction @Inject constructor() : WebAction {\n @Get(\"/hello_but_203/{name}\")\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n fun hello(@PathParam name: String): Response<HelloResponse> = Response(\n statusCode = 203,\n headers = headersOf(),\n body = HelloResponse()\n )\n}\nIt\u2019s also possible to throw exceptions that are mapped to status codes.
@Singleton\nclass HelloWebResponseAction @Inject constructor() : WebAction {\n @Get(\"/no_access/{name}\")\n fun hello(@PathParam name: String): HelloResponse {\n throw UnauthenticatedException()\n }\n}\nMisk has support for gRPC actions via the Wire protocol buffer (protobuf) library.
To create a gRPC action, first define the relevant protos for your service. Let\u2019s say we\u2019re creating a GreeterService that exposes one API, Hello. Create this file in src/main/proto/hello.proto:
syntax = \"proto2\";\npackage squareup.cash.hello;\n\noption java_package = \"com.squareup.protos.cash.hello\";\n\nmessage HelloRequest {\n optional string message = 1;\n}\n\nmessage HelloResponse {\n optional string message = 1;\n}\n\nservice GreeterService {\n rpc Hello(HelloRequest) returns (HelloResponse) {}\n}\nNext, in your project\u2019s build file (for this example, build.gradle.kts), add a dependency on the wire plugin:
plugins {\n id(\"com.squareup.wire\")\n}\nAdd the following configuration to generate the gRPC interfaces for your service:
wire {\n sourcePath {\n srcDir(\"src/main/proto\")\n }\n\n kotlin {\n include(\"squareup.cash.hello.GreeterService\")\n rpcCallStyle = \"blocking\"\n rpcRole = \"server\"\n singleMethodServices = true\n }\n\n java {\n }\n}\nFinally, implement and bind your gRPC action. GreeterServiceHelloBlockingServer is generated by Wire.
@Singleton\nclass HelloGrpcAction @Inject internal constructor()\n : GreeterServiceHelloBlockingServer, WebAction {\n\n @Unauthorized\n override fun Hello(request: HelloRequest): HelloResponse {\n return HelloResponse(\"message\")\n }\n}\n\n// This module binds HelloGrpcAction.\nclass GreeterActionModule : KAbstractModule() {\n override fun configure() {\n install(WebActionModule.create<HelloGrpcAction>())\n }\n}\nCreating a gRPC action automatically creates a JSON endpoint with all of the same annotations in the path defined by the ...BlockingServer, typically /<package>.<service name>/<rpc name>.
You can also create a second class that extends WebAction to customize this further. Read more about HTTP actions in Web Actions. If you\u2019re building both a gRPC and a HTTP action, a common pattern is to have them both use a common dependency:
@Singleton\nclass HelloGrpcAction @Inject constructor(val greeter: Greeter)\n : GreeterServiceHelloBlockingServer, WebAction {\n @Unauthorized override fun hello() = HelloResponse(greeter.greet())\n}\n\n@Singleton\nclass HelloWebAction @Inject constructor(val greeter: Greeter) : WebAction {\n @Unauthorized\n @Get(\"/hello\")\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n fun hello() = HelloResponse(greeter.greet())\n}\n\n@Singleton\nclass Greeter @Inject constructor() {\n fun greet() = \"Hello world\"\n}\nActionScoped gives an action access to context produced by the action\u2019s interceptors.
Misk has a few ActionScoped items built in:
MiskCaller - access derived authorization detailsHttpCall - access lower level HTTP details, e.g. request headersUse tests annotated with @MiskTest to perform tests. There are two common patterns to testing actions:
Make sure that the module under test contains a Guice binding for the action and its dependencies, then inject your action.
class MyModule : KAbstractModule() {\n override fun configure() {\n install(WebActionModule.create<HelloWebAction>())\n // Alternatively, a direct or just-in-time binding might be sufficient.\n }\n}\n\n@MiskTest class MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var action: HelloWebAction\n\n // use action...\n}\nActionScoped","text":"Use @WithMiskCaller for ActionScoped<MiskCaller>:
@MiskTest\n@WithMiskCaller(user = \"test-user\") // or @WithMiskCaller(service = \"test-service\")\nclass MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var action: HelloWebAction // or any other class that injects ActionScoped<MiskCaller>\n\n // use action...\n}\nFor types other than MiskCaller, use ActionScope directly either within your setup and teardown test methods:
@MiskTest\nclass MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var actionScope: ActionScope\n @Inject lateinit var action: HelloWebAction // or any other class that injects ActionScoped<MyScopedObject>\n\n @BeforeEach fun setUp() {\n actionScope.create(\n mapOf(\n keyOf<MyScopedObject>() to MyScopedObject()\n )\n ).enter()\n }\n\n @AfterEach fun tearDown() {\n actionScope.close()\n }\n\n @Test fun test() {\n // use action...\n }\n}\n\u2026or within the test itself:
@MiskTest\nclass MyTest {\n @MiskTestModule val module = MyModule()\n @Inject lateinit var actionScope: ActionScope\n @Inject lateinit var action: HelloWebAction\n\n @Test fun test() {\n actionScope.create(\n mapOf(\n keyOf<MyScopedObject>() to MyScopedObject()\n )\n ).inScope {\n // use action or class which injects ActionScoped<MyScopedObject>...\n }\n }\n}\nIt\u2019s possible to perform tests terminating at the app\u2019s HTTP/gRPC interface.
The module under test should include WebServerTestingModule so that Misk stands up a server during tests:
class MyModule : KAbstractModule() {\n override fun configure(){\n install(WebServerTestingModule())\n // install other modules...\n }\n}\nThen test HTTP requests using WebTestClient (assertions here were made using Kotest):
@MiskTest(startService = true)\nclass HelloWebIntegrationTest {\n @Suppress(\"unused\")\n @MiskTestModule val module = MyModule()\n\n @Inject lateinit var webTestClient: WebTestClient\n\n @Test\n fun `makes a call to the service`() {\n val response = webTestClient.post(\"/hello\", HelloRequest(\"world\"))\n response.response.code shouldBe 200\n response.parseJson<HelloResponse>() shouldBe HelloResponse(\"hello world\")\n }\n}\nTest gRPC requests by setting up a gRPC client pointing to the running app:
class MyServerModule : KAbstractModule() {\n override fun configure() {\n install(WebServerTestingModule())\n // Assume RobotLocatorWebAction is a gRPC action.\n install(WebActionModule.create<RobotLocatorWebAction>())\n }\n}\n\nclass MyClientModule(val jetty: JettyService): KAbstractModule() {\n override fun configure() {\n // Assume RobotLocator was generated via Wire.\n install(GrpcClientModule.create<RobotLocator, GrpcRobotLocator>(\"robots\"))\n }\n\n @Provides\n @Singleton\n fun provideHttpClientConfig(): HttpClientsConfig {\n return HttpClientsConfig(\n endpoints = mapOf(\n \"robots\" to HttpClientEndpointConfig(jetty.httpServerUrl.toString())\n )\n )\n }\n}\n\n@MiskTest(startService = true)\nclass RobotLocatorIntegrationTest {\n @Suppress(\"unused\")\n @MiskTestModule val module = MyServerModule()\n\n @Inject lateinit var jettyService: JettyService\n\n @Test \n fun `makes a call to the service`() {\n val robotLocator = Guice.createInjector(MyClientModule(jettyService))\n .getInstance<RobotLocator>()\n\n robotLocator.SayHello().executeBlocking(HelloRequest.builder().name(\"world\").build()) shouldBe \n HelloReply.Builder().message(\"hello world\").build()\n }\n}\nMisk releases since 2023-05-27 have been automatically published to Maven on PR merge to master.
The Changelog consequently will not be updated regularly since releases only include the changes of the last PR so the Changelog is now equivalent to the git commit history.
Major and breaking changes will still be documented in the Changelog.
"},{"location":"changelog/#2024-q2-summary","title":"2024 Q2 Summary","text":"Misk had a busy quarter with 98 PRs merged (over one per day!) from over 30 contributors.
From their efforts, numerous bug fixes, API improvements, and net-new functionality is now available to the growing community of developers building services with Misk.
"},{"location":"changelog/#thank-you-misk-contributors","title":"Thank you Misk Contributors!","text":"Misk has an active community of contributors giving back by upstreaming improvements, often motivated by their own experience building and operating Misk services.
Thanks to all who made Misk a better framework this quarter!
"},{"location":"changelog/#showcase-the-new-misk-ui-stack","title":"Showcase: The New Misk UI Stack","text":"Over the past year, the Misk admin dashboard has migrated to a new UI stack: kotlinx.html, Hotwire, and Tailwind UI.
This stack doesn\u2019t have a dedicated web build (ie. npm node modules, webpack\u2026) and has proven to be a lightweight, developer friendly stack for quickly shipping and maintaining simple UI from your Misk service. Builds are automatically part of your usual Gradle Misk Kotlin build which makes local development and CI builds fast and simple.
\u201cHaving a quick and easy way (for a backend eng \ud83d\ude05) to create custom UI is a power tool in your toolkit! It has helped us to creates internal utilities that makes operating and validate our services a walk in the park. I was able to successfully ship some new UI in one morning!\u201d \u2013 @frojasg
Developers have been surprised how fast they can ramp up and ship UI from their service, on the order of a few hours one morning, instead of a few weeks (or months) to build a full JS frontend app.
See the Exemplar service code in the repo for full examples of the new UI stack in use for building dedicated frontend apps, admin dashboard tabs, and more.
"},{"location":"changelog/#showcase-new-schema-migrator-gradle-plugin","title":"Showcase: New Schema Migrator Gradle Plugin","text":"Misk has shipped with a performant database schema migrator for years. It \u201cjust works\u201d ensuring table schemas are up to date and running migrations in local develompent and test environments.
Now, the Misk Schema Migrator is available as a standalone Gradle plugin for use without running the service or test suite. For some services previously forced to rely on a more complex plugin like Flyway to use libraries like jOOQ, the new Schema Migrator Gradle Plugin provides a simple way to get that functionality without new non-Misk dependencies. Additionally, the Schema Migrator Gradle Plugin is compatible with the Gradle config cache for optimal performance.
Check out the simple syntax and user docs here and try it for yourself today.
"},{"location":"changelog/#showcase-new-metadata-tab-in-the-misk-admin-dashboard","title":"Showcase: New Metadata tab in the Misk admin dashboard","text":"The new Metadata tab makes it easy to expose information from all parts of your running service. Find it at /_admin/metadata/!
The Metadata tab already includes the following information:
If you want to expose more metadata from Misk or your internal library or service, see the Exemplar service code.
"},{"location":"changelog/#showcase-new-requirerequest-utility-apis","title":"Showcase: New requireRequest utility APIs","text":"A common pattern in request validation is ensuring non-null request fields and throwing a BadRequestException otherwise. The new requireRequestNotNull utility API does this in a single line, reducing boilerplate and making the code more readable.
Before
requireRequest(request.parameter != null) { \"parameter must not be null\" }\n\n// later, safe do because of previous null check\nrequest.parameter!!\nAfter
requireRequestNotNull(request.parameter) { \"parameter must not be null\" }\n\n// later - no need for !!\nrequest.parameter\nMisk is open for PRs if there are other broad usage utility functions which would be beneficial to offer to all users of Misk.
"},{"location":"changelog/#version-20240709","title":"Version 2024.07.09","text":"Breaking changes:
@AllowAnyService annotation (which has been deprecated for months, was rarely used, and has no more internal usage), use @Authenticated(allowAnyService = true) instead. @Authenticated annotation, explicit passing of non-empty parameters capabilities, users, allowAnyUser, or allowAnyService is now required. Instead of the existing soft-failure error log behavior, an IllegalArgumentException will be thrown if the annotation constructor is empty.@Authenticated (empty constructor).Breaking changes:
@ExperimentalMiskApi to TaggedLogger. Any code that uses this class will need to @OptIn(ExperimentalMiskApi::class).Breaking changes:
BETA_PREFIX val which was used to gate development of the new v2 admin dashboard. It has been deprecated since 2023-06-30 when the v2 admin dashboard was promoted to /_admin/.Breaking changes:
Breaking changes:
New features and fixes:
Thank you to all the contributors, as always.
Breaking changes:
New features:
Fixes:
List<Client*Interceptor> to be bound when using TypedClientFactory stand-alone (#2218)Breaking changes:
/error action is no longer installed by default (#2190)New features and fixes:
Public release.
"},{"location":"changelog/#version-0200-2021-08-31","title":"Version 0.20.0 (2021-08-31)","text":"Breaking changes:
New features and fixes:
Public release.
"},{"location":"changelog/#version-0180-2021-06-28","title":"Version 0.18.0 (2021-06-28)","text":"Public release.
"},{"location":"changelog/#version-0171-2021-04-29","title":"Version 0.17.1 (2021-04-29)","text":"Public release.
"},{"location":"changelog/#version-0170-2021-04-28","title":"Version 0.17.0 (2021-04-28)","text":"Public release.
"},{"location":"changelog/#version-0160-2020-12-17","title":"Version 0.16.0 (2020-12-17)","text":"Public release.
"},{"location":"changelog/#version-0150-2020-12-03","title":"Version 0.15.0 (2020-12-03)","text":"Public release.
"},{"location":"changelog/#version-0140-2020-11-12","title":"Version 0.14.0 (2020-11-12)","text":"Public release.
"},{"location":"changelog/#version-0130-2020-07-16","title":"Version 0.13.0 (2020-07-16)","text":"Public release.
"},{"location":"changelog/#version-0120-2020-05-06","title":"Version 0.12.0 (2020-05-06)","text":"Public release.
"},{"location":"changelog/#version-0110-2020-02-25","title":"Version 0.11.0 (2020-02-25)","text":"Public release.
"},{"location":"changelog/#version-0100-2019-01-21","title":"Version 0.10.0 (2019-01-21)","text":"Public release.
"},{"location":"changelog/#version-090-2019-12-06","title":"Version 0.9.0 (2019-12-06)","text":"Public release.
"},{"location":"changelog/#version-080-2019-10-22","title":"Version 0.8.0 (2019-10-22)","text":"Public release.
"},{"location":"changelog/#version-070-2019-08-26","title":"Version 0.7.0 (2019-08-26)","text":"Public release.
"},{"location":"changelog/#version-025-2018-06-11","title":"Version 0.2.5 (2018-06-11)","text":""},{"location":"changelog/#new","title":"New","text":"Initial release.
"},{"location":"clients/","title":"Clients","text":"Misk provides configurable HTTP clients built on top of OkHttp and Retrofit, and gRPC clients built on top of Wire.
"},{"location":"clients/#http-clients","title":"HTTP Clients","text":""},{"location":"clients/#config","title":"Config","text":"Set up a Config object (and use MiskConfig.load to load config from a YAML file):
data class MyServiceConfig(\n val http_clients: HttpClientsConfig,\n // ...\n) : Config\nIn the configuration YAML, specify the target service\u2019s address:
http_clients:\n ...\n endpoints:\n ...\n greeter: { url: \"https://hello.example.com\" }\nUse HttpClientModule:
class MyClientModule : KAbstractModule() {\n override fun configure() {\n install(HttpClientModule(\n // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n name = \"greeter\",\n // Optional annotation to define how you inject your client dependency\n annotation = Names.named(\"greeterHttp\")\n ))\n }\n}\nThis binds an OkHttpClient that you can inject:
class MyClient @Inject constructor(@Named(\"greeterHttp\") val client: OkHttpClient) {\n fun callGreeter() {\n val response = client.newCall(\n Request.Builder()\n .url(\"http://localhost:8080/hello\")\n .build()\n ).execute()\n }\n}\nFirst, create a Retrofit interface. See the Retrofit docs for more details.
interface GreeterApi {\n @POST(\"/hello\")\n @Headers(value = [\"accept: application/json\"])\n fun hello(\n @Body request: HelloRequest\n ): Call<HelloResponse>\n}\nNext, install a TypedHttpClientModule with this interface.
class HelloClientModule : KAbstractModule() {\n override fun configure() {\n install(\n TypedHttpClientModule(\n GreeterApi::class, \n // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n name = \"greeter\", \n // Optional annotation to define how you inject your client dependency\n annotation = Names.named(\"greeterApi\")\n )\n )\n }\n}\nNow you can inject an implementation of this client:
@Singleton class MyApiClient @Inject constructor(\n @Named(\"greeterApi\") private val api: GreeterApi\n) {\n fun hello(message: String): String {\n val response = api.hello(\n HelloRequest(\n message = message\n )\n ).execute()\n }\n}\nFirst, include the auto-generated gRPC client code at the caller module using the Wire Gradle plugin.
plugins {\n id(\"com.squareup.wire\")\n}\n\nwire {\n sourcePath {\n srcDir(\"src/main/proto\")\n }\n\n // Generate Kotlin for the gRPC client API.\n kotlin {\n // Set this to false if you're generating client and server interfaces in one module\n exclusive = false\n includes (\"squareup.cash.hello.GreeterService\")\n rpcRole = \"client\"\n }\n\n java {\n }\n}\nNext, bind your client in code in a similar fashion to an HTTP client. Set up client configuration, as described in Config. Then, bind a GrpcClientModule:
class GreeterClientModule : KAbstractModule() {\n override fun configure() {\n install(GrpcClientModule.create<GreeterServiceClient, GrpcGreeterServiceClient>(\n // Corresponds to the YAML config. Requires a bound HttpClientsConfig\n name = \"greeter\",\n // Optional annotation to define how you inject your client dependency\n annotation = Names.named(\"greeterGrpc\")\n ))\n }\n}\nWith this all setup, you can now inject your client in source code and connect via gRPC:
internal class GrpcGreeterServiceClient @Inject internal constructor(\n @Named(\"greeterGrpc\") private val greeterGrpc: GreeterServiceClient\n) {\n fun get(message: String) {\n val response = greeterGrpc.Hello().executeBlocking(HelloRequest(message))\n\n // ... do something with the response here\n }\n}\nIf you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
Before your code can be accepted into the project you must also sign the Individual Contributor License Agreement (CLA).
"},{"location":"contributing/#building-misk-locally","title":"Building Misk locally","text":"Install and activate hermit: https://cashapp.github.io/hermit/
Use gradle to run all Kotlin tests locally:
gradle build\nmisk-hibernate tests expect a mysql server running on localhost:3306 with no password set on the root user. You might stand up a server with a docker image, e.g.
docker run -d --rm --name \"mysql-57\" -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=true -e MYSQL_LOG_CONSOLE=true mysql:5.7 --sql-mode=\"\"\nMisk may download these Docker images as part of its tests. Because tests can time out, pre-downloading these can help resolve timeouts.
alpine:latest\namazon/dynamodb-local:latest\ncockroachdb/cockroach\ngcr.io/cloud-spanner-emulator/emulator\npingcap/tidb\npostgres\nredis:6.2-alpine\nsoftwaremill/elasticmq\nvitess/base\nNote: Remember to document breaking changes in CHANGELOG.md.
We integrate Kotlin Binary Compatibility Validator into our build pipeline to automatically detect breaking changes that could affect existing clients.
"},{"location":"contributing/#kotlin-binary-compatibility-validator","title":"Kotlin Binary Compatibility Validator","text":"This tool checks for changes to the public binary API. The plugin generates a dump of the current API and compares it to the previous version. If a binary incompatibility is detected, the build will fail.
If the change is intentional, you can run the :apiDump task and commit the resulting changes to the .api files. .api files should not have removals and additions in the same change so that downstream apps do not immediately run into backwards-compatibility issues.
This runs as part of gradle check task, or you can call directly with gradle apiCheck.
Actions are Misk\u2019s unit for an endpoint. Misk lets you make HTTP actions, and gRPC actions via Wire.
Learn more about Misk actions
"},{"location":"developer-guide/#interceptors","title":"Interceptors","text":"Misk uses interceptors (middleware) to observe and potentially transform HTTP messages. The pattern is borrowed from OkHttp Interceptors.
Learn more about Misk interceptors
"},{"location":"developer-guide/#clients","title":"Clients","text":"Misk provides configurable HTTP clients built on top of OkHttp and Retrofit, and gRPC clients built on top of Wire.
Learn more about how to create, configure and test HTTP clients or gRPC clients within a Misk application here.
"},{"location":"developer-guide/#tests","title":"Tests","text":"Misk provides a few ways to streamline testing with JUnit.
Learn more about Misk tests
"},{"location":"developer-guide/#modules","title":"Modules","text":"Misk provides dozens of modules to facilitate the development and deployment of applications, and the integration with clouds and various common technologies.
Learn more about Misk modules
"},{"location":"developer-guide/#wisp","title":"Wisp","text":"Wisp is a collection of kotlin modules providing various features and utilities, including config, logging, feature flags and more. It is basically extracted Misk functionality without Dependency Injection (i.e., no Guice).
Learn more about Wisp.
"},{"location":"getting-started/","title":"Getting Started","text":"The easiest way to get started is to copy the Misk exemplar project. This exemplar contains a Misk web app with the requisite dependencies.
"},{"location":"getting-started/#prerequisites","title":"Prerequisites","text":"Misk relies on hermit to install tools required to develop and run the service. Please follow this to install and activate hermit.
Misk uses Gradle to build and run test locally.
"},{"location":"getting-started/#start-the-service","title":"Start the service","text":"Run ExemplarService#main from your IDE, or use gradle to run:
gradle run\nA Misk application is wired together using Guice. Features of Misk are managed by Guava Services, provided by Guice Modules, and configured using Misk Configs. For example, if your application needs a Redis cache, you would install RedisModule, and add a corresponding RedisConfig to your application\u2019s config YAML.
Misk is unopinionated about which of its features your application chooses to use, and offers multiple alternatives for some common concerns.
"},{"location":"getting-started/#the-main-function","title":"The main function","text":"The entry point to every Misk application is MiskApplication:
fun main(args: Array<String>) {\n val environment = Environment.fromEnvironmentVariable()\n val env = Env(environment.name)\n val config = MiskConfig.load<ExemplarConfig>(\"exemplar\", env)\n\n MiskApplication(\n MiskRealServiceModule(),\n MiskWebModule(config.web),\n ExemplarAccessModule(),\n ExemplarWebActionsModule(),\n\n // e.g. to add an admin dashboard:\n AdminDashboardModule(isDevelopment = true)\n ).run(args)\n}\nEvery Misk application has a top-level class that implements the Config marker interface. This Config encapsulates all of the configuration for the app.
By default, configs are loaded from YAML files at the app\u2019s resources root. Each value in the config must have a corresponding entry in the YAML file.
Modules in Misk that require configuration usually have their own Config objects. If you want to use the Module in your app, you should add them as properties of your app\u2019s Config object, for example:
data class MyAppConfig(\n val my_config_value: String,\n val http_clients: HttpClientsConfig\n) : Config\nThis then corresponds to a YAML file:
my_config_value: \"this value\"\n\nhttp_clients:\n # ... config\nConfigs are loaded using the app\u2019s resource loader. The config loader looks for files in the following order by default:
$SERVICE_NAME-common.yaml$SERVICE_NAME-$ENVIRONMENT.yamlAt least one of $SERVICE_NAME-common.yaml or $SERVICE_NAME-$ENVIRONMENT.yaml must exist.
Values from later files take precedence.
"},{"location":"getting-started/#write-an-endpoint","title":"Write an endpoint","text":"Actions are Misk\u2019s unit for an endpoint.
Actions inherit from WebAction and have a @Get/@Post annotation:
@Singleton\nclass HelloWebAction @Inject constructor() : WebAction {\n @Get(\"/hello/{name}\")\n @Unauthenticated\n @ResponseContentType(MediaTypes.APPLICATION_JSON)\n fun hello(\n @PathParam name: String,\n ): HelloResponse {\n return HelloResponse(name)\n }\n}\n\ndata class HelloResponse(val name: String)\nRead more about this in Actions.
"},{"location":"getting-started/#test-the-endpoint","title":"Test the endpoint","text":"You can unit test directly:
class HelloWebActionTest {\n @Test\n fun `tests the unit`() {\n assertThat(HelloWebAction().hello(\"sandy\", headersOf(), null, null))\n .isEqualTo(HelloResponse(\"sandy\"))\n }\n}\nIntegration tests set up a module for you, and adds an injector to the test class.
You can use WebServerTestingModule to set up a running web server and make WebTestClient available.
@MiskTest(startService = true)\nclass HelloWebActionTest {\n @MiskTestModule val module = TestModule()\n\n @Inject private lateinit var webTestClient: WebTestClient\n\n @Test\n fun `tests a request being made`() {\n val hello = webTestClient.get(\"/hello/sandy\")\n assertThat(hello.response.code).isEqualTo(200)\n assertThat(hello.parseJson<HelloResponse>())\n .isEqualTo(HelloResponse(\"sandy\"))\n }\n\n class TestModule : KAbstractModule() {\n override fun configure() {\n install(WebServerTestingModule())\n install(HelloModule())\n }\n }\n}\nRead more about this in Actions
"},{"location":"getting-started/#create-services","title":"Create services","text":"The main function is just an entry point for wiring together components of Misk. Long-running threads that do the real work are written as Services using Guava\u2019s Service Framework.
A Service is bound by installing a ServiceModule, for example:
class MyServiceModule : KAbstractModule() {\n override fun configure() {\n install(ServiceModule<MyService>())\n }\n}\nNotice that in this example we use KAbstractModule(), Misk\u2019s Kotlin wrapper for AbstractModule, as our base Module class.
MiskApplication will start all services installed by a ServiceModule.
If there is a Service that must be run after a other set of Services have started, the service dependency graph should be specified at the installation site.
For example, if you are operating a movie service, which needs a database:
class MovieServiceModule : KAbstractModule() {\n override fun configure() {\n // Note that DatabaseService does not have to be installed here.\n // It could be installed in another KAbstractModule if preferred.\n install(ServiceModule<DatabaseService>())\n\n // Multiple dependencies can be added by chaining calls to `dependsOn`.\n install(ServiceModule<MovieService>()\n .dependsOn<DatabaseService>())\n }\n}\nServiceModule for more details about the service graph. When writing Services, always prefer to inherit from one of the common base classes: AbstractIdleService, AbstractScheduledService, or AbstractExecutionThreadService. See Services Explained for details. If your service is can make use of exponential backoff and scheduling, take a look at using RepeatedTaskQueue.
Misk has interceptors (middleware) to observe & potentially transform HTTP messages. The pattern borrows from OkHttp Interceptors.
Interceptors can be for inbound calls to Misk\u2019s Jetty webserver from an external client, or outbound calls from Misk\u2019s OkHttpClient to an external service.
Interceptors can be network interceptors that operate on the encoded HTTP messages, or application interceptors that operate on decoded value objects.
Misk has both built-in interceptors and user-provided interceptors. In all cases, interceptors must be registered with a Guice multibinding.
"},{"location":"interceptors/#inbound-network-interceptors","title":"Inbound Network Interceptors","text":"These run for inbound HTTP calls into Misk.
They may short-circuit the inbound calls, preventing the calls from ever reaching the destination action. For example, the concurrency limiting (ie. load shedding) interceptor short-circuits inbound calls when it predicts a timeout. Inbound calls may also be short-circuited if authentication headers are absent or inadequate.
/** This sample interceptor decompresses the inbound request body. */\nclass GunzipRequestBodyInterceptor : NetworkInterceptor {\n override fun intercept(chain: NetworkChain) {\n val httpCall = chain.httpCall\n val contentEncoding = httpCall.requestHeaders[CONTENT_ENCODING]\n ?: return chain.proceed(httpCall)\n if (contentEncoding.lowercase() == GZIP) {\n httpCall.takeRequestBody()?.let {\n httpCall.putRequestBody(GzipSource(it).buffer())\n }\n }\n chain.proceed(httpCall)\n }\n}\nThough inbound interceptors may rewrite the inbound request, they generally run too late to rewrite the outbound response. In particular, by the time the proceed() call returns, the outbound HTTP response has already been encoded and transmitted.
The built-in inbound network interceptors are:
Multibind these with NetworkInterceptor.Factory.
These run after the network interceptors, and after the request body has been decoded into the type specified by the target action.
class RequestBodyLoggingInterceptor: ApplicationInterceptor {\n override fun intercept(chain: Chain): Any {\n val result = chain.proceed(chain.args)\n log(\"Request arguments: ${chain.args}, response value: $result\")\n return result\n }\n}\nWorking in this layer is convenient because the chain argument has the action, its args, its function, and its HttpCall. Because the action is already selected and its arguments are already decoded, this layer cannot be used to rewrite the bytes of the request! But it can change the arguments to the function (in a type-safe way).
The built-in inbound application interceptors are:
Multibind these with ApplicationInterceptor.Factory.
On inbound calls, network interceptors run before application interceptors. On outbound calls, the ordering is reversed: application interceptors run first.
Outbound application interceptors use OkHttp\u2019s Interceptor type for calls. Multibind these using ClientApplicationInterceptorFactory.
class LoggingInterceptor : Interceptor {\n\n override fun intercept(chain: Interceptor.Chain): Response {\n val response = chain.proceed(chain.request())\n log(\"Call to ${targetName(chain)} returned ${response.code}\")\n return response\n }\n\n private fun targetName(chain: Interceptor.Chain): String? {\n val invocation = chain.request().tag(Invocation::class.java)\n if (invocation != null) return \"$clientName.${invocation.method().name}\"\n\n val grpcMethod = chain.request().tag(GrpcMethod::class.java)\n if (grpcMethod != null) return \"$clientName.${grpcMethod.path.substringAfterLast(\"/\")}\"\n\n return null\n }\n}\nCalls made via Retrofit or the Wire gRPC client have metadata objects available as tags on the HTTP request. You can use these to find out which Retrofit method was called (and its arguments), or which gRPC method was called.
In these interceptors it\u2019s possible to rewrite the request body, request URL, and request headers. It\u2019s also possible to rewrite the returned response body, headers, or status code. You might do this to inject a missing response header or remove one.
The built-in outbound application interceptors are:
Multibind these with ClientApplicationInterceptorFactory.
These run on outbound calls after the outbound application interceptors. These run after the socket connection to the remote HTTP server has been established.
class LoggingInterceptor : ClientNetworkInterceptor {\n override fun intercept(chain: ClientNetworkChain): Response {\n log(\"executing ${chain.action}\")\n return chain.proceed(chain.request)\n }\n}\nNetwork interceptors cannot rewrite the destination hostname or URL. They can rewrite outbound request bodies and request headers. They can also rewrite returned status codes, bodies and headers.
Misk has no built-in network interceptors.
Multibind these with ClientNetworkInterceptor.Factory.
Misk is split into many Gradle subprojects to organize functionality and create smaller dependencies for downstream users. Integrations with external libraries (like DynamoDB, Hibernate, etc.) should each live in their own module.
Misk uses the Gradle test fixtures plugin to colocate production code with any relevant test helper classes. However, there are some *-testing modules that haven\u2019t yet been migrated to test fixtures.
Most of the implementation of Misk\u2019s web server components.
This is the original monolithic module. Pieces are being extracted into new modules to align with the smaller module strategy.
"},{"location":"modules/#misk-actions","title":"misk-actions","text":"The core annotations and interfaces necessary to define actions that can be hosted in Misk. This package has no dependency on the enclosing container (Misk!) and so your actions can be used in other environments without any heavy dependencies.
Actions should extend WebAction, be annotated with a HTTP method like @Post, accept a request object and return a response object. Throw an exception like BadRequestException to fail the request without much boilerplate.
High level interfaces and data classes which are implemented by both misk and wisp modules. This module is agnostic to implementation details.
"},{"location":"modules/#misk-aws","title":"misk-aws","text":"Integrate with Amazon Web Services, and includes packages to integrate with S3 and SQS.
"},{"location":"modules/#misk-aws-dynamodb","title":"misk-aws-dynamodb","text":"Integrate with AWS DynamoDb using AWS SDK for Java 1.x. It should be safe to install side-by-side with misk-aws2-dynamodb if you need to use features in both.
Integrate with this package to write tests for code that interacts with DynamoDb. Exposes APIs via AWS SDK for Java 1.x. Use alongside with misk-aws-dynamodb.
Installing InProcessDynamoDbModule runs a DynamoDb Local instance in memory for your tests to run against. This module is recommended over DockerDynamoDbModule because there is less overhead in test execution performance.
Installing DockerDynamoDbModule runs a DynamoDB Local instance in Docker for your tests to execute against.
Integrate with AWS DynamoDb using AWS SDK for Java 2.x. It should be safe to install side-by-side with misk-aws-dynamodb if you need to use features in both.
Please read the AWS SDK for Java 2.x Migration Guide for more details.
"},{"location":"modules/#misk-aws2-dynamodb-testing","title":"misk-aws2-dynamodb-testing","text":"Integrate with this package to write tests for code that interacts with DynamoDb. Exposes APIs via AWS SDK for Java 2.x. Use alongside with misk-aws2-dynamodb.
Installing InProcessDynamoDbModule runs a DynamoDb Local instance in memory for your tests to run against. This module is recommended over DockerDynamoDbModule because there is less overhead in test execution performance.
Installing DockerDynamoDbModule runs a DynamoDB Local instance in Docker for your tests to execute against.
A collection of utility functions and interfaces that are used in many places.
"},{"location":"modules/#misk-service","title":"misk-service","text":"Bind Guava services with inter-service dependencies.
Any service can depend on any other service. ServiceManager won\u2019t start a service until the services it depends on are running.
"},{"location":"modules/#misk-inject","title":"misk-inject","text":"Integrates Guice with Kotlin.
Extending KAbstractModule instead of Guice\u2019s AbstractModule lets you use KClass instead of java.lang.Class and other conveniences.
Runtime feature flags. misk-launchdarkly is the reference implementation.
A job queue with a high quality fake. AwsSqsJobQueueModule from misk-aws is the reference implementation.
An event publisher + consumer. There is no open source reference implementation at this time.
"},{"location":"modules/#wisp","title":"wisp.*","text":"These modules were created to extract specific pieces of functionality out of the misk* modules into new, low-dependency modules. They were especially focused on having no Guice dependencies. Some of these modules duplicate existing Misk functionality, but over time implementations will be deduplicated as part of broader code cleanup efforts.
Our release process is designed to be hands-off and automatic. This document aims to provide an understanding of the automated workflow we use to release new versions of Misk repository, along with insights into how to troubleshoot potential publishing issues.
"},{"location":"releasing/#prerequisites","title":"Prerequisites","text":"Before proceeding with the release process, ensure the following: - You have read CONTRIBUTING.md - build.gradle.kts is properly configured with the correct publishing configurations and publishing plugin is applied - If you are changing the publication details, it is recommended that you have the necessary permissions and credentials to publish artifacts to Sonatype Nexus Repository (OSSRH)
This repository is set up with an automated workflow using GitHub Actions. - The workflow is triggered as soon as a pull request is merged into the master branch. - A version number is dynamically generated and assigned to the release - The artifacts are published to Sonatype Nexus to a staging repository - Sonatype performs various checks and validations on the artifacts - Once verified, these artifacts are promoted and eventually synchronized to Maven Central - Public builds can be found here
While our release process is designed to be seamless, occasionally, issues may arise that require attention. Here are some tips to help diagnose:
Misk provides a few ways to streamline testing with JUnit.
Without Misk, you would instantiate units under test and their dependencies:
class FeatureWithoutMiskTest {\n @Test \n fun `tests something`() {\n val repository = MyRepository()\n val handler = MyHandler(repository)\n\n // ... perform assertions\n }\n}\n@MiskTest","text":"@MiskTest will stand up a Misk app given a provided module and then inject members onto the test class. For instance, with a test that looks like this:
@MiskTest(startService = true)\nclass HelloWebIntegrationTest {\n @MiskTestModule val module = MyTestingModule()\n\n @Inject lateinit var myHandler: MyHandler\n\n @Test\n fun `makes a call to the service`() {\n // use myHandler...\n }\n}\n\nclass MyTestingModule : KAbstractModule() {\n override fun configure() {\n // add modules, declare bindings...\n }\n}\n@MiskTest signals to JUnit to honour the other annotations.@MiskTestModule declares which module to use to perform the tests in this class. This module (or a sub-module under it) should have a binding for MyHandler, which gets injected in the test class.Some common domains to test:
//bucket4j
"},{"location":"0.x/bucket4j/#bucket4j","title":"bucket4j","text":""},{"location":"0.x/bucket4j/#packages","title":"Packages","text":"Name wisp.ratelimiting.bucket4j"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/","title":"Package-level declarations - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/#types","title":"Types","text":"Name Summary Bucket4jPruner [jvm]abstract class Bucket4jPruner : RateLimitPruner Bucket4jRateLimiter [jvm]class Bucket4jRateLimiter@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter ClockTimeMeter [jvm]class ClockTimeMeter(clock: Clock) : TimeMeter"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/","title":"Bucket4jPruner - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#bucket4jpruner","title":"Bucket4jPruner","text":"[jvm]\\ abstract class Bucket4jPruner : RateLimitPruner
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#constructors","title":"Constructors","text":"Bucket4jPruner [jvm]constructor()"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]abstract val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]abstract fun prune()"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/-bucket4j-pruner/","title":"Bucket4jPruner - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner/Bucket4jPruner
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/-bucket4j-pruner/#bucket4jpruner","title":"Bucket4jPruner","text":"[jvm]\\ constructor()
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jPruner/clockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"[jvm]\\ abstract val clockTimeMeter: ClockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/","title":"Bucket4jRateLimiter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#bucket4jratelimiter","title":"Bucket4jRateLimiter","text":"[jvm]\\ class Bucket4jRateLimiter@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry) : RateLimiter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#constructors","title":"Constructors","text":"Bucket4jRateLimiter [jvm]@JvmOverloadsconstructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/#functions","title":"Functions","text":"Name Summary availableTokens [jvm]open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long consumeToken [jvm]open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData releaseToken [jvm]open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long) resetBucket [jvm]open override fun resetBucket(key: String, configuration: RateLimitConfiguration) testConsumptionAttempt [jvm]open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult withToken [jvm]open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/-bucket4j-rate-limiter/","title":"Bucket4jRateLimiter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/Bucket4jRateLimiter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/-bucket4j-rate-limiter/#bucket4jratelimiter","title":"Bucket4jRateLimiter","text":"[jvm]\\
@JvmOverloads
constructor(bucketProxy: ProxyManager<String>, clock: Clock, meterRegistry: MeterRegistry = Metrics.globalRegistry)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/available-tokens/","title":"availableTokens - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/availableTokens
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/available-tokens/#availabletokens","title":"availableTokens","text":"[jvm]\\ open override fun availableTokens(key: String, configuration: RateLimitConfiguration): Long
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/consume-token/","title":"consumeToken - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/consumeToken
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/consume-token/#consumetoken","title":"consumeToken","text":"[jvm]\\ open override fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.ConsumptionData
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/release-token/","title":"releaseToken - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/releaseToken
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/release-token/#releasetoken","title":"releaseToken","text":"[jvm]\\ open override fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/reset-bucket/","title":"resetBucket - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/resetBucket
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/reset-bucket/#resetbucket","title":"resetBucket","text":"[jvm]\\ open override fun resetBucket(key: String, configuration: RateLimitConfiguration)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/test-consumption-attempt/","title":"testConsumptionAttempt - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/Bucket4jRateLimiter/testConsumptionAttempt
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-bucket4j-rate-limiter/test-consumption-attempt/#testconsumptionattempt","title":"testConsumptionAttempt","text":"[jvm]\\ open override fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long): RateLimiter.TestConsumptionResult
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/","title":"ClockTimeMeter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#clocktimemeter","title":"ClockTimeMeter","text":"[jvm]\\ class ClockTimeMeter(clock: Clock) : TimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#constructors","title":"Constructors","text":"ClockTimeMeter [jvm]constructor(clock: Clock)"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/#functions","title":"Functions","text":"Name Summary currentTimeNanos [jvm]open override fun currentTimeNanos(): Long isWallClockBased [jvm]open override fun isWallClockBased(): Boolean"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/-clock-time-meter/","title":"ClockTimeMeter - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/ClockTimeMeter
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/-clock-time-meter/#clocktimemeter","title":"ClockTimeMeter","text":"[jvm]\\ constructor(clock: Clock)
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/current-time-nanos/","title":"currentTimeNanos - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/currentTimeNanos
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/current-time-nanos/#currenttimenanos","title":"currentTimeNanos","text":"[jvm]\\ open override fun currentTimeNanos(): Long
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/is-wall-clock-based/","title":"isWallClockBased - Misk","text":"//bucket4j/wisp.ratelimiting.bucket4j/ClockTimeMeter/isWallClockBased
"},{"location":"0.x/bucket4j/bucket4j/wisp.ratelimiting.bucket4j/-clock-time-meter/is-wall-clock-based/#iswallclockbased","title":"isWallClockBased","text":"[jvm]\\ open override fun isWallClockBased(): Boolean
"},{"location":"0.x/detektive/","title":"detektive - Misk","text":"//detektive
"},{"location":"0.x/detektive/#detektive","title":"detektive","text":""},{"location":"0.x/detektive/#packages","title":"Packages","text":"Name cash.detektive cash.detektive.javacompat"},{"location":"0.x/detektive/detektive/cash.detektive/","title":"Package-level declarations - Misk","text":"//detektive/cash.detektive
"},{"location":"0.x/detektive/detektive/cash.detektive/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/detektive/detektive/cash.detektive/#types","title":"Types","text":"Name Summary DetektiveRuleSetProvider [jvm]class DetektiveRuleSetProvider : RuleSetProvider"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/","title":"DetektiveRuleSetProvider - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#detektiverulesetprovider","title":"DetektiveRuleSetProvider","text":"[jvm]\\ class DetektiveRuleSetProvider : RuleSetProvider
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#constructors","title":"Constructors","text":"DetektiveRuleSetProvider [jvm]constructor()"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#properties","title":"Properties","text":"Name Summary ruleSetId [jvm]open override val ruleSetId: String"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/#functions","title":"Functions","text":"Name Summary instance [jvm]open override fun instance(config: Config): RuleSet"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/-detektive-rule-set-provider/","title":"DetektiveRuleSetProvider - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider/DetektiveRuleSetProvider
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/-detektive-rule-set-provider/#detektiverulesetprovider","title":"DetektiveRuleSetProvider","text":"[jvm]\\ constructor()
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/instance/","title":"instance - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider/instance
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/instance/#instance","title":"instance","text":"[jvm]\\ open override fun instance(config: Config): RuleSet
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/rule-set-id/","title":"ruleSetId - Misk","text":"//detektive/cash.detektive/DetektiveRuleSetProvider/ruleSetId
"},{"location":"0.x/detektive/detektive/cash.detektive/-detektive-rule-set-provider/rule-set-id/#rulesetid","title":"ruleSetId","text":"[jvm]\\ open override val ruleSetId: String
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/","title":"Package-level declarations - Misk","text":"//detektive/cash.detektive.javacompat
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/#types","title":"Types","text":"Name Summary AnnotatePublicApisWithJvmOverloads [jvm]class AnnotatePublicApisWithJvmOverloads(config: Config) : Rule"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/","title":"AnnotatePublicApisWithJvmOverloads - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#annotatepublicapiswithjvmoverloads","title":"AnnotatePublicApisWithJvmOverloads","text":"[jvm]\\ class AnnotatePublicApisWithJvmOverloads(config: Config) : Rule
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#constructors","title":"Constructors","text":"AnnotatePublicApisWithJvmOverloads [jvm]constructor(config: Config)"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#types","title":"Types","text":"Name Summary ElementType [jvm]enum ElementType : Enum<AnnotatePublicApisWithJvmOverloads.ElementType>"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#properties","title":"Properties","text":"Name Summary active [jvm]open val active: Boolean aliases [jvm]val aliases: Set<String> autoCorrect [jvm]open val autoCorrect: Boolean bindingContext [jvm]var bindingContext: BindingContext compilerResources [jvm]var compilerResources: CompilerResources? defaultRuleIdAliases [jvm]open val defaultRuleIdAliases: Set<String> filters [jvm]open val filters: PathFilters? findings [jvm]open override val findings: List<Finding> issue [jvm]open override val issue: Issue parentPath [jvm]open val parentPath: String? ruleId [jvm]override val ruleId: RuleId ruleSetConfig [jvm]open override val ruleSetConfig: Config"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/#functions","title":"Functions","text":"Name Summary clearFindings [jvm]open override fun clearFindings() report [jvm]open override fun report(finding: Finding, aliases: Set<String>, ruleSetId: RuleSetId?)open override fun report(findings: List<Finding>, aliases: Set<String>, ruleSetId: RuleSetId?)fun report(finding: Finding)fun report(findings: List<Finding>) subConfig [jvm]open override fun subConfig(key: String): Config valueOrDefault [jvm]open override fun <T : Any> valueOrDefault(key: String, default: T): T valueOrNull [jvm]open override fun <T : Any> valueOrNull(key: String): T? visit [jvm]open fun visit(root: KtFile) visitAnnotatedExpression [jvm]open fun visitAnnotatedExpression(@NotNullp0: KtAnnotatedExpression)override fun visitAnnotatedExpression(@NotNullp0: KtAnnotatedExpression, p1: Void): Void visitAnnotation [jvm]open fun visitAnnotation(@NotNullp0: KtAnnotation)override fun visitAnnotation(@NotNullp0: KtAnnotation, p1: Void): Void visitAnnotationEntry [jvm]open fun visitAnnotationEntry(@NotNullp0: KtAnnotationEntry)override fun visitAnnotationEntry(@NotNullp0: KtAnnotationEntry, p1: Void): Void visitAnnotationUseSiteTarget [jvm]open fun visitAnnotationUseSiteTarget(@NotNullp0: KtAnnotationUseSiteTarget, p1: Void): Void visitAnonymousInitializer [jvm]open fun visitAnonymousInitializer(@NotNullp0: KtAnonymousInitializer)override fun visitAnonymousInitializer(@NotNullp0: KtAnonymousInitializer, p1: Void): Void visitArgument [jvm]open fun visitArgument(@NotNullp0: KtValueArgument)override fun visitArgument(@NotNullp0: KtValueArgument, p1: Void): Void visitArrayAccessExpression [jvm]open fun visitArrayAccessExpression(@NotNullp0: KtArrayAccessExpression)override fun visitArrayAccessExpression(@NotNullp0: KtArrayAccessExpression, p1: Void): Void visitBackingField [jvm]open fun visitBackingField(@NotNullp0: KtBackingField, p1: Void): Void visitBinaryExpression [jvm]open fun visitBinaryExpression(@NotNullp0: KtBinaryExpression)override fun visitBinaryExpression(@NotNullp0: KtBinaryExpression, p1: Void): Void visitBinaryFile [jvm]open fun visitBinaryFile(@NotNullp0: @NotNullPsiBinaryFile) visitBinaryWithTypeRHSExpression [jvm]open fun visitBinaryWithTypeRHSExpression(@NotNullp0: KtBinaryExpressionWithTypeRHS)override fun visitBinaryWithTypeRHSExpression(@NotNullp0: KtBinaryExpressionWithTypeRHS, p1: Void): Void visitBlockExpression [jvm]open fun visitBlockExpression(@NotNullp0: KtBlockExpression)override fun visitBlockExpression(@NotNullp0: KtBlockExpression, p1: Void): Void visitBlockStringTemplateEntry [jvm]open fun visitBlockStringTemplateEntry(@NotNullp0: KtBlockStringTemplateEntry)override fun visitBlockStringTemplateEntry(@NotNullp0: KtBlockStringTemplateEntry, p1: Void): Void visitBreakExpression [jvm]open fun visitBreakExpression(@NotNullp0: KtBreakExpression)override fun visitBreakExpression(@NotNullp0: KtBreakExpression, p1: Void): Void visitCallableReferenceExpression [jvm]open fun visitCallableReferenceExpression(@NotNullp0: KtCallableReferenceExpression)override fun visitCallableReferenceExpression(@NotNullp0: KtCallableReferenceExpression, p1: Void): Void visitCallExpression [jvm]open fun visitCallExpression(@NotNullp0: KtCallExpression)override fun visitCallExpression(@NotNullp0: KtCallExpression, p1: Void): Void visitCatchSection [jvm]open fun visitCatchSection(@NotNullp0: KtCatchClause)override fun visitCatchSection(@NotNullp0: KtCatchClause, p1: Void): Void visitClass [jvm]open fun visitClass(@NotNullp0: KtClass)override fun visitClass(@NotNullp0: KtClass, p1: Void): Void visitClassBody [jvm]open fun visitClassBody(@NotNullp0: KtClassBody)override fun visitClassBody(@NotNullp0: KtClassBody, p1: Void): Void visitClassInitializer [jvm]open fun visitClassInitializer(@NotNullp0: KtClassInitializer)open override fun visitClassInitializer(@NotNullp0: KtClassInitializer, p1: Void): Void visitClassLiteralExpression [jvm]open fun visitClassLiteralExpression(@NotNullp0: KtClassLiteralExpression)override fun visitClassLiteralExpression(@NotNullp0: KtClassLiteralExpression, p1: Void): Void visitClassOrObject [jvm]open fun visitClassOrObject(@NotNullp0: KtClassOrObject)override fun visitClassOrObject(@NotNullp0: KtClassOrObject, p1: Void): Void visitCollectionLiteralExpression [jvm]open fun visitCollectionLiteralExpression(@NotNullp0: KtCollectionLiteralExpression)override fun visitCollectionLiteralExpression(@NotNullp0: KtCollectionLiteralExpression, p1: Void): Void visitComment [jvm]open fun visitComment(@NotNullp0: @NotNullPsiComment) visitCondition [jvm]open override fun visitCondition(root: KtFile): Boolean visitConstantExpression [jvm]open fun visitConstantExpression(@NotNullp0: KtConstantExpression)override fun visitConstantExpression(@NotNullp0: KtConstantExpression, p1: Void): Void visitConstructorCalleeExpression [jvm]open fun visitConstructorCalleeExpression(@NotNullp0: KtConstructorCalleeExpression)override fun visitConstructorCalleeExpression(@NotNullp0: KtConstructorCalleeExpression, p1: Void): Void visitConstructorDelegationCall [jvm]open fun visitConstructorDelegationCall(@NotNullp0: KtConstructorDelegationCall)override fun visitConstructorDelegationCall(@NotNullp0: KtConstructorDelegationCall, p1: Void): Void visitContextReceiverList [jvm]open fun visitContextReceiverList(@NotNullp0: KtContextReceiverList, p1: Void): Voidopen fun visitContextReceiverList(@NotNullp0: KtContextReceiverList) visitContinueExpression [jvm]open fun visitContinueExpression(@NotNullp0: KtContinueExpression)override fun visitContinueExpression(@NotNullp0: KtContinueExpression, p1: Void): Void visitDeclaration [jvm]open fun visitDeclaration(@NotNullp0: KtDeclaration)override fun visitDeclaration(@NotNullp0: KtDeclaration, p1: Void): Void visitDelegatedSuperTypeEntry [jvm]open fun visitDelegatedSuperTypeEntry(@NotNullp0: KtDelegatedSuperTypeEntry)override fun visitDelegatedSuperTypeEntry(@NotNullp0: KtDelegatedSuperTypeEntry, p1: Void): Void visitDestructuringDeclaration [jvm]open fun visitDestructuringDeclaration(@NotNullp0: KtDestructuringDeclaration)override fun visitDestructuringDeclaration(@NotNullp0: KtDestructuringDeclaration, p1: Void): Void visitDestructuringDeclarationEntry [jvm]open fun visitDestructuringDeclarationEntry(@NotNullp0: KtDestructuringDeclarationEntry)override fun visitDestructuringDeclarationEntry(@NotNullp0: KtDestructuringDeclarationEntry, p1: Void): Void visitDirectory [jvm]open fun visitDirectory(@NotNullp0: @NotNullPsiDirectory) visitDotQualifiedExpression [jvm]open fun visitDotQualifiedExpression(@NotNullp0: KtDotQualifiedExpression)override fun visitDotQualifiedExpression(@NotNullp0: KtDotQualifiedExpression, p1: Void): Void visitDoubleColonExpression [jvm]open fun visitDoubleColonExpression(@NotNullp0: KtDoubleColonExpression)override fun visitDoubleColonExpression(@NotNullp0: KtDoubleColonExpression, p1: Void): Void visitDoWhileExpression [jvm]open fun visitDoWhileExpression(@NotNullp0: KtDoWhileExpression)override fun visitDoWhileExpression(@NotNullp0: KtDoWhileExpression, p1: Void): Void visitDynamicType [jvm]open fun visitDynamicType(@NotNullp0: KtDynamicType)open override fun visitDynamicType(@NotNullp0: KtDynamicType, p1: Void): Void visitElement [jvm]open override fun visitElement(@NotNullp0: PsiElement) visitEnumEntry [jvm]open fun visitEnumEntry(@NotNullp0: KtEnumEntry)override fun visitEnumEntry(@NotNullp0: KtEnumEntry, p1: Void): Void visitErrorElement [jvm]open fun visitErrorElement(@NotNullp0: @NotNullPsiErrorElement) visitEscapeStringTemplateEntry [jvm]open fun visitEscapeStringTemplateEntry(@NotNullp0: KtEscapeStringTemplateEntry)override fun visitEscapeStringTemplateEntry(@NotNullp0: KtEscapeStringTemplateEntry, p1: Void): Void visitExpression [jvm]open fun visitExpression(@NotNullp0: KtExpression)override fun visitExpression(@NotNullp0: KtExpression, p1: Void): Void visitExpressionWithLabel [jvm]open fun visitExpressionWithLabel(@NotNullp0: KtExpressionWithLabel)override fun visitExpressionWithLabel(@NotNullp0: KtExpressionWithLabel, p1: Void): Void visitFile [jvm]fun visitFile(root: KtFile, bindingContext: BindingContext, compilerResources: CompilerResources?)open fun visitFile(@NotNullp0: @NotNullPsiFile) visitFileAnnotationList [jvm]open fun visitFileAnnotationList(@NotNullp0: KtFileAnnotationList, p1: Void): Void visitFinallySection [jvm]open fun visitFinallySection(@NotNullp0: KtFinallySection)override fun visitFinallySection(@NotNullp0: KtFinallySection, p1: Void): Void visitForExpression [jvm]open fun visitForExpression(@NotNullp0: KtForExpression)override fun visitForExpression(@NotNullp0: KtForExpression, p1: Void): Void visitFunctionType [jvm]open fun visitFunctionType(@NotNullp0: KtFunctionType)override fun visitFunctionType(@NotNullp0: KtFunctionType, p1: Void): Void visitIfExpression [jvm]open fun visitIfExpression(@NotNullp0: KtIfExpression)override fun visitIfExpression(@NotNullp0: KtIfExpression, p1: Void): Void visitImportAlias [jvm]open fun visitImportAlias(@NotNullp0: KtImportAlias, p1: Void): Voidopen fun visitImportAlias(@NotNullp0: KtImportAlias) visitImportDirective [jvm]open fun visitImportDirective(@NotNullp0: KtImportDirective)override fun visitImportDirective(@NotNullp0: KtImportDirective, p1: Void): Void visitImportList [jvm]open fun visitImportList(@NotNullp0: KtImportList)override fun visitImportList(@NotNullp0: KtImportList, p1: Void): Void visitInitializerList [jvm]open fun visitInitializerList(@NotNullp0: KtInitializerList)override fun visitInitializerList(@NotNullp0: KtInitializerList, p1: Void): Void visitIntersectionType [jvm]open fun visitIntersectionType(@NotNullp0: KtIntersectionType)open override fun visitIntersectionType(@NotNullp0: KtIntersectionType, p1: Void): Void visitIsExpression [jvm]open fun visitIsExpression(@NotNullp0: KtIsExpression)override fun visitIsExpression(@NotNullp0: KtIsExpression, p1: Void): Void visitKtElement [jvm]open fun visitKtElement(@NotNullp0: KtElement)override fun visitKtElement(@NotNullp0: KtElement, p1: Void): Void visitKtFile [jvm]open fun visitKtFile(@NotNullp0: KtFile)override fun visitKtFile(@NotNullp0: KtFile, p1: Void): Void visitLabeledExpression [jvm]open fun visitLabeledExpression(@NotNullp0: KtLabeledExpression)override fun visitLabeledExpression(@NotNullp0: KtLabeledExpression, p1: Void): Void visitLambdaExpression [jvm]open fun visitLambdaExpression(@NotNullp0: KtLambdaExpression)override fun visitLambdaExpression(@NotNullp0: KtLambdaExpression, p1: Void): Void visitLiteralStringTemplateEntry [jvm]open fun visitLiteralStringTemplateEntry(@NotNullp0: KtLiteralStringTemplateEntry)override fun visitLiteralStringTemplateEntry(@NotNullp0: KtLiteralStringTemplateEntry, p1: Void): Void visitLoopExpression [jvm]open fun visitLoopExpression(@NotNullp0: KtLoopExpression)override fun visitLoopExpression(@NotNullp0: KtLoopExpression, p1: Void): Void visitModifierList [jvm]open fun visitModifierList(@NotNullp0: KtModifierList)override fun visitModifierList(@NotNullp0: KtModifierList, p1: Void): Void visitNamedDeclaration [jvm]open fun visitNamedDeclaration(@NotNullp0: KtNamedDeclaration)override fun visitNamedDeclaration(@NotNullp0: KtNamedDeclaration, p1: Void): Void visitNamedFunction [jvm]open override fun visitNamedFunction(function: KtNamedFunction)override fun visitNamedFunction(@NotNullp0: KtNamedFunction, p1: Void): Void visitNullableType [jvm]open fun visitNullableType(@NotNullp0: KtNullableType)override fun visitNullableType(@NotNullp0: KtNullableType, p1: Void): Void visitObjectDeclaration [jvm]open fun visitObjectDeclaration(@NotNullp0: KtObjectDeclaration)override fun visitObjectDeclaration(@NotNullp0: KtObjectDeclaration, p1: Void): Void visitObjectLiteralExpression [jvm]open fun visitObjectLiteralExpression(@NotNullp0: KtObjectLiteralExpression)override fun visitObjectLiteralExpression(@NotNullp0: KtObjectLiteralExpression, p1: Void): Void visitOuterLanguageElement [jvm]open fun visitOuterLanguageElement(@NotNullp0: @NotNullOuterLanguageElement) visitPackageDirective [jvm]open fun visitPackageDirective(@NotNullp0: KtPackageDirective)open override fun visitPackageDirective(@NotNullp0: KtPackageDirective, p1: Void): Void visitParameter [jvm]open fun visitParameter(@NotNullp0: KtParameter)override fun visitParameter(@NotNullp0: KtParameter, p1: Void): Void visitParameterList [jvm]open fun visitParameterList(@NotNullp0: KtParameterList)override fun visitParameterList(@NotNullp0: KtParameterList, p1: Void): Void visitParenthesizedExpression [jvm]open fun visitParenthesizedExpression(@NotNullp0: KtParenthesizedExpression)override fun visitParenthesizedExpression(@NotNullp0: KtParenthesizedExpression, p1: Void): Void visitPlainText [jvm]open fun visitPlainText(@NotNullp0: @NotNullPsiPlainText) visitPlainTextFile [jvm]open fun visitPlainTextFile(@NotNullp0: @NotNullPsiPlainTextFile) visitPostfixExpression [jvm]open fun visitPostfixExpression(@NotNullp0: KtPostfixExpression)override fun visitPostfixExpression(@NotNullp0: KtPostfixExpression, p1: Void): Void visitPrefixExpression [jvm]open fun visitPrefixExpression(@NotNullp0: KtPrefixExpression)override fun visitPrefixExpression(@NotNullp0: KtPrefixExpression, p1: Void): Void visitPrimaryConstructor [jvm]open override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)override fun visitPrimaryConstructor(@NotNullp0: KtPrimaryConstructor, p1: Void): Void visitProperty [jvm]open fun visitProperty(@NotNullp0: KtProperty)override fun visitProperty(@NotNullp0: KtProperty, p1: Void): Void visitPropertyAccessor [jvm]open fun visitPropertyAccessor(@NotNullp0: KtPropertyAccessor)override fun visitPropertyAccessor(@NotNullp0: KtPropertyAccessor, p1: Void): Void visitPropertyDelegate [jvm]open fun visitPropertyDelegate(@NotNullp0: KtPropertyDelegate)override fun visitPropertyDelegate(@NotNullp0: KtPropertyDelegate, p1: Void): Void visitQualifiedExpression [jvm]open fun visitQualifiedExpression(@NotNullp0: KtQualifiedExpression)override fun visitQualifiedExpression(@NotNullp0: KtQualifiedExpression, p1: Void): Void visitReferenceExpression [jvm]open fun visitReferenceExpression(@NotNullp0: KtReferenceExpression)override fun visitReferenceExpression(@NotNullp0: KtReferenceExpression, p1: Void): Void visitReturnExpression [jvm]open fun visitReturnExpression(@NotNullp0: KtReturnExpression)override fun visitReturnExpression(@NotNullp0: KtReturnExpression, p1: Void): Void visitSafeQualifiedExpression [jvm]open fun visitSafeQualifiedExpression(@NotNullp0: KtSafeQualifiedExpression)override fun visitSafeQualifiedExpression(@NotNullp0: KtSafeQualifiedExpression, p1: Void): Void visitScript [jvm]open fun visitScript(@NotNullp0: KtScript)override fun visitScript(@NotNullp0: KtScript, p1: Void): Void visitScriptInitializer [jvm]open fun visitScriptInitializer(@NotNullp0: KtScriptInitializer)open override fun visitScriptInitializer(@NotNullp0: KtScriptInitializer, p1: Void): Void visitSecondaryConstructor [jvm]open fun visitSecondaryConstructor(@NotNullp0: KtSecondaryConstructor)override fun visitSecondaryConstructor(@NotNullp0: KtSecondaryConstructor, p1: Void): Void visitSelfType [jvm]open fun visitSelfType(@NotNullp0: KtSelfType)override fun visitSelfType(@NotNullp0: KtSelfType, p1: Void): Void visitSimpleNameExpression [jvm]open fun visitSimpleNameExpression(@NotNullp0: KtSimpleNameExpression)override fun visitSimpleNameExpression(@NotNullp0: KtSimpleNameExpression, p1: Void): Void visitSimpleNameStringTemplateEntry [jvm]open fun visitSimpleNameStringTemplateEntry(@NotNullp0: KtSimpleNameStringTemplateEntry)override fun visitSimpleNameStringTemplateEntry(@NotNullp0: KtSimpleNameStringTemplateEntry, p1: Void): Void visitStringTemplateEntry [jvm]open fun visitStringTemplateEntry(@NotNullp0: KtStringTemplateEntry)override fun visitStringTemplateEntry(@NotNullp0: KtStringTemplateEntry, p1: Void): Void visitStringTemplateEntryWithExpression [jvm]open fun visitStringTemplateEntryWithExpression(@NotNullp0: KtStringTemplateEntryWithExpression)override fun visitStringTemplateEntryWithExpression(@NotNullp0: KtStringTemplateEntryWithExpression, p1: Void): Void visitStringTemplateExpression [jvm]open fun visitStringTemplateExpression(@NotNullp0: KtStringTemplateExpression)override fun visitStringTemplateExpression(@NotNullp0: KtStringTemplateExpression, p1: Void): Void visitSuperExpression [jvm]open fun visitSuperExpression(@NotNullp0: KtSuperExpression)override fun visitSuperExpression(@NotNullp0: KtSuperExpression, p1: Void): Void visitSuperTypeCallEntry [jvm]open fun visitSuperTypeCallEntry(@NotNullp0: KtSuperTypeCallEntry)override fun visitSuperTypeCallEntry(@NotNullp0: KtSuperTypeCallEntry, p1: Void): Void visitSuperTypeEntry [jvm]open fun visitSuperTypeEntry(@NotNullp0: KtSuperTypeEntry)override fun visitSuperTypeEntry(@NotNullp0: KtSuperTypeEntry, p1: Void): Void visitSuperTypeList [jvm]open fun visitSuperTypeList(@NotNullp0: KtSuperTypeList)override fun visitSuperTypeList(@NotNullp0: KtSuperTypeList, p1: Void): Void visitSuperTypeListEntry [jvm]open fun visitSuperTypeListEntry(@NotNullp0: KtSuperTypeListEntry)override fun visitSuperTypeListEntry(@NotNullp0: KtSuperTypeListEntry, p1: Void): Void visitThisExpression [jvm]open fun visitThisExpression(@NotNullp0: KtThisExpression)override fun visitThisExpression(@NotNullp0: KtThisExpression, p1: Void): Void visitThrowExpression [jvm]open fun visitThrowExpression(@NotNullp0: KtThrowExpression)override fun visitThrowExpression(@NotNullp0: KtThrowExpression, p1: Void): Void visitTryExpression [jvm]open fun visitTryExpression(@NotNullp0: KtTryExpression)override fun visitTryExpression(@NotNullp0: KtTryExpression, p1: Void): Void visitTypeAlias [jvm]open fun visitTypeAlias(@NotNullp0: KtTypeAlias)override fun visitTypeAlias(@NotNullp0: KtTypeAlias, p1: Void): Void visitTypeArgumentList [jvm]open fun visitTypeArgumentList(@NotNullp0: KtTypeArgumentList)override fun visitTypeArgumentList(@NotNullp0: KtTypeArgumentList, p1: Void): Void visitTypeConstraint [jvm]open fun visitTypeConstraint(@NotNullp0: KtTypeConstraint)override fun visitTypeConstraint(@NotNullp0: KtTypeConstraint, p1: Void): Void visitTypeConstraintList [jvm]open fun visitTypeConstraintList(@NotNullp0: KtTypeConstraintList)override fun visitTypeConstraintList(@NotNullp0: KtTypeConstraintList, p1: Void): Void visitTypeParameter [jvm]open fun visitTypeParameter(@NotNullp0: KtTypeParameter)override fun visitTypeParameter(@NotNullp0: KtTypeParameter, p1: Void): Void visitTypeParameterList [jvm]open fun visitTypeParameterList(@NotNullp0: KtTypeParameterList)override fun visitTypeParameterList(@NotNullp0: KtTypeParameterList, p1: Void): Void visitTypeProjection [jvm]open fun visitTypeProjection(@NotNullp0: KtTypeProjection)override fun visitTypeProjection(@NotNullp0: KtTypeProjection, p1: Void): Void visitTypeReference [jvm]open fun visitTypeReference(@NotNullp0: KtTypeReference)override fun visitTypeReference(@NotNullp0: KtTypeReference, p1: Void): Void visitUnaryExpression [jvm]open fun visitUnaryExpression(@NotNullp0: KtUnaryExpression)override fun visitUnaryExpression(@NotNullp0: KtUnaryExpression, p1: Void): Void visitUserType [jvm]open fun visitUserType(@NotNullp0: KtUserType)override fun visitUserType(@NotNullp0: KtUserType, p1: Void): Void visitValueArgumentList [jvm]open fun visitValueArgumentList(@NotNullp0: KtValueArgumentList)override fun visitValueArgumentList(@NotNullp0: KtValueArgumentList, p1: Void): Void visitWhenConditionInRange [jvm]open fun visitWhenConditionInRange(@NotNullp0: KtWhenConditionInRange)override fun visitWhenConditionInRange(@NotNullp0: KtWhenConditionInRange, p1: Void): Void visitWhenConditionIsPattern [jvm]open fun visitWhenConditionIsPattern(@NotNullp0: KtWhenConditionIsPattern)override fun visitWhenConditionIsPattern(@NotNullp0: KtWhenConditionIsPattern, p1: Void): Void visitWhenConditionWithExpression [jvm]open fun visitWhenConditionWithExpression(@NotNullp0: KtWhenConditionWithExpression)override fun visitWhenConditionWithExpression(@NotNullp0: KtWhenConditionWithExpression, p1: Void): Void visitWhenEntry [jvm]open fun visitWhenEntry(@NotNullp0: KtWhenEntry)override fun visitWhenEntry(@NotNullp0: KtWhenEntry, p1: Void): Void visitWhenExpression [jvm]open fun visitWhenExpression(@NotNullp0: KtWhenExpression)override fun visitWhenExpression(@NotNullp0: KtWhenExpression, p1: Void): Void visitWhileExpression [jvm]open fun visitWhileExpression(@NotNullp0: KtWhileExpression)override fun visitWhileExpression(@NotNullp0: KtWhileExpression, p1: Void): Void visitWhiteSpace [jvm]open fun visitWhiteSpace(@NotNullp0: @NotNullPsiWhiteSpace) withAutoCorrect [jvm]open fun withAutoCorrect(block: () -> Unit)"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-annotate-public-apis-with-jvm-overloads/","title":"AnnotatePublicApisWithJvmOverloads - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/AnnotatePublicApisWithJvmOverloads
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-annotate-public-apis-with-jvm-overloads/#annotatepublicapiswithjvmoverloads","title":"AnnotatePublicApisWithJvmOverloads","text":"[jvm]\\ constructor(config: Config)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/issue/","title":"issue - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/issue
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/issue/#issue","title":"issue","text":"[jvm]\\ open override val issue: Issue
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-named-function/","title":"visitNamedFunction - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/visitNamedFunction
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-named-function/#visitnamedfunction","title":"visitNamedFunction","text":"[jvm]\\ open override fun visitNamedFunction(function: KtNamedFunction)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-primary-constructor/","title":"visitPrimaryConstructor - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/visitPrimaryConstructor
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/visit-primary-constructor/#visitprimaryconstructor","title":"visitPrimaryConstructor","text":"[jvm]\\ open override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/","title":"ElementType - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#elementtype","title":"ElementType","text":"[jvm]\\ enum ElementType : Enum<AnnotatePublicApisWithJvmOverloads.ElementType>
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#entries","title":"Entries","text":"FUNCTION [jvm]FUNCTION CONSTRUCTOR [jvm]CONSTRUCTOR"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AnnotatePublicApisWithJvmOverloads.ElementType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AnnotatePublicApisWithJvmOverloads.ElementTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AnnotatePublicApisWithJvmOverloads.ElementType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/entries/","title":"entries - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/entries
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AnnotatePublicApisWithJvmOverloads.ElementType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/","title":"valueOf - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/valueOf
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AnnotatePublicApisWithJvmOverloads.ElementType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/values/","title":"values - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/values
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AnnotatePublicApisWithJvmOverloads.ElementType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/","title":"CONSTRUCTOR - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/CONSTRUCTOR
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/#constructor","title":"CONSTRUCTOR","text":"[jvm]\\ CONSTRUCTOR
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-c-o-n-s-t-r-u-c-t-o-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/","title":"FUNCTION - Misk","text":"//detektive/cash.detektive.javacompat/AnnotatePublicApisWithJvmOverloads/ElementType/FUNCTION
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/#function","title":"FUNCTION","text":"[jvm]\\ FUNCTION
"},{"location":"0.x/detektive/detektive/cash.detektive.javacompat/-annotate-public-apis-with-jvm-overloads/-element-type/-f-u-n-c-t-i-o-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/exemplar/","title":"exemplar - Misk","text":"//exemplar
"},{"location":"0.x/exemplar/#exemplar","title":"exemplar","text":""},{"location":"0.x/exemplar/#packages","title":"Packages","text":"Name com.squareup.exemplar com.squareup.exemplar.actions com.squareup.exemplar.dashboard com.squareup.exemplar.dashboard.admin com.squareup.exemplar.dashboard.frontend com.squareup.exemplar.dashboard.support"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#types","title":"Types","text":"Name Summary AnotherServiceImpl [jvm]class AnotherServiceImpl : Service DinoMetadata [jvm]data class DinoMetadata(val dinos: List<String>) : Metadata DinoMetadataProvider [jvm]class DinoMetadataProvider : MetadataProvider<Metadata> ExemplarAccessModule [jvm]class ExemplarAccessModule : KAbstractModule ExemplarConfig [jvm]data class ExemplarConfig(val apiKey: Secret<String>, val web: WebConfig, val prometheus: PrometheusConfig, val redacted: String) : Config ExemplarCronModule [jvm]class ExemplarCronModule : KAbstractModule ExemplarGuiceBindingsModule [jvm]class ExemplarGuiceBindingsModule : KAbstractModule ExemplarJavaApp [jvm]open class ExemplarJavaApp ExemplarJavaConfig [jvm]open class ExemplarJavaConfig : Config ExemplarJavaModule [jvm]open class ExemplarJavaModule : AbstractModule ExemplarLogging [jvm]object ExemplarLogging ExemplarMetadataModule [jvm]class ExemplarMetadataModule : KAbstractModule ExemplarWebActionsModule [jvm]class ExemplarWebActionsModule : KAbstractModule HelloJavaAction [jvm]@Singletonopen class HelloJavaAction : WebAction Service [jvm]interface Service ServiceImpl [jvm]class ServiceImpl : Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/#functions","title":"Functions","text":"Name Summary main [jvm]fun main(args: Array<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/main/","title":"main - Misk","text":"//exemplar/com.squareup.exemplar/main
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/main/#main","title":"main","text":"[jvm]\\ fun main(args: Array<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/","title":"AnotherServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/AnotherServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#anotherserviceimpl","title":"AnotherServiceImpl","text":"[jvm]\\ class AnotherServiceImpl : Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#constructors","title":"Constructors","text":"AnotherServiceImpl [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/-another-service-impl/","title":"AnotherServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/AnotherServiceImpl/AnotherServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/-another-service-impl/#anotherserviceimpl","title":"AnotherServiceImpl","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/execute/","title":"execute - Misk","text":"//exemplar/com.squareup.exemplar/AnotherServiceImpl/execute
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-another-service-impl/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/","title":"DinoMetadata - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#dinometadata","title":"DinoMetadata","text":"[jvm]\\ data class DinoMetadata(val dinos: List<String>) : Metadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#constructors","title":"Constructors","text":"DinoMetadata [jvm]constructor(dinos: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String dinos [jvm]val dinos: List<String> metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open override fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/-dino-metadata/","title":"DinoMetadata - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata/DinoMetadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/-dino-metadata/#dinometadata","title":"DinoMetadata","text":"[jvm]\\ constructor(dinos: List<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/content-block/","title":"contentBlock - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata/contentBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/content-block/#contentblock","title":"contentBlock","text":"[jvm]\\ open override fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/dinos/","title":"dinos - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadata/dinos
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata/dinos/#dinos","title":"dinos","text":"[jvm]\\ val dinos: List<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/","title":"DinoMetadataProvider - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#dinometadataprovider","title":"DinoMetadataProvider","text":"[jvm]\\ class DinoMetadataProvider : MetadataProvider<Metadata>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#constructors","title":"Constructors","text":"DinoMetadataProvider [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DinoMetadata"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/-dino-metadata-provider/","title":"DinoMetadataProvider - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider/DinoMetadataProvider
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/-dino-metadata-provider/#dinometadataprovider","title":"DinoMetadataProvider","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DinoMetadata
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/id/","title":"id - Misk","text":"//exemplar/com.squareup.exemplar/DinoMetadataProvider/id
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-dino-metadata-provider/id/#id","title":"id","text":"[jvm]\\ open override val id: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/","title":"ExemplarAccessModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarAccessModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#exemplaraccessmodule","title":"ExemplarAccessModule","text":"[jvm]\\ class ExemplarAccessModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#constructors","title":"Constructors","text":"ExemplarAccessModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/-exemplar-access-module/","title":"ExemplarAccessModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarAccessModule/ExemplarAccessModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-access-module/-exemplar-access-module/#exemplaraccessmodule","title":"ExemplarAccessModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/","title":"ExemplarConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#exemplarconfig","title":"ExemplarConfig","text":"[jvm]\\ data class ExemplarConfig(val apiKey: Secret<String>, val web: WebConfig, val prometheus: PrometheusConfig, val redacted: String) : Config
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#constructors","title":"Constructors","text":"ExemplarConfig [jvm]constructor(apiKey: Secret<String>, web: WebConfig, prometheus: PrometheusConfig, redacted: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/#properties","title":"Properties","text":"Name Summary apiKey [jvm]val apiKey: Secret<String> prometheus [jvm]val prometheus: PrometheusConfig redacted [jvm]val redacted: String web [jvm]val web: WebConfig"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/-exemplar-config/","title":"ExemplarConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/ExemplarConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/-exemplar-config/#exemplarconfig","title":"ExemplarConfig","text":"[jvm]\\ constructor(apiKey: Secret<String>, web: WebConfig, prometheus: PrometheusConfig, redacted: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/api-key/","title":"apiKey - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/apiKey
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/api-key/#apikey","title":"apiKey","text":"[jvm]\\ val apiKey: Secret<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/prometheus/","title":"prometheus - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/prometheus
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/prometheus/#prometheus","title":"prometheus","text":"[jvm]\\ val prometheus: PrometheusConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/redacted/","title":"redacted - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/redacted
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/redacted/#redacted","title":"redacted","text":"[jvm]\\ val redacted: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/web/","title":"web - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarConfig/web
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-config/web/#web","title":"web","text":"[jvm]\\ val web: WebConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/","title":"ExemplarCronModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#exemplarcronmodule","title":"ExemplarCronModule","text":"[jvm]\\ class ExemplarCronModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#constructors","title":"Constructors","text":"ExemplarCronModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#types","title":"Types","text":"Name Summary MinuteCron [jvm]@Singletonclass MinuteCron@Injectconstructor : Runnable"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-exemplar-cron-module/","title":"ExemplarCronModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/ExemplarCronModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-exemplar-cron-module/#exemplarcronmodule","title":"ExemplarCronModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/","title":"MinuteCron - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#minutecron","title":"MinuteCron","text":"[jvm]\\ @Singleton
class MinuteCron@Injectconstructor : Runnable
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#constructors","title":"Constructors","text":"MinuteCron [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#properties","title":"Properties","text":"Name Summary counter [jvm]var counter: Int"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/#functions","title":"Functions","text":"Name Summary run [jvm]open override fun run()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-minute-cron/","title":"MinuteCron - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/MinuteCron
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-minute-cron/#minutecron","title":"MinuteCron","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/counter/","title":"counter - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/counter
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/counter/#counter","title":"counter","text":"[jvm]\\ var counter: Int
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/run/","title":"run - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/run
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/run/#run","title":"run","text":"[jvm]\\ open override fun run()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/log/","title":"log - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarCronModule/MinuteCron/Companion/log
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-cron-module/-minute-cron/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/","title":"ExemplarGuiceBindingsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#exemplarguicebindingsmodule","title":"ExemplarGuiceBindingsModule","text":"[jvm]\\ class ExemplarGuiceBindingsModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#constructors","title":"Constructors","text":"ExemplarGuiceBindingsModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideYetAnotherService [jvm]@Providesfun provideYetAnotherService(): Service"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-exemplar-guice-bindings-module/","title":"ExemplarGuiceBindingsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/ExemplarGuiceBindingsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/-exemplar-guice-bindings-module/#exemplarguicebindingsmodule","title":"ExemplarGuiceBindingsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/provide-yet-another-service/","title":"provideYetAnotherService - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarGuiceBindingsModule/provideYetAnotherService
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-guice-bindings-module/provide-yet-another-service/#provideyetanotherservice","title":"provideYetAnotherService","text":"[jvm]\\
@Provides
fun provideYetAnotherService(): Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/","title":"ExemplarJavaApp - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaApp
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#exemplarjavaapp","title":"ExemplarJavaApp","text":"[jvm]\\ open class ExemplarJavaApp
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#constructors","title":"Constructors","text":"ExemplarJavaApp [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/#functions","title":"Functions","text":"Name Summary main [jvm]open fun main(args: Array<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/-exemplar-java-app/","title":"ExemplarJavaApp - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaApp/ExemplarJavaApp
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/-exemplar-java-app/#exemplarjavaapp","title":"ExemplarJavaApp","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/main/","title":"main - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaApp/main
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-app/main/#main","title":"main","text":"[jvm]\\ open fun main(args: Array<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/","title":"ExemplarJavaConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#exemplarjavaconfig","title":"ExemplarJavaConfig","text":"[jvm]\\ open class ExemplarJavaConfig : Config
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#constructors","title":"Constructors","text":"ExemplarJavaConfig [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/#properties","title":"Properties","text":"Name Summary web [jvm]open var web: WebConfig"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/-exemplar-java-config/","title":"ExemplarJavaConfig - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaConfig/ExemplarJavaConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/-exemplar-java-config/#exemplarjavaconfig","title":"ExemplarJavaConfig","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/web/","title":"web - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaConfig/web
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-config/web/#web","title":"web","text":"[jvm]\\ open var web: WebConfig
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/","title":"ExemplarJavaModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#exemplarjavamodule","title":"ExemplarJavaModule","text":"[jvm]\\ open class ExemplarJavaModule : AbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#constructors","title":"Constructors","text":"ExemplarJavaModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/-exemplar-java-module/","title":"ExemplarJavaModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarJavaModule/ExemplarJavaModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-java-module/-exemplar-java-module/#exemplarjavamodule","title":"ExemplarJavaModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/","title":"ExemplarLogging - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarLogging
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/#exemplarlogging","title":"ExemplarLogging","text":"[jvm]\\ object ExemplarLogging
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/configure/","title":"configure - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarLogging/configure
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-logging/configure/#configure","title":"configure","text":"[jvm]\\ fun configure()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/","title":"ExemplarMetadataModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarMetadataModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#exemplarmetadatamodule","title":"ExemplarMetadataModule","text":"[jvm]\\ class ExemplarMetadataModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#constructors","title":"Constructors","text":"ExemplarMetadataModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/-exemplar-metadata-module/","title":"ExemplarMetadataModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarMetadataModule/ExemplarMetadataModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-metadata-module/-exemplar-metadata-module/#exemplarmetadatamodule","title":"ExemplarMetadataModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/","title":"ExemplarWebActionsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarWebActionsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#exemplarwebactionsmodule","title":"ExemplarWebActionsModule","text":"[jvm]\\ class ExemplarWebActionsModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#constructors","title":"Constructors","text":"ExemplarWebActionsModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/-exemplar-web-actions-module/","title":"ExemplarWebActionsModule - Misk","text":"//exemplar/com.squareup.exemplar/ExemplarWebActionsModule/ExemplarWebActionsModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-exemplar-web-actions-module/-exemplar-web-actions-module/#exemplarwebactionsmodule","title":"ExemplarWebActionsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/","title":"HelloJavaAction - Misk","text":"//exemplar/com.squareup.exemplar/HelloJavaAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#hellojavaaction","title":"HelloJavaAction","text":"[jvm]\\ @Singleton
open class HelloJavaAction : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#constructors","title":"Constructors","text":"HelloJavaAction [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/#functions","title":"Functions","text":"Name Summary hello [jvm]open fun hello(name: String, headers: Headers): HelloJavaAction.HelloJavaResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/-hello-java-action/","title":"HelloJavaAction - Misk","text":"//exemplar/com.squareup.exemplar/HelloJavaAction/HelloJavaAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/-hello-java-action/#hellojavaaction","title":"HelloJavaAction","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar/HelloJavaAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-hello-java-action/hello/#hello","title":"hello","text":"[jvm]\\ open fun hello(name: String, headers: Headers): HelloJavaAction.HelloJavaResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/","title":"Service - Misk","text":"//exemplar/com.squareup.exemplar/Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#service","title":"Service","text":"interface Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#inheritors","title":"Inheritors","text":"ServiceImpl AnotherServiceImpl"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/#functions","title":"Functions","text":"Name Summary execute [jvm]abstract fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/execute/","title":"execute - Misk","text":"//exemplar/com.squareup.exemplar/Service/execute
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service/execute/#execute","title":"execute","text":"[jvm]\\ abstract fun execute(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/","title":"ServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/ServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#serviceimpl","title":"ServiceImpl","text":"[jvm]\\ class ServiceImpl : Service
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#constructors","title":"Constructors","text":"ServiceImpl [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/#functions","title":"Functions","text":"Name Summary execute [jvm]open override fun execute(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/-service-impl/","title":"ServiceImpl - Misk","text":"//exemplar/com.squareup.exemplar/ServiceImpl/ServiceImpl
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/-service-impl/#serviceimpl","title":"ServiceImpl","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/execute/","title":"execute - Misk","text":"//exemplar/com.squareup.exemplar/ServiceImpl/execute
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar/-service-impl/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.actions
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/#types","title":"Types","text":"Name Summary DownloadAFileWebAction [jvm]@Singletonclass DownloadAFileWebAction@Injectconstructor : WebAction EchoFormAction [jvm]@Singletonclass EchoFormAction@Injectconstructor : WebAction ExampleRateLimitConfiguration [jvm]object ExampleRateLimitConfiguration : RateLimitConfiguration HelloPostResponse [jvm]data class HelloPostResponse(val greeting: String, val name: String) HelloResponse [jvm]data class HelloResponse(val greeting: String, val name: String) HelloWebAction [jvm]@Singletonclass HelloWebAction@Injectconstructor(tokenGenerator: TokenGenerator) : WebAction HelloWebPostAction [jvm]@Singletonclass HelloWebPostAction@Injectconstructor : WebAction HelloWebProtoAction [jvm]class HelloWebProtoAction@Injectconstructor : WebAction PostBody [jvm]data class PostBody(val greeting: String) RateLimitedAction [jvm]@Singletonclass RateLimitedAction@Injectconstructor(rateLimiter: RateLimiter) RateLimitedExampleResponse [jvm]data class RateLimitedExampleResponse(val number: Long)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/","title":"DownloadAFileWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#downloadafilewebaction","title":"DownloadAFileWebAction","text":"[jvm]\\ @Singleton
class DownloadAFileWebAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#constructors","title":"Constructors","text":"DownloadAFileWebAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/#functions","title":"Functions","text":"Name Summary download [jvm]fun download(name: String): Response<String>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/-download-a-file-web-action/","title":"DownloadAFileWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction/DownloadAFileWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/-download-a-file-web-action/#downloadafilewebaction","title":"DownloadAFileWebAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/download/","title":"download - Misk","text":"//exemplar/com.squareup.exemplar.actions/DownloadAFileWebAction/download
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-download-a-file-web-action/download/#download","title":"download","text":"[jvm]\\ fun download(name: String): Response<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/","title":"EchoFormAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#echoformaction","title":"EchoFormAction","text":"[jvm]\\ @Singleton
class EchoFormAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#constructors","title":"Constructors","text":"EchoFormAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#types","title":"Types","text":"Name Summary Form [jvm]data class Form(val string: String, val int: Int, val nullable: String?, val optional: String = \"optional\", val list: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/#functions","title":"Functions","text":"Name Summary echo [jvm]fun echo(form: EchoFormAction.Form): EchoFormAction.Form"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-echo-form-action/","title":"EchoFormAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/EchoFormAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-echo-form-action/#echoformaction","title":"EchoFormAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/echo/","title":"echo - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/echo
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/echo/#echo","title":"echo","text":"[jvm]\\ fun echo(form: EchoFormAction.Form): EchoFormAction.Form
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/","title":"Form - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#form","title":"Form","text":"[jvm]\\ data class Form(val string: String, val int: Int, val nullable: String?, val optional: String = \"optional\", val list: List<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#constructors","title":"Constructors","text":"Form [jvm]constructor(string: String, int: Int, nullable: String?, optional: String = \"optional\", list: List<String>)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/#properties","title":"Properties","text":"Name Summary int [jvm]val int: Int list [jvm]val list: List<String> nullable [jvm]val nullable: String? optional [jvm]val optional: String string [jvm]val string: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/-form/","title":"Form - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/Form
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/-form/#form","title":"Form","text":"[jvm]\\ constructor(string: String, int: Int, nullable: String?, optional: String = \"optional\", list: List<String>)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/int/","title":"int - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/int
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/int/#int","title":"int","text":"[jvm]\\ val int: Int
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/list/","title":"list - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/list
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/list/#list","title":"list","text":"[jvm]\\ val list: List<String>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/nullable/","title":"nullable - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/nullable
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/nullable/#nullable","title":"nullable","text":"[jvm]\\ val nullable: String?
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/optional/","title":"optional - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/optional
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/optional/#optional","title":"optional","text":"[jvm]\\ val optional: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/string/","title":"string - Misk","text":"//exemplar/com.squareup.exemplar.actions/EchoFormAction/Form/string
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-echo-form-action/-form/string/#string","title":"string","text":"[jvm]\\ val string: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/","title":"ExampleRateLimitConfiguration - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/#exampleratelimitconfiguration","title":"ExampleRateLimitConfiguration","text":"[jvm]\\ object ExampleRateLimitConfiguration : RateLimitConfiguration
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/#properties","title":"Properties","text":"Name Summary capacity [jvm]open override val capacity: Long = 10 name [jvm]open override val name: String refillAmount [jvm]open override val refillAmount: Long = 10 refillPeriod [jvm]open override val refillPeriod: Duration"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/capacity/","title":"capacity - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/capacity
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/capacity/#capacity","title":"capacity","text":"[jvm]\\ open override val capacity: Long = 10
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/name/","title":"name - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/name
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/name/#name","title":"name","text":"[jvm]\\ open override val name: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-amount/","title":"refillAmount - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/refillAmount
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-amount/#refillamount","title":"refillAmount","text":"[jvm]\\ open override val refillAmount: Long = 10
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-period/","title":"refillPeriod - Misk","text":"//exemplar/com.squareup.exemplar.actions/ExampleRateLimitConfiguration/refillPeriod
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-example-rate-limit-configuration/refill-period/#refillperiod","title":"refillPeriod","text":"[jvm]\\ open override val refillPeriod: Duration
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/","title":"HelloPostResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#hellopostresponse","title":"HelloPostResponse","text":"[jvm]\\ data class HelloPostResponse(val greeting: String, val name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#constructors","title":"Constructors","text":"HelloPostResponse [jvm]constructor(greeting: String, name: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String name [jvm]val name: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/-hello-post-response/","title":"HelloPostResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse/HelloPostResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/-hello-post-response/#hellopostresponse","title":"HelloPostResponse","text":"[jvm]\\ constructor(greeting: String, name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/greeting/","title":"greeting - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse/greeting
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/greeting/#greeting","title":"greeting","text":"[jvm]\\ val greeting: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/name/","title":"name - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloPostResponse/name
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-post-response/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/","title":"HelloResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#helloresponse","title":"HelloResponse","text":"[jvm]\\ data class HelloResponse(val greeting: String, val name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#constructors","title":"Constructors","text":"HelloResponse [jvm]constructor(greeting: String, name: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String name [jvm]val name: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/-hello-response/","title":"HelloResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse/HelloResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/-hello-response/#helloresponse","title":"HelloResponse","text":"[jvm]\\ constructor(greeting: String, name: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/greeting/","title":"greeting - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse/greeting
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/greeting/#greeting","title":"greeting","text":"[jvm]\\ val greeting: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/name/","title":"name - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloResponse/name
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-response/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/","title":"HelloWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#hellowebaction","title":"HelloWebAction","text":"[jvm]\\ @Singleton
class HelloWebAction@Injectconstructor(tokenGenerator: TokenGenerator) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#constructors","title":"Constructors","text":"HelloWebAction [jvm]@Injectconstructor(tokenGenerator: TokenGenerator)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(name: String, headers: Headers, nickName: String?, greetings: List<String>?): HelloResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/-hello-web-action/","title":"HelloWebAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebAction/HelloWebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/-hello-web-action/#hellowebaction","title":"HelloWebAction","text":"[jvm]\\
@Inject
constructor(tokenGenerator: TokenGenerator)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-action/hello/#hello","title":"hello","text":"[jvm]\\ fun hello(name: String, headers: Headers, nickName: String?, greetings: List<String>?): HelloResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/","title":"HelloWebPostAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebPostAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#hellowebpostaction","title":"HelloWebPostAction","text":"[jvm]\\ @Singleton
class HelloWebPostAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#constructors","title":"Constructors","text":"HelloWebPostAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(name: String, body: PostBody): HelloPostResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/-hello-web-post-action/","title":"HelloWebPostAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebPostAction/HelloWebPostAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/-hello-web-post-action/#hellowebpostaction","title":"HelloWebPostAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebPostAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-post-action/hello/#hello","title":"hello","text":"[jvm]\\ fun hello(name: String, body: PostBody): HelloPostResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/","title":"HelloWebProtoAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#hellowebprotoaction","title":"HelloWebProtoAction","text":"[jvm]\\ class HelloWebProtoAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#constructors","title":"Constructors","text":"HelloWebProtoAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/#functions","title":"Functions","text":"Name Summary hello [jvm]fun hello(request: HelloWebRequest): Response<HelloWebResponse>"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/-hello-web-proto-action/","title":"HelloWebProtoAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction/HelloWebProtoAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/-hello-web-proto-action/#hellowebprotoaction","title":"HelloWebProtoAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/hello/","title":"hello - Misk","text":"//exemplar/com.squareup.exemplar.actions/HelloWebProtoAction/hello
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-hello-web-proto-action/hello/#hello","title":"hello","text":"[jvm]\\ fun hello(request: HelloWebRequest): Response<HelloWebResponse>
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/","title":"PostBody - Misk","text":"//exemplar/com.squareup.exemplar.actions/PostBody
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#postbody","title":"PostBody","text":"[jvm]\\ data class PostBody(val greeting: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#constructors","title":"Constructors","text":"PostBody [jvm]constructor(greeting: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/#properties","title":"Properties","text":"Name Summary greeting [jvm]val greeting: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/-post-body/","title":"PostBody - Misk","text":"//exemplar/com.squareup.exemplar.actions/PostBody/PostBody
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/-post-body/#postbody","title":"PostBody","text":"[jvm]\\ constructor(greeting: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/greeting/","title":"greeting - Misk","text":"//exemplar/com.squareup.exemplar.actions/PostBody/greeting
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-post-body/greeting/#greeting","title":"greeting","text":"[jvm]\\ val greeting: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/","title":"RateLimitedAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#ratelimitedaction","title":"RateLimitedAction","text":"[jvm]\\ @Singleton
class RateLimitedAction@Injectconstructor(rateLimiter: RateLimiter)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#constructors","title":"Constructors","text":"RateLimitedAction [jvm]@Injectconstructor(rateLimiter: RateLimiter)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/#functions","title":"Functions","text":"Name Summary rateLimitedExample [jvm]fun rateLimitedExample(): RateLimitedExampleResponse"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/-rate-limited-action/","title":"RateLimitedAction - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedAction/RateLimitedAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/-rate-limited-action/#ratelimitedaction","title":"RateLimitedAction","text":"[jvm]\\
@Inject
constructor(rateLimiter: RateLimiter)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/rate-limited-example/","title":"rateLimitedExample - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedAction/rateLimitedExample
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-action/rate-limited-example/#ratelimitedexample","title":"rateLimitedExample","text":"[jvm]\\ fun rateLimitedExample(): RateLimitedExampleResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/","title":"RateLimitedExampleResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#ratelimitedexampleresponse","title":"RateLimitedExampleResponse","text":"[jvm]\\ data class RateLimitedExampleResponse(val number: Long)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#constructors","title":"Constructors","text":"RateLimitedExampleResponse [jvm]constructor(number: Long)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/#properties","title":"Properties","text":"Name Summary number [jvm]val number: Long"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/-rate-limited-example-response/","title":"RateLimitedExampleResponse - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse/RateLimitedExampleResponse
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/-rate-limited-example-response/#ratelimitedexampleresponse","title":"RateLimitedExampleResponse","text":"[jvm]\\ constructor(number: Long)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/number/","title":"number - Misk","text":"//exemplar/com.squareup.exemplar.actions/RateLimitedExampleResponse/number
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.actions/-rate-limited-example-response/number/#number","title":"number","text":"[jvm]\\ val number: Long
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/#types","title":"Types","text":"Name Summary ExemplarDashboardModule [jvm]class ExemplarDashboardModule : KAbstractModule SupportDashboard [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class SupportDashboardDashboard Annotation used for all tabs bound in the Exemplar service support dashboard. SupportDashboardAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class SupportDashboardAccessAccess for the support dashboard."},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/","title":"ExemplarDashboardModule - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/ExemplarDashboardModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#exemplardashboardmodule","title":"ExemplarDashboardModule","text":"[jvm]\\ class ExemplarDashboardModule : KAbstractModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#constructors","title":"Constructors","text":"ExemplarDashboardModule [jvm]constructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/-exemplar-dashboard-module/","title":"ExemplarDashboardModule - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/ExemplarDashboardModule/ExemplarDashboardModule
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-exemplar-dashboard-module/-exemplar-dashboard-module/#exemplardashboardmodule","title":"ExemplarDashboardModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard/","title":"SupportDashboard - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/SupportDashboard
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard/#supportdashboard","title":"SupportDashboard","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])
annotation class SupportDashboard
Dashboard Annotation used for all tabs bound in the Exemplar service support dashboard.
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard-access/","title":"SupportDashboardAccess - Misk","text":"//exemplar/com.squareup.exemplar.dashboard/SupportDashboardAccess
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard/-support-dashboard-access/#supportdashboardaccess","title":"SupportDashboardAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class SupportDashboardAccess
Access for the support dashboard.
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#types","title":"Types","text":"Name Summary AlphaIndexAction [jvm]@Singletonclass AlphaIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/#properties","title":"Properties","text":"Name Summary dashboardIndexAccessBlock [jvm]val dashboardIndexAccessBlock: DashboardIndexAccessBlock dashboardIndexBlock1 [jvm]val dashboardIndexBlock1: DashboardIndexBlock dashboardIndexBlock2 [jvm]val dashboardIndexBlock2: DashboardIndexBlock"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-access-block/","title":"dashboardIndexAccessBlock - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexAccessBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-access-block/#dashboardindexaccessblock","title":"dashboardIndexAccessBlock","text":"[jvm]\\ val dashboardIndexAccessBlock: DashboardIndexAccessBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block1/","title":"dashboardIndexBlock1 - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexBlock1
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block1/#dashboardindexblock1","title":"dashboardIndexBlock1","text":"[jvm]\\ val dashboardIndexBlock1: DashboardIndexBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block2/","title":"dashboardIndexBlock2 - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/dashboardIndexBlock2
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/dashboard-index-block2/#dashboardindexblock2","title":"dashboardIndexBlock2","text":"[jvm]\\ val dashboardIndexBlock2: DashboardIndexBlock
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/","title":"AlphaIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#alphaindexaction","title":"AlphaIndexAction","text":"[jvm]\\ @Singleton
class AlphaIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#constructors","title":"Constructors","text":"AlphaIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-alpha-index-action/","title":"AlphaIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/AlphaIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-alpha-index-action/#alphaindexaction","title":"AlphaIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.admin/AlphaIndexAction/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.admin/-alpha-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/#types","title":"Types","text":"Name Summary EcommerceLandingPage [jvm]@Singletonclass EcommerceLandingPage@Injectconstructor(appName: String, deployment: Deployment) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages GraphD3JsPage [jvm]@Singletonclass GraphD3JsPage@Injectconstructor : WebActionExample page that shows usage of D3.js graph library https://d3js.org/ IndexPage [jvm]@Singletonclass IndexPage@Injectconstructor(appName: String, deployment: Deployment) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages SimplePage [jvm]@Singletonclass SimplePage@Injectconstructor(appName: String) : WebActionExample page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/","title":"EcommerceLandingPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#ecommercelandingpage","title":"EcommerceLandingPage","text":"[jvm]\\ @Singleton
class EcommerceLandingPage@Injectconstructor(appName: String, deployment: Deployment) : WebAction
Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#constructors","title":"Constructors","text":"EcommerceLandingPage [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-ecommerce-landing-page/","title":"EcommerceLandingPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/EcommerceLandingPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-ecommerce-landing-page/#ecommercelandingpage","title":"EcommerceLandingPage","text":"[jvm]\\
@Inject
constructor(appName: String, deployment: Deployment)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/EcommerceLandingPage/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-ecommerce-landing-page/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/","title":"GraphD3JsPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#graphd3jspage","title":"GraphD3JsPage","text":"[jvm]\\ @Singleton
class GraphD3JsPage@Injectconstructor : WebAction
Example page that shows usage of D3.js graph library https://d3js.org/
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#constructors","title":"Constructors","text":"GraphD3JsPage [jvm]@Injectconstructor()"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-graph-d3-js-page/","title":"GraphD3JsPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/GraphD3JsPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-graph-d3-js-page/#graphd3jspage","title":"GraphD3JsPage","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/GraphD3JsPage/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-graph-d3-js-page/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/","title":"IndexPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#indexpage","title":"IndexPage","text":"[jvm]\\ @Singleton
class IndexPage@Injectconstructor(appName: String, deployment: Deployment) : WebAction
Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#constructors","title":"Constructors","text":"IndexPage [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/-index-page/","title":"IndexPage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage/IndexPage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/-index-page/#indexpage","title":"IndexPage","text":"[jvm]\\
@Inject
constructor(appName: String, deployment: Deployment)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/IndexPage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-index-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/","title":"SimplePage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#simplepage","title":"SimplePage","text":"[jvm]\\ @Singleton
class SimplePage@Injectconstructor(appName: String) : WebAction
Example page from Tailwind UI https://tailwindui.com/components/ecommerce/page-examples/storefront-pages
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#constructors","title":"Constructors","text":"SimplePage [jvm]@Injectconstructor(appName: String)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-simple-page/","title":"SimplePage - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/SimplePage
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-simple-page/#simplepage","title":"SimplePage","text":"[jvm]\\
@Inject
constructor(appName: String)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/","title":"Companion - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.frontend/SimplePage/Companion/PATH
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.frontend/-simple-page/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/","title":"Package-level declarations - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/#types","title":"Types","text":"Name Summary SupportBravoIndexAction [jvm]@Singletonclass SupportBravoIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction SupportDashboardIndexAction [jvm]@Singletonclass SupportDashboardIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/","title":"SupportBravoIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#supportbravoindexaction","title":"SupportBravoIndexAction","text":"[jvm]\\ @Singleton
class SupportBravoIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#constructors","title":"Constructors","text":"SupportBravoIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/-support-bravo-index-action/","title":"SupportBravoIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction/SupportBravoIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/-support-bravo-index-action/#supportbravoindexaction","title":"SupportBravoIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportBravoIndexAction/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-bravo-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/","title":"SupportDashboardIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#supportdashboardindexaction","title":"SupportDashboardIndexAction","text":"[jvm]\\ @Singleton
class SupportDashboardIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout) : WebAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#constructors","title":"Constructors","text":"SupportDashboardIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout)"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/-support-dashboard-index-action/","title":"SupportDashboardIndexAction - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction/SupportDashboardIndexAction
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/-support-dashboard-index-action/#supportdashboardindexaction","title":"SupportDashboardIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout)
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/get/","title":"get - Misk","text":"//exemplar/com.squareup.exemplar.dashboard.support/SupportDashboardIndexAction/get
"},{"location":"0.x/exemplar/exemplar/com.squareup.exemplar.dashboard.support/-support-dashboard-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/exemplarchat/","title":"exemplarchat - Misk","text":"//exemplarchat
"},{"location":"0.x/exemplarchat/#exemplarchat","title":"exemplarchat","text":""},{"location":"0.x/exemplarchat/#packages","title":"Packages","text":"Name com.squareup.chat com.squareup.chat.actions com.squareup.chat.healthchecks"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/","title":"Package-level declarations - Misk","text":"//exemplarchat/com.squareup.chat
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#types","title":"Types","text":"Name Summary ChatConfig [jvm]data class ChatConfig(val web: WebConfig, val prometheus: PrometheusConfig, val kubernetes: KubernetesConfig = KubernetesConfig()) : Config ChatLogging [jvm]object ChatLogging ChatModule [jvm]class ChatModule : KAbstractModule"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/#functions","title":"Functions","text":"Name Summary main [jvm]fun main(args: Array<String>)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/main/","title":"main - Misk","text":"//exemplarchat/com.squareup.chat/main
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/main/#main","title":"main","text":"[jvm]\\ fun main(args: Array<String>)
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/","title":"ChatConfig - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#chatconfig","title":"ChatConfig","text":"[jvm]\\ data class ChatConfig(val web: WebConfig, val prometheus: PrometheusConfig, val kubernetes: KubernetesConfig = KubernetesConfig()) : Config
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#constructors","title":"Constructors","text":"ChatConfig [jvm]constructor(web: WebConfig, prometheus: PrometheusConfig, kubernetes: KubernetesConfig = KubernetesConfig())"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/#properties","title":"Properties","text":"Name Summary kubernetes [jvm]val kubernetes: KubernetesConfig prometheus [jvm]val prometheus: PrometheusConfig web [jvm]val web: WebConfig"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/-chat-config/","title":"ChatConfig - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/ChatConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/-chat-config/#chatconfig","title":"ChatConfig","text":"[jvm]\\ constructor(web: WebConfig, prometheus: PrometheusConfig, kubernetes: KubernetesConfig = KubernetesConfig())
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/kubernetes/","title":"kubernetes - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/kubernetes
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/kubernetes/#kubernetes","title":"kubernetes","text":"[jvm]\\ val kubernetes: KubernetesConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/prometheus/","title":"prometheus - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/prometheus
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/prometheus/#prometheus","title":"prometheus","text":"[jvm]\\ val prometheus: PrometheusConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/web/","title":"web - Misk","text":"//exemplarchat/com.squareup.chat/ChatConfig/web
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-config/web/#web","title":"web","text":"[jvm]\\ val web: WebConfig
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/","title":"ChatLogging - Misk","text":"//exemplarchat/com.squareup.chat/ChatLogging
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/#chatlogging","title":"ChatLogging","text":"[jvm]\\ object ChatLogging
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/configure/","title":"configure - Misk","text":"//exemplarchat/com.squareup.chat/ChatLogging/configure
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-logging/configure/#configure","title":"configure","text":"[jvm]\\ fun configure()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/","title":"ChatModule - Misk","text":"//exemplarchat/com.squareup.chat/ChatModule
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#chatmodule","title":"ChatModule","text":"[jvm]\\ class ChatModule : KAbstractModule
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#constructors","title":"Constructors","text":"ChatModule [jvm]constructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/-chat-module/","title":"ChatModule - Misk","text":"//exemplarchat/com.squareup.chat/ChatModule/ChatModule
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat/-chat-module/-chat-module/#chatmodule","title":"ChatModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/","title":"Package-level declarations - Misk","text":"//exemplarchat/com.squareup.chat.actions
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/#types","title":"Types","text":"Name Summary ChatWebSocketAction [jvm]@Singletonclass ChatWebSocketAction@Injectconstructor(redis: Redis) : WebActionChatWebSocketAction is a basic chat program which supports multiple chat rooms and their histories through web socket connections. ToggleManualHealthCheckAction [jvm]@Singletonclass ToggleManualHealthCheckAction@Injectconstructor : WebAction"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/","title":"ChatWebSocketAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#chatwebsocketaction","title":"ChatWebSocketAction","text":"[jvm]\\ @Singleton
class ChatWebSocketAction@Injectconstructor(redis: Redis) : WebAction
ChatWebSocketAction is a basic chat program which supports multiple chat rooms and their histories through web socket connections.
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#constructors","title":"Constructors","text":"ChatWebSocketAction [jvm]@Injectconstructor(redis: Redis)"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/#functions","title":"Functions","text":"Name Summary chat [jvm]fun chat(name: String, webSocket: WebSocket): WebSocketListener"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/-chat-web-socket-action/","title":"ChatWebSocketAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction/ChatWebSocketAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/-chat-web-socket-action/#chatwebsocketaction","title":"ChatWebSocketAction","text":"[jvm]\\
@Inject
constructor(redis: Redis)
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/chat/","title":"chat - Misk","text":"//exemplarchat/com.squareup.chat.actions/ChatWebSocketAction/chat
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-chat-web-socket-action/chat/#chat","title":"chat","text":"[jvm]\\ fun chat(name: String, webSocket: WebSocket): WebSocketListener
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/","title":"ToggleManualHealthCheckAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#togglemanualhealthcheckaction","title":"ToggleManualHealthCheckAction","text":"[jvm]\\ @Singleton
class ToggleManualHealthCheckAction@Injectconstructor : WebAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#constructors","title":"Constructors","text":"ToggleManualHealthCheckAction [jvm]@Injectconstructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#properties","title":"Properties","text":"Name Summary manualHealthCheck [jvm]@Injectlateinit var manualHealthCheck: ManualHealthCheck"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/#functions","title":"Functions","text":"Name Summary setManualHealthCheck [jvm]fun setManualHealthCheck(status: String?): Response<String>"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/-toggle-manual-health-check-action/","title":"ToggleManualHealthCheckAction - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/ToggleManualHealthCheckAction
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/-toggle-manual-health-check-action/#togglemanualhealthcheckaction","title":"ToggleManualHealthCheckAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/manual-health-check/","title":"manualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/manualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/manual-health-check/#manualhealthcheck","title":"manualHealthCheck","text":"[jvm]\\
@Inject
lateinit var manualHealthCheck: ManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/set-manual-health-check/","title":"setManualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.actions/ToggleManualHealthCheckAction/setManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.actions/-toggle-manual-health-check-action/set-manual-health-check/#setmanualhealthcheck","title":"setManualHealthCheck","text":"[jvm]\\ fun setManualHealthCheck(status: String?): Response<String>
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/","title":"Package-level declarations - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/#types","title":"Types","text":"Name Summary ManualHealthCheck [jvm]@Singletonclass ManualHealthCheck : HealthCheck"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/","title":"ManualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#manualhealthcheck","title":"ManualHealthCheck","text":"[jvm]\\ @Singleton
class ManualHealthCheck : HealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#constructors","title":"Constructors","text":"ManualHealthCheck [jvm]constructor()"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/#functions","title":"Functions","text":"Name Summary setHealth [jvm]fun setHealth() setUnhealthy [jvm]fun setUnhealthy() status [jvm]open override fun status(): HealthStatus"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/-manual-health-check/","title":"ManualHealthCheck - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/ManualHealthCheck
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/-manual-health-check/#manualhealthcheck","title":"ManualHealthCheck","text":"[jvm]\\ constructor()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-health/","title":"setHealth - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/setHealth
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-health/#sethealth","title":"setHealth","text":"[jvm]\\ fun setHealth()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-unhealthy/","title":"setUnhealthy - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/setUnhealthy
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/set-unhealthy/#setunhealthy","title":"setUnhealthy","text":"[jvm]\\ fun setUnhealthy()
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/status/","title":"status - Misk","text":"//exemplarchat/com.squareup.chat.healthchecks/ManualHealthCheck/status
"},{"location":"0.x/exemplarchat/exemplarchat/com.squareup.chat.healthchecks/-manual-health-check/status/#status","title":"status","text":"[jvm]\\ open override fun status(): HealthStatus
"},{"location":"0.x/misk/","title":"misk - Misk","text":"//misk
"},{"location":"0.x/misk/#misk","title":"misk","text":""},{"location":"0.x/misk/#packages","title":"Packages","text":"Name misk misk.client misk.concurrent misk.environment misk.grpc misk.io misk.jvm misk.logging misk.monitoring misk.moshi misk.moshi.adapters misk.moshi.okio misk.moshi.time misk.okio misk.perf misk.security.authz misk.security.cert misk.security.csp misk.security.keys misk.security.ssl misk.tasks misk.time misk.web misk.web.actions misk.web.concurrencylimits misk.web.exceptions misk.web.extractors misk.web.formatter misk.web.interceptors misk.web.jetty misk.web.marshal misk.web.mdc misk.web.metadata.guice misk.web.metadata.webaction misk.web.proxy misk.web.resources"},{"location":"0.x/misk/misk/misk/","title":"Package-level declarations - Misk","text":"//misk/misk
"},{"location":"0.x/misk/misk/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk/#types","title":"Types","text":"Name Summary Action [jvm]data class Action(val name: String, val function: KFunction<*>, val acceptedMediaRanges: List<MediaRange>, val responseContentType: MediaType?, val parameters: List<KParameter>, val returnType: KType, val dispatchMechanism: DispatchMechanism) ApplicationInterceptor [jvm]interface ApplicationInterceptor Chain [jvm]interface Chain MiskApplication [jvm]class MiskApplicationThe entry point for misk applications MiskCommand [jvm]abstract class MiskCommand(name: String, modules: List<Module>) : RunnableA command to run from the command line. Each command has an associated name and the list of modules to use in initializing the command. Commands can specify optional and required arguments via JCommander annotations. The command line will pick the appropriate command based on the name, create an injector based on that command\u2019s modules, use the injector to initialize the command, and then run the command. MiskCommonServiceModule [jvm]class MiskCommonServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModuleThis module has common bindings for all environments (both real and testing). MiskRealServiceModule [jvm]class MiskRealServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModuleInstall this module in real environments."},{"location":"0.x/misk/misk/misk/#functions","title":"Functions","text":"Name Summary asAction [jvm]fun KFunction<*>.asAction(dispatchMechanism: DispatchMechanism, responseContentType: MediaType? = singleOrNullResponseMediaType()): Action"},{"location":"0.x/misk/misk/misk/as-action/","title":"asAction - Misk","text":"//misk/misk/asAction
"},{"location":"0.x/misk/misk/misk/as-action/#asaction","title":"asAction","text":"[jvm]\\ fun KFunction<*>.asAction(dispatchMechanism: DispatchMechanism, responseContentType: MediaType? = singleOrNullResponseMediaType()): Action
"},{"location":"0.x/misk/misk/misk/-action/","title":"Action - Misk","text":"//misk/misk/Action
"},{"location":"0.x/misk/misk/misk/-action/#action","title":"Action","text":"[jvm]\\ data class Action(val name: String, val function: KFunction<*>, val acceptedMediaRanges: List<MediaRange>, val responseContentType: MediaType?, val parameters: List<KParameter>, val returnType: KType, val dispatchMechanism: DispatchMechanism)
"},{"location":"0.x/misk/misk/misk/-action/#constructors","title":"Constructors","text":"Action [jvm]constructor(name: String, function: KFunction<*>, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameters: List<KParameter>, returnType: KType, dispatchMechanism: DispatchMechanism)"},{"location":"0.x/misk/misk/misk/-action/#properties","title":"Properties","text":"Name Summary acceptedMediaRanges [jvm]val acceptedMediaRanges: List<MediaRange> dispatchMechanism [jvm]val dispatchMechanism: DispatchMechanism function [jvm]val function: KFunction<*> name [jvm]val name: String parameters [jvm]val parameters: List<KParameter> parameterTypes [jvm]val parameterTypes: List<KType>ParameterTypes and RequestType can differ because RequestType pertains only to the type of the request body, whereas ParameterTypes includes other parts of the request such as path params and query params. requestType [jvm]val requestType: KType? responseContentType [jvm]val responseContentType: MediaType? returnType [jvm]val returnType: KType"},{"location":"0.x/misk/misk/misk/-action/#functions","title":"Functions","text":"Name Summary hasReturnValue [jvm]fun hasReturnValue(): Boolean toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk/-action/-action/","title":"Action - Misk","text":"//misk/misk/Action/Action
"},{"location":"0.x/misk/misk/misk/-action/-action/#action","title":"Action","text":"[jvm]\\ constructor(name: String, function: KFunction<*>, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameters: List<KParameter>, returnType: KType, dispatchMechanism: DispatchMechanism)
"},{"location":"0.x/misk/misk/misk/-action/accepted-media-ranges/","title":"acceptedMediaRanges - Misk","text":"//misk/misk/Action/acceptedMediaRanges
"},{"location":"0.x/misk/misk/misk/-action/accepted-media-ranges/#acceptedmediaranges","title":"acceptedMediaRanges","text":"[jvm]\\ val acceptedMediaRanges: List<MediaRange>
"},{"location":"0.x/misk/misk/misk/-action/dispatch-mechanism/","title":"dispatchMechanism - Misk","text":"//misk/misk/Action/dispatchMechanism
"},{"location":"0.x/misk/misk/misk/-action/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"[jvm]\\ val dispatchMechanism: DispatchMechanism
"},{"location":"0.x/misk/misk/misk/-action/function/","title":"function - Misk","text":"//misk/misk/Action/function
"},{"location":"0.x/misk/misk/misk/-action/function/#function","title":"function","text":"[jvm]\\ val function: KFunction<*>
"},{"location":"0.x/misk/misk/misk/-action/has-return-value/","title":"hasReturnValue - Misk","text":"//misk/misk/Action/hasReturnValue
"},{"location":"0.x/misk/misk/misk/-action/has-return-value/#hasreturnvalue","title":"hasReturnValue","text":"[jvm]\\ fun hasReturnValue(): Boolean
"},{"location":"0.x/misk/misk/misk/-action/name/","title":"name - Misk","text":"//misk/misk/Action/name
"},{"location":"0.x/misk/misk/misk/-action/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk/-action/parameter-types/","title":"parameterTypes - Misk","text":"//misk/misk/Action/parameterTypes
"},{"location":"0.x/misk/misk/misk/-action/parameter-types/#parametertypes","title":"parameterTypes","text":"[jvm]\\ val parameterTypes: List<KType>
ParameterTypes and RequestType can differ because RequestType pertains only to the type of the request body, whereas ParameterTypes includes other parts of the request such as path params and query params.
"},{"location":"0.x/misk/misk/misk/-action/parameters/","title":"parameters - Misk","text":"//misk/misk/Action/parameters
"},{"location":"0.x/misk/misk/misk/-action/parameters/#parameters","title":"parameters","text":"[jvm]\\ val parameters: List<KParameter>
"},{"location":"0.x/misk/misk/misk/-action/request-type/","title":"requestType - Misk","text":"//misk/misk/Action/requestType
"},{"location":"0.x/misk/misk/misk/-action/request-type/#requesttype","title":"requestType","text":"[jvm]\\ val requestType: KType?
"},{"location":"0.x/misk/misk/misk/-action/response-content-type/","title":"responseContentType - Misk","text":"//misk/misk/Action/responseContentType
"},{"location":"0.x/misk/misk/misk/-action/response-content-type/#responsecontenttype","title":"responseContentType","text":"[jvm]\\ val responseContentType: MediaType?
"},{"location":"0.x/misk/misk/misk/-action/return-type/","title":"returnType - Misk","text":"//misk/misk/Action/returnType
"},{"location":"0.x/misk/misk/misk/-action/return-type/#returntype","title":"returnType","text":"[jvm]\\ val returnType: KType
"},{"location":"0.x/misk/misk/misk/-action/to-string/","title":"toString - Misk","text":"//misk/misk/Action/toString
"},{"location":"0.x/misk/misk/misk/-action/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk/-application-interceptor/","title":"ApplicationInterceptor - Misk","text":"//misk/misk/ApplicationInterceptor
"},{"location":"0.x/misk/misk/misk/-application-interceptor/#applicationinterceptor","title":"ApplicationInterceptor","text":"interface ApplicationInterceptor
"},{"location":"0.x/misk/misk/misk/-application-interceptor/#inheritors","title":"Inheritors","text":"AccessInterceptor RequestBodyLoggingInterceptor"},{"location":"0.x/misk/misk/misk/-application-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface Factory"},{"location":"0.x/misk/misk/misk/-application-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk/-application-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk/ApplicationInterceptor/intercept
"},{"location":"0.x/misk/misk/misk/-application-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ abstract fun intercept(chain: Chain): Any
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk/ApplicationInterceptor/Factory
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#factory","title":"Factory","text":"interface Factory
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#inheritors","title":"Inheritors","text":"Factory"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): ApplicationInterceptor?"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk/ApplicationInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk/-application-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action): ApplicationInterceptor?
"},{"location":"0.x/misk/misk/misk/-chain/","title":"Chain - Misk","text":"//misk/misk/Chain
"},{"location":"0.x/misk/misk/misk/-chain/#chain","title":"Chain","text":"[jvm]\\ interface Chain
"},{"location":"0.x/misk/misk/misk/-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: WebAction args [jvm]abstract val args: List<Any?> function [jvm]abstract val function: KFunction<*> httpCall [jvm]abstract val httpCall: HttpCall"},{"location":"0.x/misk/misk/misk/-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<Any?>): Any"},{"location":"0.x/misk/misk/misk/-chain/action/","title":"action - Misk","text":"//misk/misk/Chain/action
"},{"location":"0.x/misk/misk/misk/-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: WebAction
"},{"location":"0.x/misk/misk/misk/-chain/args/","title":"args - Misk","text":"//misk/misk/Chain/args
"},{"location":"0.x/misk/misk/misk/-chain/args/#args","title":"args","text":"[jvm]\\ abstract val args: List<Any?>
"},{"location":"0.x/misk/misk/misk/-chain/function/","title":"function - Misk","text":"//misk/misk/Chain/function
"},{"location":"0.x/misk/misk/misk/-chain/function/#function","title":"function","text":"[jvm]\\ abstract val function: KFunction<*>
"},{"location":"0.x/misk/misk/misk/-chain/http-call/","title":"httpCall - Misk","text":"//misk/misk/Chain/httpCall
"},{"location":"0.x/misk/misk/misk/-chain/http-call/#httpcall","title":"httpCall","text":"[jvm]\\ abstract val httpCall: HttpCall
"},{"location":"0.x/misk/misk/misk/-chain/proceed/","title":"proceed - Misk","text":"//misk/misk/Chain/proceed
"},{"location":"0.x/misk/misk/misk/-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(args: List<Any?>): Any
"},{"location":"0.x/misk/misk/misk/-misk-application/","title":"MiskApplication - Misk","text":"//misk/misk/MiskApplication
"},{"location":"0.x/misk/misk/misk/-misk-application/#miskapplication","title":"MiskApplication","text":"[jvm]\\ class MiskApplication
The entry point for misk applications
"},{"location":"0.x/misk/misk/misk/-misk-application/#constructors","title":"Constructors","text":"MiskApplication [jvm]constructor(vararg modules: Module)constructor(vararg commands: MiskCommand)constructor(modules: List<Module>, commands: List<MiskCommand> = listOf())constructor(injector: Injector)"},{"location":"0.x/misk/misk/misk/-misk-application/#functions","title":"Functions","text":"Name Summary run [jvm]fun run(args: Array<String>)Runs the application, finding and executing the appropriate command based on the provided command line arguments"},{"location":"0.x/misk/misk/misk/-misk-application/-misk-application/","title":"MiskApplication - Misk","text":"//misk/misk/MiskApplication/MiskApplication
"},{"location":"0.x/misk/misk/misk/-misk-application/-misk-application/#miskapplication","title":"MiskApplication","text":"[jvm]\\ constructor(vararg modules: Module)
constructor(vararg commands: MiskCommand)
constructor(modules: List<Module>, commands: List<MiskCommand> = listOf())
constructor(injector: Injector)
"},{"location":"0.x/misk/misk/misk/-misk-application/run/","title":"run - Misk","text":"//misk/misk/MiskApplication/run
"},{"location":"0.x/misk/misk/misk/-misk-application/run/#run","title":"run","text":"[jvm]\\ fun run(args: Array<String>)
Runs the application, finding and executing the appropriate command based on the provided command line arguments
"},{"location":"0.x/misk/misk/misk/-misk-command/","title":"MiskCommand - Misk","text":"//misk/misk/MiskCommand
"},{"location":"0.x/misk/misk/misk/-misk-command/#miskcommand","title":"MiskCommand","text":"[jvm]\\ abstract class MiskCommand(name: String, modules: List<Module>) : Runnable
A command to run from the command line. Each command has an associated name and the list of modules to use in initializing the command. Commands can specify optional and required arguments via JCommander annotations. The command line will pick the appropriate command based on the name, create an injector based on that command\u2019s modules, use the injector to initialize the command, and then run the command.
"},{"location":"0.x/misk/misk/misk/-misk-command/#constructors","title":"Constructors","text":"MiskCommand [jvm]constructor(name: String, vararg modules: Module)constructor(name: String, modules: List<Module>)"},{"location":"0.x/misk/misk/misk/-misk-command/#functions","title":"Functions","text":"Name Summary requireCli [jvm]fun requireCli(value: Boolean, lazyMessage: () -> String)Confirms that the given precondition is true, otherwise throws a ParameterException with the supplied message. run [jvm]abstract fun run()"},{"location":"0.x/misk/misk/misk/-misk-command/-misk-command/","title":"MiskCommand - Misk","text":"//misk/misk/MiskCommand/MiskCommand
"},{"location":"0.x/misk/misk/misk/-misk-command/-misk-command/#miskcommand","title":"MiskCommand","text":"[jvm]\\ constructor(name: String, vararg modules: Module)
constructor(name: String, modules: List<Module>)
"},{"location":"0.x/misk/misk/misk/-misk-command/require-cli/","title":"requireCli - Misk","text":"//misk/misk/MiskCommand/requireCli
"},{"location":"0.x/misk/misk/misk/-misk-command/require-cli/#requirecli","title":"requireCli","text":"[jvm]\\ fun requireCli(value: Boolean, lazyMessage: () -> String)
Confirms that the given precondition is true, otherwise throws a ParameterException with the supplied message.
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/","title":"MiskCommonServiceModule - Misk","text":"//misk/misk/MiskCommonServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#miskcommonservicemodule","title":"MiskCommonServiceModule","text":"[jvm]\\ class MiskCommonServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule
This module has common bindings for all environments (both real and testing).
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#constructors","title":"Constructors","text":"MiskCommonServiceModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/-misk-common-service-module/","title":"MiskCommonServiceModule - Misk","text":"//misk/misk/MiskCommonServiceModule/MiskCommonServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-common-service-module/-misk-common-service-module/#miskcommonservicemodule","title":"MiskCommonServiceModule","text":"[jvm]\\
@JvmOverloads
constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/","title":"MiskRealServiceModule - Misk","text":"//misk/misk/MiskRealServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#miskrealservicemodule","title":"MiskRealServiceModule","text":"[jvm]\\ class MiskRealServiceModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule
Install this module in real environments.
The vast majority of Service bindings belong in MiskCommonServiceModule, in order to share with MiskTestingServiceModule. Only bindings that are not suitable for a unit testing environment belong here.
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#constructors","title":"Constructors","text":"MiskRealServiceModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/-misk-real-service-module/","title":"MiskRealServiceModule - Misk","text":"//misk/misk/MiskRealServiceModule/MiskRealServiceModule
"},{"location":"0.x/misk/misk/misk/-misk-real-service-module/-misk-real-service-module/#miskrealservicemodule","title":"MiskRealServiceModule","text":"[jvm]\\
@JvmOverloads
constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())
"},{"location":"0.x/misk/misk/misk.client/","title":"Package-level declarations - Misk","text":"//misk/misk.client
"},{"location":"0.x/misk/misk/misk.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.client/#types","title":"Types","text":"Name Summary BackwardsCompatibleClientsConfig [jvm]data class BackwardsCompatibleClientsConfig@JvmOverloadsconstructor(val defaultConnectTimeout: Duration? = null, val defaultWriteTimeout: Duration? = null, val defaultReadTimeout: Duration? = null, val ssl: HttpClientSSLConfig? = null, val defaultPingInterval: Duration? = null, val defaultCallTimeout: Duration? = null, val endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val logRequests: Boolean = false) BackwardsCompatibleClientsConfigConverter [jvm]class BackwardsCompatibleClientsConfigConverter : Converter<BackwardsCompatibleClientsConfig, HttpClientsConfig> BackwardsCompatibleEndpointConfig [jvm]data class BackwardsCompatibleEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int = 128, val maxRequestsPerHost: Int = 32, val maxIdleConnections: Int = 100, val keepAliveDuration: Duration = Duration.ofMinutes(5), val ssl: HttpClientSSLConfig? = null, val clientConfig: HttpClientConfig? = null) BeginClientCallChain [jvm]interface BeginClientCallChain CallFactoryWrapper [jvm]interface CallFactoryWrapperCallFactoryWrapper is a way to extend the functionality of the okhttp3.Call.Factory instance injected to typed http clients and gRPC clients created by TypedClientFactoryProvider and GrpcClientProvider. ClientApplicationInterceptorFactory [jvm]interface ClientApplicationInterceptorFactory ClientChain [jvm]interface ClientChain ClientMetricsInterceptor [jvm]class ClientMetricsInterceptor : Interceptor ClientNetworkInterceptorsModule [jvm]class ClientNetworkInterceptorsModule : KAbstractModuleThe common set of ClientNetworkInterceptors for all misk apps. GrpcClientModule [jvm]class GrpcClientModule<T : Service, G : T>@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0) : KAbstractModuleCreates a gRPC client given a Wire-generated interface and HTTP configuration. HttpClientConfig [jvm]data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null) HttpClientConfigUrlProvider [jvm]class HttpClientConfigUrlProvider@InjectconstructorCalculates the url for an http client config, which can differ depending on if the client is envoy-based or connects directly. HttpClientEndpointConfig [jvm]data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig()) HttpClientEnvoyConfig [jvm]data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null) HttpClientFactory [jvm]@Singletonclass HttpClientFactory@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator) HttpClientModule [jvm]class HttpClientModule@JvmOverloadsconstructor(name: String, annotation: Annotation? = null) : KAbstractModuleProvides an OkHttpClient and ProtoMessageHttpClient for a peer service HttpClientsConfig [jvm]data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), val logRequests: Boolean = false) : Config HttpClientsConfigModule [jvm]class HttpClientsConfigModule(config: HttpClientsConfig) : KAbstractModule HttpClientSSLConfig [jvm]data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig) JettyPortPeerClientModule [jvm]class JettyPortPeerClientModule : KAbstractModuleFor testing. OkHttpClientCommonConfigurator [jvm]class OkHttpClientCommonConfigurator@Injectconstructor PeerClientFactory [jvm]class PeerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)Factory that creates OkHttpClients for connecting to another instance of the same application running in the same cluster. PeerClientModule [jvm]class PeerClientModule : KAbstractModuleBinds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the SSL port in the WebConfig. ProtoMessageHttpClient [jvm]class ProtoMessageHttpClient(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)This helper class is for making HTTP requests to an endpoint that handles protobuf Message classes. TypedClientFactory [jvm]class TypedClientFactory@Injectconstructor TypedHttpClientModule [jvm]class TypedHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModuleCreates a retrofit-backed typed client given an API interface and an HTTP configuration. TypedPeerClientFactory [jvm]interface TypedPeerClientFactory<T>Factory for creating typed clients that call other members of a cluster. TypedPeerHttpClientModule [jvm]class TypedPeerHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModuleCreates a retrofit-backed typed client factory given an API interface and an HTTP configuration."},{"location":"0.x/misk/misk/misk.client/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/misk/misk/misk.client/apply-defaults/","title":"applyDefaults - Misk","text":"//misk/misk.client/applyDefaults
"},{"location":"0.x/misk/misk/misk.client/apply-defaults/#applydefaults","title":"applyDefaults","text":"[jvm]\\ fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/","title":"BackwardsCompatibleClientsConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#backwardscompatibleclientsconfig","title":"BackwardsCompatibleClientsConfig","text":"[jvm]\\ data class BackwardsCompatibleClientsConfig@JvmOverloadsconstructor(val defaultConnectTimeout: Duration? = null, val defaultWriteTimeout: Duration? = null, val defaultReadTimeout: Duration? = null, val ssl: HttpClientSSLConfig? = null, val defaultPingInterval: Duration? = null, val defaultCallTimeout: Duration? = null, val endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val logRequests: Boolean = false)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#constructors","title":"Constructors","text":"BackwardsCompatibleClientsConfig [jvm]@JvmOverloadsconstructor(defaultConnectTimeout: Duration? = null, defaultWriteTimeout: Duration? = null, defaultReadTimeout: Duration? = null, ssl: HttpClientSSLConfig? = null, defaultPingInterval: Duration? = null, defaultCallTimeout: Duration? = null, endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), logRequests: Boolean = false)"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/#properties","title":"Properties","text":"Name Summary defaultCallTimeout [jvm]val defaultCallTimeout: Duration? = null defaultConnectTimeout [jvm]val defaultConnectTimeout: Duration? = null defaultPingInterval [jvm]val defaultPingInterval: Duration? = null defaultReadTimeout [jvm]val defaultReadTimeout: Duration? = null defaultWriteTimeout [jvm]val defaultWriteTimeout: Duration? = null endpoints [jvm]val endpoints: Map<String, BackwardsCompatibleEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig> logRequests [jvm]val logRequests: Boolean = false ssl [jvm]val ssl: HttpClientSSLConfig? = null"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/-backwards-compatible-clients-config/","title":"BackwardsCompatibleClientsConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/BackwardsCompatibleClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/-backwards-compatible-clients-config/#backwardscompatibleclientsconfig","title":"BackwardsCompatibleClientsConfig","text":"[jvm]\\
@JvmOverloads
constructor(defaultConnectTimeout: Duration? = null, defaultWriteTimeout: Duration? = null, defaultReadTimeout: Duration? = null, ssl: HttpClientSSLConfig? = null, defaultPingInterval: Duration? = null, defaultCallTimeout: Duration? = null, endpoints: Map<String, BackwardsCompatibleEndpointConfig> = mapOf(), hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), logRequests: Boolean = false)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-call-timeout/","title":"defaultCallTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultCallTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-call-timeout/#defaultcalltimeout","title":"defaultCallTimeout","text":"[jvm]\\ val defaultCallTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-connect-timeout/","title":"defaultConnectTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultConnectTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-connect-timeout/#defaultconnecttimeout","title":"defaultConnectTimeout","text":"[jvm]\\ val defaultConnectTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-ping-interval/","title":"defaultPingInterval - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultPingInterval
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-ping-interval/#defaultpinginterval","title":"defaultPingInterval","text":"[jvm]\\ val defaultPingInterval: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-read-timeout/","title":"defaultReadTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultReadTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-read-timeout/#defaultreadtimeout","title":"defaultReadTimeout","text":"[jvm]\\ val defaultReadTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-write-timeout/","title":"defaultWriteTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/defaultWriteTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/default-write-timeout/#defaultwritetimeout","title":"defaultWriteTimeout","text":"[jvm]\\ val defaultWriteTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/endpoints/","title":"endpoints - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/endpoints
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/endpoints/#endpoints","title":"endpoints","text":"[jvm]\\ val endpoints: Map<String, BackwardsCompatibleEndpointConfig>
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/host-configs/","title":"hostConfigs - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/hostConfigs
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/log-requests/","title":"logRequests - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/logRequests
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/log-requests/#logrequests","title":"logRequests","text":"[jvm]\\ val logRequests: Boolean = false
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/ssl/","title":"ssl - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfig/ssl
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/","title":"BackwardsCompatibleClientsConfigConverter - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#backwardscompatibleclientsconfigconverter","title":"BackwardsCompatibleClientsConfigConverter","text":"[jvm]\\ class BackwardsCompatibleClientsConfigConverter : Converter<BackwardsCompatibleClientsConfig, HttpClientsConfig>
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#constructors","title":"Constructors","text":"BackwardsCompatibleClientsConfigConverter [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/#functions","title":"Functions","text":"Name Summary convert [jvm]open override fun convert(value: BackwardsCompatibleClientsConfig): HttpClientsConfig getInputType [jvm]open override fun getInputType(typeFactory: TypeFactory): JavaType getOutputType [jvm]open override fun getOutputType(typeFactory: TypeFactory): JavaType"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/-backwards-compatible-clients-config-converter/","title":"BackwardsCompatibleClientsConfigConverter - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/BackwardsCompatibleClientsConfigConverter
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/-backwards-compatible-clients-config-converter/#backwardscompatibleclientsconfigconverter","title":"BackwardsCompatibleClientsConfigConverter","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/convert/","title":"convert - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/convert
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/convert/#convert","title":"convert","text":"[jvm]\\ open override fun convert(value: BackwardsCompatibleClientsConfig): HttpClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-input-type/","title":"getInputType - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/getInputType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-input-type/#getinputtype","title":"getInputType","text":"[jvm]\\ open override fun getInputType(typeFactory: TypeFactory): JavaType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-output-type/","title":"getOutputType - Misk","text":"//misk/misk.client/BackwardsCompatibleClientsConfigConverter/getOutputType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-clients-config-converter/get-output-type/#getoutputtype","title":"getOutputType","text":"[jvm]\\ open override fun getOutputType(typeFactory: TypeFactory): JavaType
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/","title":"BackwardsCompatibleEndpointConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#backwardscompatibleendpointconfig","title":"BackwardsCompatibleEndpointConfig","text":"[jvm]\\ data class BackwardsCompatibleEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int = 128, val maxRequestsPerHost: Int = 32, val maxIdleConnections: Int = 100, val keepAliveDuration: Duration = Duration.ofMinutes(5), val ssl: HttpClientSSLConfig? = null, val clientConfig: HttpClientConfig? = null)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#constructors","title":"Constructors","text":"BackwardsCompatibleEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int = 128, maxRequestsPerHost: Int = 32, maxIdleConnections: Int = 100, keepAliveDuration: Duration = Duration.ofMinutes(5), ssl: HttpClientSSLConfig? = null, clientConfig: HttpClientConfig? = null)"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null clientConfig [jvm]val clientConfig: HttpClientConfig? = null connectTimeout [jvm]val connectTimeout: Duration? = null envoy [jvm]val envoy: HttpClientEnvoyConfig? = null keepAliveDuration [jvm]val keepAliveDuration: Duration maxIdleConnections [jvm]val maxIdleConnections: Int = 100 maxRequests [jvm]val maxRequests: Int = 128 maxRequestsPerHost [jvm]val maxRequestsPerHost: Int = 32 pingInterval [jvm]val pingInterval: Duration? = null readTimeout [jvm]val readTimeout: Duration? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null url [jvm]val url: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/-backwards-compatible-endpoint-config/","title":"BackwardsCompatibleEndpointConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/BackwardsCompatibleEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/-backwards-compatible-endpoint-config/#backwardscompatibleendpointconfig","title":"BackwardsCompatibleEndpointConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int = 128, maxRequestsPerHost: Int = 32, maxIdleConnections: Int = 100, keepAliveDuration: Duration = Duration.ofMinutes(5), ssl: HttpClientSSLConfig? = null, clientConfig: HttpClientConfig? = null)
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/call-timeout/","title":"callTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/callTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/call-timeout/#calltimeout","title":"callTimeout","text":"[jvm]\\ val callTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/client-config/","title":"clientConfig - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/clientConfig
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"[jvm]\\ val clientConfig: HttpClientConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/connect-timeout/","title":"connectTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/connectTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"[jvm]\\ val connectTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/envoy/","title":"envoy - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/envoy
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/envoy/#envoy","title":"envoy","text":"[jvm]\\ val envoy: HttpClientEnvoyConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/keepAliveDuration
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/maxIdleConnections
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ val maxIdleConnections: Int = 100
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/maxRequestsPerHost
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"[jvm]\\ val maxRequestsPerHost: Int = 32
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests/","title":"maxRequests - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/maxRequests
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/max-requests/#maxrequests","title":"maxRequests","text":"[jvm]\\ val maxRequests: Int = 128
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ping-interval/","title":"pingInterval - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/pingInterval
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ping-interval/#pinginterval","title":"pingInterval","text":"[jvm]\\ val pingInterval: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/read-timeout/","title":"readTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/readTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/read-timeout/#readtimeout","title":"readTimeout","text":"[jvm]\\ val readTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ssl/","title":"ssl - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/ssl
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/url/","title":"url - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/url
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/write-timeout/","title":"writeTimeout - Misk","text":"//misk/misk.client/BackwardsCompatibleEndpointConfig/writeTimeout
"},{"location":"0.x/misk/misk/misk.client/-backwards-compatible-endpoint-config/write-timeout/#writetimeout","title":"writeTimeout","text":"[jvm]\\ val writeTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/","title":"BeginClientCallChain - Misk","text":"//misk/misk.client/BeginClientCallChain
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#beginclientcallchain","title":"BeginClientCallChain","text":"[jvm]\\ interface BeginClientCallChain
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction args [jvm]abstract val args: List<*>"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<*>): Call<Any>"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/action/","title":"action - Misk","text":"//misk/misk.client/BeginClientCallChain/action
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: ClientAction
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/args/","title":"args - Misk","text":"//misk/misk.client/BeginClientCallChain/args
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/args/#args","title":"args","text":"[jvm]\\ abstract val args: List<*>
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/proceed/","title":"proceed - Misk","text":"//misk/misk.client/BeginClientCallChain/proceed
"},{"location":"0.x/misk/misk/misk.client/-begin-client-call-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(args: List<*>): Call<Any>
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/","title":"CallFactoryWrapper - Misk","text":"//misk/misk.client/CallFactoryWrapper
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/#callfactorywrapper","title":"CallFactoryWrapper","text":"[jvm]\\ interface CallFactoryWrapper
CallFactoryWrapper is a way to extend the functionality of the okhttp3.Call.Factory instance injected to typed http clients and gRPC clients created by TypedClientFactoryProvider and GrpcClientProvider.
The ability to extend the Call.Factory instance gives you similar functionalities to ClientApplicationInterceptorFactory and ClientNetworkInterceptor, where you can modify the request/response of the outgoing request. The main difference is that Call.Factory will be run in the thread the client is making the request as opposite to ClientApplicationInterceptorFactory and ClientNetworkInterceptor, which might be run on the okhttp3.Dispatcher threads when executing requests asynchronously. That can be problematic if ActionScoped or ThreadLocal information wants to be propagated using interceptors to downstream services. For example, tracing related information.
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<CallFactoryWrapper>().to<MyFactoryWrapper>()\ndelegate pass as argument."},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/wrap/","title":"wrap - Misk","text":"//misk/misk.client/CallFactoryWrapper/wrap
"},{"location":"0.x/misk/misk/misk.client/-call-factory-wrapper/wrap/#wrap","title":"wrap","text":"[jvm]\\ abstract fun wrap(action: ClientAction, delegate: Call.Factory): Call.Factory?
Returns a Call.Factory that wraps the original call factory delegate pass as argument.
//misk/misk.client/ClientApplicationInterceptorFactory
"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/#clientapplicationinterceptorfactory","title":"ClientApplicationInterceptorFactory","text":"[jvm]\\ interface ClientApplicationInterceptorFactory
"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: ClientAction): Interceptor?"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/create/","title":"create - Misk","text":"//misk/misk.client/ClientApplicationInterceptorFactory/create
"},{"location":"0.x/misk/misk/misk.client/-client-application-interceptor-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: ClientAction): Interceptor?
"},{"location":"0.x/misk/misk/misk.client/-client-chain/","title":"ClientChain - Misk","text":"//misk/misk.client/ClientChain
"},{"location":"0.x/misk/misk/misk.client/-client-chain/#clientchain","title":"ClientChain","text":"[jvm]\\ interface ClientChain
"},{"location":"0.x/misk/misk/misk.client/-client-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction args [jvm]abstract val args: List<*> call [jvm]abstract val call: Call<Any> callback [jvm]abstract val callback: Callback<Any>"},{"location":"0.x/misk/misk/misk.client/-client-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(args: List<*>, callback: Callback<Any>)"},{"location":"0.x/misk/misk/misk.client/-client-chain/action/","title":"action - Misk","text":"//misk/misk.client/ClientChain/action
"},{"location":"0.x/misk/misk/misk.client/-client-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: ClientAction
"},{"location":"0.x/misk/misk/misk.client/-client-chain/args/","title":"args - Misk","text":"//misk/misk.client/ClientChain/args
"},{"location":"0.x/misk/misk/misk.client/-client-chain/args/#args","title":"args","text":"[jvm]\\ abstract val args: List<*>
"},{"location":"0.x/misk/misk/misk.client/-client-chain/call/","title":"call - Misk","text":"//misk/misk.client/ClientChain/call
"},{"location":"0.x/misk/misk/misk.client/-client-chain/call/#call","title":"call","text":"[jvm]\\ abstract val call: Call<Any>
"},{"location":"0.x/misk/misk/misk.client/-client-chain/callback/","title":"callback - Misk","text":"//misk/misk.client/ClientChain/callback
"},{"location":"0.x/misk/misk/misk.client/-client-chain/callback/#callback","title":"callback","text":"[jvm]\\ abstract val callback: Callback<Any>
"},{"location":"0.x/misk/misk/misk.client/-client-chain/proceed/","title":"proceed - Misk","text":"//misk/misk.client/ClientChain/proceed
"},{"location":"0.x/misk/misk/misk.client/-client-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(args: List<*>, callback: Callback<Any>)
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/","title":"ClientMetricsInterceptor - Misk","text":"//misk/misk.client/ClientMetricsInterceptor
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#clientmetricsinterceptor","title":"ClientMetricsInterceptor","text":"[jvm]\\ class ClientMetricsInterceptor : Interceptor
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#properties","title":"Properties","text":"Name Summary clientName [jvm]val clientName: String"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): Response"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/client-name/","title":"clientName - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/clientName
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/client-name/#clientname","title":"clientName","text":"[jvm]\\ val clientName: String
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(clientName: String): ClientMetricsInterceptor"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.client/ClientMetricsInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.client/-client-metrics-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ fun create(clientName: String): ClientMetricsInterceptor
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/","title":"ClientNetworkInterceptorsModule - Misk","text":"//misk/misk.client/ClientNetworkInterceptorsModule
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#clientnetworkinterceptorsmodule","title":"ClientNetworkInterceptorsModule","text":"[jvm]\\ class ClientNetworkInterceptorsModule : KAbstractModule
The common set of ClientNetworkInterceptors for all misk apps.
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#constructors","title":"Constructors","text":"ClientNetworkInterceptorsModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/-client-network-interceptors-module/","title":"ClientNetworkInterceptorsModule - Misk","text":"//misk/misk.client/ClientNetworkInterceptorsModule/ClientNetworkInterceptorsModule
"},{"location":"0.x/misk/misk/misk.client/-client-network-interceptors-module/-client-network-interceptors-module/#clientnetworkinterceptorsmodule","title":"ClientNetworkInterceptorsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/","title":"GrpcClientModule - Misk","text":"//misk/misk.client/GrpcClientModule
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#grpcclientmodule","title":"GrpcClientModule","text":"[jvm]\\ class GrpcClientModule<T : Service, G : T>@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0) : KAbstractModule
Creates a gRPC client given a Wire-generated interface and HTTP configuration.
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#constructors","title":"Constructors","text":"GrpcClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0)"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-grpc-client-module/","title":"GrpcClientModule - Misk","text":"//misk/misk.client/GrpcClientModule/GrpcClientModule
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-grpc-client-module/#grpcclientmodule","title":"GrpcClientModule","text":"[jvm]\\
@JvmOverloads
constructor(kclass: KClass<T>, grpcClientClass: KClass<G>, name: String, annotation: Annotation? = null, minMessageToCompress: Long = 0)
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/","title":"Companion - Misk","text":"//misk/misk.client/GrpcClientModule/Companion
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Service, G : T> create(name: String, annotation: Annotation? = null): GrpcClientModule<T, G>"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/create/","title":"create - Misk","text":"//misk/misk.client/GrpcClientModule/Companion/create
"},{"location":"0.x/misk/misk/misk.client/-grpc-client-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Service, G : T> create(name: String, annotation: Annotation? = null): GrpcClientModule<T, G>
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/","title":"HttpClientConfig - Misk","text":"//misk/misk.client/HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\ data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#constructors","title":"Constructors","text":"HttpClientConfig [jvm]@JvmOverloadsconstructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null connectTimeout [jvm]val connectTimeout: Duration? = null keepAliveDuration [jvm]val keepAliveDuration: Duration? = null maxIdleConnections [jvm]val maxIdleConnections: Int? = null maxRequests [jvm]val maxRequests: Int? = null maxRequestsPerHost [jvm]val maxRequestsPerHost: Int? = null pingInterval [jvm]val pingInterval: Duration? = null protocols [jvm]val protocols: List<String>? = null readTimeout [jvm]val readTimeout: Duration? = null retryOnConnectionFailure [jvm]val retryOnConnectionFailure: Boolean? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null unixSocketFile [jvm]val unixSocketFile: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/misk/misk/misk.client/-http-client-config/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig toWispConfig [jvm]fun toWispConfig(): HttpClientConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-config/-http-client-config/","title":"HttpClientConfig - Misk","text":"//misk/misk.client/HttpClientConfig/HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\
@JvmOverloads
constructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/call-timeout/","title":"callTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/callTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/call-timeout/#calltimeout","title":"callTimeout","text":"[jvm]\\ val callTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/connect-timeout/","title":"connectTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/connectTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"[jvm]\\ val connectTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//misk/misk.client/HttpClientConfig/keepAliveDuration
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//misk/misk.client/HttpClientConfig/maxIdleConnections
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ val maxIdleConnections: Int? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"//misk/misk.client/HttpClientConfig/maxRequestsPerHost
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"[jvm]\\ val maxRequestsPerHost: Int? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests/","title":"maxRequests - Misk","text":"//misk/misk.client/HttpClientConfig/maxRequests
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/max-requests/#maxrequests","title":"maxRequests","text":"[jvm]\\ val maxRequests: Int? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ping-interval/","title":"pingInterval - Misk","text":"//misk/misk.client/HttpClientConfig/pingInterval
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ping-interval/#pinginterval","title":"pingInterval","text":"[jvm]\\ val pingInterval: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/protocols/","title":"protocols - Misk","text":"//misk/misk.client/HttpClientConfig/protocols
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/protocols/#protocols","title":"protocols","text":"[jvm]\\ val protocols: List<String>? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/read-timeout/","title":"readTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/readTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/read-timeout/#readtimeout","title":"readTimeout","text":"[jvm]\\ val readTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"//misk/misk.client/HttpClientConfig/retryOnConnectionFailure
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"[jvm]\\ val retryOnConnectionFailure: Boolean? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ssl/","title":"ssl - Misk","text":"//misk/misk.client/HttpClientConfig/ssl
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/unix-socket-file/","title":"unixSocketFile - Misk","text":"//misk/misk.client/HttpClientConfig/unixSocketFile
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/unix-socket-file/#unixsocketfile","title":"unixSocketFile","text":"[jvm]\\ val unixSocketFile: String? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/write-timeout/","title":"writeTimeout - Misk","text":"//misk/misk.client/HttpClientConfig/writeTimeout
"},{"location":"0.x/misk/misk/misk.client/-http-client-config/write-timeout/#writetimeout","title":"writeTimeout","text":"[jvm]\\ val writeTimeout: Duration? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/","title":"HttpClientConfigUrlProvider - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#httpclientconfigurlprovider","title":"HttpClientConfigUrlProvider","text":"[jvm]\\ class HttpClientConfigUrlProvider@Injectconstructor
Calculates the url for an http client config, which can differ depending on if the client is envoy-based or connects directly.
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#constructors","title":"Constructors","text":"HttpClientConfigUrlProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#properties","title":"Properties","text":"Name Summary envoyClientEndpointProvider [jvm]@Inject(optional = true)lateinit var envoyClientEndpointProvider: EnvoyClientEndpointProvider"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/#functions","title":"Functions","text":"Name Summary getUrl [jvm]fun getUrl(endpointConfig: HttpClientEndpointConfig): String"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/-http-client-config-url-provider/","title":"HttpClientConfigUrlProvider - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider/HttpClientConfigUrlProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/-http-client-config-url-provider/#httpclientconfigurlprovider","title":"HttpClientConfigUrlProvider","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/envoy-client-endpoint-provider/","title":"envoyClientEndpointProvider - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider/envoyClientEndpointProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"envoyClientEndpointProvider","text":"[jvm]\\
@Inject(optional = true)
lateinit var envoyClientEndpointProvider: EnvoyClientEndpointProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/get-url/","title":"getUrl - Misk","text":"//misk/misk.client/HttpClientConfigUrlProvider/getUrl
"},{"location":"0.x/misk/misk/misk.client/-http-client-config-url-provider/get-url/#geturl","title":"getUrl","text":"[jvm]\\ fun getUrl(endpointConfig: HttpClientEndpointConfig): String
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\ data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#constructors","title":"Constructors","text":"HttpClientEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#properties","title":"Properties","text":"Name Summary clientConfig [jvm]val clientConfig: HttpClientConfig envoy [jvm]val envoy: HttpClientEnvoyConfig? = null url [jvm]val url: String? = null"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientEndpointConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/client-config/","title":"clientConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/clientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"[jvm]\\ val clientConfig: HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/envoy/","title":"envoy - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/envoy
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/envoy/#envoy","title":"envoy","text":"[jvm]\\ val envoy: HttpClientEnvoyConfig? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/url/","title":"url - Misk","text":"//misk/misk.client/HttpClientEndpointConfig/url
"},{"location":"0.x/misk/misk/misk.client/-http-client-endpoint-config/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\ data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#constructors","title":"Constructors","text":"HttpClientEnvoyConfig [jvm]@JvmOverloadsconstructor(app: String, env: String? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#properties","title":"Properties","text":"Name Summary app [jvm]val app: String env [jvm]val env: String? = nullEnvironment to target. If null, the same environment as the app is running in is assumed."},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientEnvoyConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/HttpClientEnvoyConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\
@JvmOverloads
constructor(app: String, env: String? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/app/","title":"app - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/app
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/app/#app","title":"app","text":"[jvm]\\ val app: String
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/env/","title":"env - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/env
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/env/#env","title":"env","text":"[jvm]\\ val env: String? = null
Environment to target. If null, the same environment as the app is running in is assumed.
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientEnvoyConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-envoy-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientEnvoyConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//misk/misk.client/HttpClientFactory
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\ @Singleton
class HttpClientFactory@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#constructors","title":"Constructors","text":"HttpClientFactory [jvm]@Injectconstructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#properties","title":"Properties","text":"Name Summary envoyClientEndpointProvider [jvm]@Inject(optional = true)var envoyClientEndpointProvider: EnvoyClientEndpointProvider? okhttpInterceptors [jvm]@Inject(optional = true)var okhttpInterceptors: Provider<List<Interceptor>>?"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(config: HttpClientEndpointConfig): OkHttpClientReturns a client initialized based onconfig."},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//misk/misk.client/HttpClientFactory/HttpClientFactory
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\
@Inject
constructor(sslLoader: SslLoader, sslContextFactory: SslContextFactory, okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator)
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/","title":"create - Misk","text":"//misk/misk.client/HttpClientFactory/create
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/create/#create","title":"create","text":"[jvm]\\ fun create(config: HttpClientEndpointConfig): OkHttpClient
Returns a client initialized based on config.
//misk/misk.client/HttpClientFactory/envoyClientEndpointProvider
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"envoyClientEndpointProvider","text":"[jvm]\\
@Inject(optional = true)
var envoyClientEndpointProvider: EnvoyClientEndpointProvider?
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/okhttp-interceptors/","title":"okhttpInterceptors - Misk","text":"//misk/misk.client/HttpClientFactory/okhttpInterceptors
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/okhttp-interceptors/#okhttpinterceptors","title":"okhttpInterceptors","text":"[jvm]\\
@Inject(optional = true)
var okhttpInterceptors: Provider<List<Interceptor>>?
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-companion/","title":"Companion - Misk","text":"//misk/misk.client/HttpClientFactory/Companion
"},{"location":"0.x/misk/misk/misk.client/-http-client-factory/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/","title":"HttpClientModule - Misk","text":"//misk/misk.client/HttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#httpclientmodule","title":"HttpClientModule","text":"[jvm]\\ class HttpClientModule@JvmOverloadsconstructor(name: String, annotation: Annotation? = null) : KAbstractModule
Provides an OkHttpClient and ProtoMessageHttpClient for a peer service
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#constructors","title":"Constructors","text":"HttpClientModule [jvm]@JvmOverloadsconstructor(name: String, annotation: Annotation? = null)"},{"location":"0.x/misk/misk/misk.client/-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-http-client-module/-http-client-module/","title":"HttpClientModule - Misk","text":"//misk/misk.client/HttpClientModule/HttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-http-client-module/-http-client-module/#httpclientmodule","title":"HttpClientModule","text":"[jvm]\\
@JvmOverloads
constructor(name: String, annotation: Annotation? = null)
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//misk/misk.client/HttpClientSSLConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig)
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#constructors","title":"Constructors","text":"HttpClientSSLConfig [jvm]constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig? trust_store [jvm]val trust_store: TrustStoreConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): HttpClientSSLConfig"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//misk/misk.client/HttpClientSSLConfig/HttpClientSSLConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/cert_store/","title":"cert_store - Misk","text":"//misk/misk.client/HttpClientSSLConfig/cert_store
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/cert_store/#cert_store","title":"cert_store","text":"[jvm]\\ val cert_store: CertStoreConfig?
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk/misk.client/HttpClientSSLConfig/toWispConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): HttpClientSSLConfig
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/trust_store/","title":"trust_store - Misk","text":"//misk/misk.client/HttpClientSSLConfig/trust_store
"},{"location":"0.x/misk/misk/misk.client/-http-client-s-s-l-config/trust_store/#trust_store","title":"trust_store","text":"[jvm]\\ val trust_store: TrustStoreConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//misk/misk.client/HttpClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\ data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), val logRequests: Boolean = false) : Config
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#constructors","title":"Constructors","text":"HttpClientsConfig [jvm]@JvmOverloadsconstructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), logRequests: Boolean = false)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#properties","title":"Properties","text":"Name Summary endpoints [jvm]val endpoints: Map<String, HttpClientEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig> logRequests [jvm]val logRequests: Boolean = false"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/#functions","title":"Functions","text":"Name Summary endpointNames [jvm]fun endpointNames(): Set<String>Names of configured endpoints, all of which can be fetched using get get [jvm]operator fun get(url: URL): HttpClientEndpointConfigoperator fun get(clientName: String): HttpClientEndpointConfig"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//misk/misk.client/HttpClientsConfig/HttpClientsConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\
@JvmOverloads
constructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf(), logRequests: Boolean = false)
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoint-names/","title":"endpointNames - Misk","text":"//misk/misk.client/HttpClientsConfig/endpointNames
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoint-names/#endpointnames","title":"endpointNames","text":"[jvm]\\ fun endpointNames(): Set<String>
Names of configured endpoints, all of which can be fetched using get
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoints/","title":"endpoints - Misk","text":"//misk/misk.client/HttpClientsConfig/endpoints
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/endpoints/#endpoints","title":"endpoints","text":"[jvm]\\ val endpoints: Map<String, HttpClientEndpointConfig>
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/","title":"get - Misk","text":"//misk/misk.client/HttpClientsConfig/get
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#get","title":"get","text":"[jvm]\\ operator fun get(clientName: String): HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#return","title":"Return","text":"The HttpClientEndpointConfig for the given client, populated with defaults as needed
[jvm]\\ operator fun get(url: URL): HttpClientEndpointConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/get/#return_1","title":"Return","text":"The HttpClientEndpointConfig for the given URL, populated with defaults as needed
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/host-configs/","title":"hostConfigs - Misk","text":"//misk/misk.client/HttpClientsConfig/hostConfigs
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/log-requests/","title":"logRequests - Misk","text":"//misk/misk.client/HttpClientsConfig/logRequests
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/log-requests/#logrequests","title":"logRequests","text":"[jvm]\\ val logRequests: Boolean = false
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/","title":"Companion - Misk","text":"//misk/misk.client/HttpClientsConfig/Companion
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/#properties","title":"Properties","text":"Name Summary httpClientConfigDefaults [jvm]val httpClientConfigDefaults: HttpClientConfig logger [jvm]val logger: KLogger"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/http-client-config-defaults/","title":"httpClientConfigDefaults - Misk","text":"//misk/misk.client/HttpClientsConfig/Companion/httpClientConfigDefaults
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/http-client-config-defaults/#httpclientconfigdefaults","title":"httpClientConfigDefaults","text":"[jvm]\\ val httpClientConfigDefaults: HttpClientConfig
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/logger/","title":"logger - Misk","text":"//misk/misk.client/HttpClientsConfig/Companion/logger
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/","title":"HttpClientsConfigModule - Misk","text":"//misk/misk.client/HttpClientsConfigModule
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#httpclientsconfigmodule","title":"HttpClientsConfigModule","text":"[jvm]\\ class HttpClientsConfigModule(config: HttpClientsConfig) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#constructors","title":"Constructors","text":"HttpClientsConfigModule [jvm]constructor(config: HttpClientsConfig)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/-http-clients-config-module/","title":"HttpClientsConfigModule - Misk","text":"//misk/misk.client/HttpClientsConfigModule/HttpClientsConfigModule
"},{"location":"0.x/misk/misk/misk.client/-http-clients-config-module/-http-clients-config-module/#httpclientsconfigmodule","title":"HttpClientsConfigModule","text":"[jvm]\\ constructor(config: HttpClientsConfig)
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/","title":"JettyPortPeerClientModule - Misk","text":"//misk/misk.client/JettyPortPeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#jettyportpeerclientmodule","title":"JettyPortPeerClientModule","text":"[jvm]\\ class JettyPortPeerClientModule : KAbstractModule
For testing.
Binds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the Jetty server\u2019s port.
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#constructors","title":"Constructors","text":"JettyPortPeerClientModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) peerClientFactory [jvm]@Provides@Singletonfun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, jetty: JettyService): PeerClientFactory"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/-jetty-port-peer-client-module/","title":"JettyPortPeerClientModule - Misk","text":"//misk/misk.client/JettyPortPeerClientModule/JettyPortPeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/-jetty-port-peer-client-module/#jettyportpeerclientmodule","title":"JettyPortPeerClientModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/peer-client-factory/","title":"peerClientFactory - Misk","text":"//misk/misk.client/JettyPortPeerClientModule/peerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-jetty-port-peer-client-module/peer-client-factory/#peerclientfactory","title":"peerClientFactory","text":"[jvm]\\
@Provides
@Singleton
fun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, jetty: JettyService): PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\ class OkHttpClientCommonConfigurator@Injectconstructor
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#constructors","title":"Constructors","text":"OkHttpClientCommonConfigurator [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: OkHttpClientCommonConfigurator"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator/OkHttpClientCommonConfigurator
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/configure/","title":"configure - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator/configure
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/configure/#configure","title":"configure","text":"[jvm]\\ fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/delegate/","title":"delegate - Misk","text":"//misk/misk.client/OkHttpClientCommonConfigurator/delegate
"},{"location":"0.x/misk/misk/misk.client/-ok-http-client-common-configurator/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: OkHttpClientCommonConfigurator
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/","title":"PeerClientFactory - Misk","text":"//misk/misk.client/PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#peerclientfactory","title":"PeerClientFactory","text":"[jvm]\\ class PeerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)
Factory that creates OkHttpClients for connecting to another instance of the same application running in the same cluster.
An OkHttpClient is cached for each peer.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#constructors","title":"Constructors","text":"PeerClientFactory [jvm]constructor(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/#functions","title":"Functions","text":"Name Summary baseUrl [jvm]fun baseUrl(peer: Cluster.Member): StringGet the base URL for calling the given peer cluster member. client [jvm]fun client(peer: Cluster.Member): OkHttpClientGet a client to call the given peer cluster member. This client will fail when calling different services, as determined by the OU in the certificate returned by the called service."},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/-peer-client-factory/","title":"PeerClientFactory - Misk","text":"//misk/misk.client/PeerClientFactory/PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/-peer-client-factory/#peerclientfactory","title":"PeerClientFactory","text":"[jvm]\\ constructor(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, httpsPort: Int)
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/base-url/","title":"baseUrl - Misk","text":"//misk/misk.client/PeerClientFactory/baseUrl
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/base-url/#baseurl","title":"baseUrl","text":"[jvm]\\ fun baseUrl(peer: Cluster.Member): String
Get the base URL for calling the given peer cluster member.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/client/","title":"client - Misk","text":"//misk/misk.client/PeerClientFactory/client
"},{"location":"0.x/misk/misk/misk.client/-peer-client-factory/client/#client","title":"client","text":"[jvm]\\ fun client(peer: Cluster.Member): OkHttpClient
Get a client to call the given peer cluster member. This client will fail when calling different services, as determined by the OU in the certificate returned by the called service.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/","title":"PeerClientModule - Misk","text":"//misk/misk.client/PeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#peerclientmodule","title":"PeerClientModule","text":"[jvm]\\ class PeerClientModule : KAbstractModule
Binds a PeerClientFactory that calls peers on the HTTPS port of this process\u2019s server, as determined by the SSL port in the WebConfig.
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#constructors","title":"Constructors","text":"PeerClientModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) peerClientFactory [jvm]@Provides@Singletonfun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, webConfig: WebConfig): PeerClientFactory"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/-peer-client-module/","title":"PeerClientModule - Misk","text":"//misk/misk.client/PeerClientModule/PeerClientModule
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/-peer-client-module/#peerclientmodule","title":"PeerClientModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/peer-client-factory/","title":"peerClientFactory - Misk","text":"//misk/misk.client/PeerClientModule/peerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-peer-client-module/peer-client-factory/#peerclientfactory","title":"peerClientFactory","text":"[jvm]\\
@Provides
@Singleton
fun peerClientFactory(appName: String, httpClientsConfig: HttpClientsConfig, httpClientFactory: HttpClientFactory, webConfig: WebConfig): PeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/","title":"ProtoMessageHttpClient - Misk","text":"//misk/misk.client/ProtoMessageHttpClient
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#protomessagehttpclient","title":"ProtoMessageHttpClient","text":"[jvm]\\ class ProtoMessageHttpClient(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)
This helper class is for making HTTP requests to an endpoint that handles protobuf Message classes.
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#constructors","title":"Constructors","text":"ProtoMessageHttpClient [jvm]constructor(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/#functions","title":"Functions","text":"Name Summary post [jvm]inline fun <O : Any> post(path: String, requestBody: Message<, *>): Ofun <O : Any> post(path: String, requestBody: Message<, *>, responseType: Class<O>): O"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/-proto-message-http-client/","title":"ProtoMessageHttpClient - Misk","text":"//misk/misk.client/ProtoMessageHttpClient/ProtoMessageHttpClient
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/-proto-message-http-client/#protomessagehttpclient","title":"ProtoMessageHttpClient","text":"[jvm]\\ constructor(baseUrl: String, moshi: Moshi, okHttp: OkHttpClient)
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/post/","title":"post - Misk","text":"//misk/misk.client/ProtoMessageHttpClient/post
"},{"location":"0.x/misk/misk/misk.client/-proto-message-http-client/post/#post","title":"post","text":"[jvm]\\ fun <O : Any> post(path: String, requestBody: Message<*, *>, responseType: Class<O>): O
inline fun <O : Any> post(path: String, requestBody: Message<*, *>): O
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/","title":"TypedClientFactory - Misk","text":"//misk/misk.client/TypedClientFactory
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#typedclientfactory","title":"TypedClientFactory","text":"[jvm]\\ class TypedClientFactory@Injectconstructor
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#constructors","title":"Constructors","text":"TypedClientFactory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/#functions","title":"Functions","text":"Name Summary build [jvm]@JvmOverloadsinline fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null): TReified flavor of build[jvm]fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>?): TBuild up a typed client dynamically in runtime. This is useful for platform-type services that cannot statically define all of the services they talk to."},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/-typed-client-factory/","title":"TypedClientFactory - Misk","text":"//misk/misk.client/TypedClientFactory/TypedClientFactory
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/-typed-client-factory/#typedclientfactory","title":"TypedClientFactory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/","title":"build - Misk","text":"//misk/misk.client/TypedClientFactory/build
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/#build","title":"build","text":"[jvm]\\ fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>?): T
Build up a typed client dynamically in runtime. This is useful for platform-type services that cannot statically define all of the services they talk to.
Services should cache the resulting clients to avoid incurring the construction on every call.
"},{"location":"0.x/misk/misk/misk.client/-typed-client-factory/build/#parameters","title":"Parameters","text":"jvm
endpointConfig HTTP configuration to use to connect to the service kclass The class of the typed client that will be built name A name to reference the client by for observability purposes retrofitBuilderProvider Optional retrofit builder override. If not provided, an empty builder is used[jvm]\\
@JvmOverloads
inline fun <T : Any> build(endpointConfig: HttpClientEndpointConfig, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null): T
Reified flavor of build
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/","title":"TypedHttpClientModule - Misk","text":"//misk/misk.client/TypedHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#typedhttpclientmodule","title":"TypedHttpClientModule","text":"class TypedHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModule
Creates a retrofit-backed typed client given an API interface and an HTTP configuration.
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#parameters","title":"Parameters","text":"jvm
retrofitBuilderProvider Optional provider of a Retrofit.Builder. This provider should not return a singleton since the builder it returns will be mutated."},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#constructors","title":"Constructors","text":"TypedHttpClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/","title":"TypedHttpClientModule - Misk","text":"//misk/misk.client/TypedHttpClientModule/TypedHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/#typedhttpclientmodule","title":"TypedHttpClientModule","text":"[jvm]\\
@JvmOverloads
constructor(kclass: KClass<T>, name: String, annotation: Annotation? = null, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-typed-http-client-module/#parameters","title":"Parameters","text":"jvm
retrofitBuilderProvider Optional provider of a Retrofit.Builder. This provider should not return a singleton since the builder it returns will be mutated."},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/","title":"Companion - Misk","text":"//misk/misk.client/TypedHttpClientModule/Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Any> create(name: String, annotation: Annotation? = null): TypedHttpClientModule<T>"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/create/","title":"create - Misk","text":"//misk/misk.client/TypedHttpClientModule/Companion/create
"},{"location":"0.x/misk/misk/misk.client/-typed-http-client-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Any> create(name: String, annotation: Annotation? = null): TypedHttpClientModule<T>
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/","title":"TypedPeerClientFactory - Misk","text":"//misk/misk.client/TypedPeerClientFactory
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/#typedpeerclientfactory","title":"TypedPeerClientFactory","text":"[jvm]\\ interface TypedPeerClientFactory<T>
Factory for creating typed clients that call other members of a cluster.
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/#functions","title":"Functions","text":"Name Summary client [jvm]abstract fun client(peer: Cluster.Member): T"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/client/","title":"client - Misk","text":"//misk/misk.client/TypedPeerClientFactory/client
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-client-factory/client/#client","title":"client","text":"[jvm]\\ abstract fun client(peer: Cluster.Member): T
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/","title":"TypedPeerHttpClientModule - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#typedpeerhttpclientmodule","title":"TypedPeerHttpClientModule","text":"[jvm]\\ class TypedPeerHttpClientModule<T : Any>@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null) : KAbstractModule
Creates a retrofit-backed typed client factory given an API interface and an HTTP configuration.
The factory returned typed clients that can be used to call other members of the cluster.
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#constructors","title":"Constructors","text":"TypedPeerHttpClientModule [jvm]@JvmOverloadsconstructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-typed-peer-http-client-module/","title":"TypedPeerHttpClientModule - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule/TypedPeerHttpClientModule
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-typed-peer-http-client-module/#typedpeerhttpclientmodule","title":"TypedPeerHttpClientModule","text":"[jvm]\\
@JvmOverloads
constructor(kclass: KClass<T>, name: String, retrofitBuilderProvider: Provider<Retrofit.Builder>? = null)
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/","title":"Companion - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule/Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Any> create(name: String): TypedPeerHttpClientModule<T>"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/create/","title":"create - Misk","text":"//misk/misk.client/TypedPeerHttpClientModule/Companion/create
"},{"location":"0.x/misk/misk/misk.client/-typed-peer-http-client-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Any> create(name: String): TypedPeerHttpClientModule<T>
"},{"location":"0.x/misk/misk/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk/misk.concurrent
"},{"location":"0.x/misk/misk/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.concurrent/#types","title":"Types","text":"Name Summary ExecutorServiceModule [jvm]class ExecutorServiceModule(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService) : KAbstractModuleInstall this to bind an executor service with annotation. The executor service will be automatically shut down when the service shuts down. ExplicitReleaseBlockingQueue [jvm]class ExplicitReleaseBlockingQueue<T> : BlockingQueue<T> An ExplicitReleaseBlockingQueue is a BlockingQueue that only returns elements from BlockingQueue.take, BlockingQueue.poll, and BlockingQueue.peek after a call to ExplicitReleaseBlockingQueue.release. Used by tests that want to explicitly control when pollers receive queued items. ExplicitReleaseDelayQueue [jvm]class ExplicitReleaseDelayQueue<T : Delayed> : BlockingQueue<T> An ExplicitReleaseDelayQueue is an ExplicitReleaseBlockingQueue that release elements in the order in which they expire WrappingListeningExecutorService [jvm]abstract class WrappingListeningExecutorService : ForwardingListeningExecutorServiceListeningExecutorService which wraps all calls"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/","title":"ExecutorServiceModule - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#executorservicemodule","title":"ExecutorServiceModule","text":"[jvm]\\ class ExecutorServiceModule(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService) : KAbstractModule
Install this to bind an executor service with annotation. The executor service will be automatically shut down when the service shuts down.
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#constructors","title":"Constructors","text":"ExecutorServiceModule [jvm]constructor(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService)"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-executor-service-module/","title":"ExecutorServiceModule - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-executor-service-module/#executorservicemodule","title":"ExecutorServiceModule","text":"[jvm]\\ constructor(annotation: KClass<out Annotation>, createFunction: (ExecutorServiceFactory) -> ExecutorService)
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/","title":"Companion - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/Companion
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/#functions","title":"Functions","text":"Name Summary withFixedThreadPool [jvm]fun withFixedThreadPool(annotation: KClass<out Annotation>, nameFormat: String, nThreads: Int): ExecutorServiceModule withUnboundThreadPool [jvm]fun withUnboundThreadPool(annotation: KClass<out Annotation>, nameFormat: String): ExecutorServiceModule"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-fixed-thread-pool/","title":"withFixedThreadPool - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/Companion/withFixedThreadPool
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-fixed-thread-pool/#withfixedthreadpool","title":"withFixedThreadPool","text":"[jvm]\\ fun withFixedThreadPool(annotation: KClass<out Annotation>, nameFormat: String, nThreads: Int): ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-unbound-thread-pool/","title":"withUnboundThreadPool - Misk","text":"//misk/misk.concurrent/ExecutorServiceModule/Companion/withUnboundThreadPool
"},{"location":"0.x/misk/misk/misk.concurrent/-executor-service-module/-companion/with-unbound-thread-pool/#withunboundthreadpool","title":"withUnboundThreadPool","text":"[jvm]\\ fun withUnboundThreadPool(annotation: KClass<out Annotation>, nameFormat: String): ExecutorServiceModule
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/","title":"ExplicitReleaseBlockingQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#explicitreleaseblockingqueue","title":"ExplicitReleaseBlockingQueue","text":"[jvm]\\ class ExplicitReleaseBlockingQueue<T> : BlockingQueue<T>
An ExplicitReleaseBlockingQueue is a BlockingQueue that only returns elements from BlockingQueue.take, BlockingQueue.poll, and BlockingQueue.peek after a call to ExplicitReleaseBlockingQueue.release. Used by tests that want to explicitly control when pollers receive queued items.
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#constructors","title":"Constructors","text":"ExplicitReleaseBlockingQueue [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#properties","title":"Properties","text":"Name Summary size [jvm]open override val size: Int"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(element: T): Boolean addAll [jvm]open override fun addAll(elements: Collection<T>): Boolean clear [jvm]open override fun clear() contains [jvm]open operator override fun contains(element: T): Boolean containsAll [jvm]open override fun containsAll(elements: Collection<T>): Boolean drainTo [jvm]open override fun drainTo(c: MutableCollection<in T>): Intopen override fun drainTo(c: MutableCollection<in T>?, maxElements: Int): Int element [jvm]open override fun element(): T forEach [jvm]open fun forEach(p0: Consumer<in T>) isEmpty [jvm]open override fun isEmpty(): Boolean iterator [jvm]open operator override fun iterator(): MutableIterator<T> offer [jvm]open override fun offer(e: T): Booleanopen override fun offer(e: T, timeout: Long, unit: TimeUnit): Boolean parallelStream [jvm]open fun parallelStream(): Stream<T> peek [jvm]open override fun peek(): T? peekPending [jvm]fun peekPending(): T? poll [jvm]open override fun poll(): T?open override fun poll(timeout: Long, unit: TimeUnit): T? put [jvm]open override fun put(e: T) release [jvm]fun release(n: Int): Intreleases up to n items from the pending queue, making them visible to take, poll, peek, etc. This method does not \"extend credit\"; if n number of pending items on the queue, every currently pending item is made visible, but any items added in the future continue to go onto the pending queue releaseAll [jvm]fun releaseAll(): Intreleases all items from the pending queue, returning the number of items released remainingCapacity [jvm]open override fun remainingCapacity(): Int remove [jvm]open override fun remove(): T?open override fun remove(element: T): Boolean removeAll [jvm]open override fun removeAll(elements: Collection<T>): Boolean removeIf [jvm]open fun removeIf(p0: Predicate<in T>): Boolean retainAll [jvm]open override fun retainAll(elements: Collection<T>): Boolean spliterator [jvm]open override fun spliterator(): Spliterator<T> stream [jvm]open fun stream(): Stream<T> take [jvm]open override fun take(): T"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/-explicit-release-blocking-queue/","title":"ExplicitReleaseBlockingQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/ExplicitReleaseBlockingQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/-explicit-release-blocking-queue/#explicitreleaseblockingqueue","title":"ExplicitReleaseBlockingQueue","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add-all/","title":"addAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/addAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add-all/#addall","title":"addAll","text":"[jvm]\\ open override fun addAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add/","title":"add - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/add
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/add/#add","title":"add","text":"[jvm]\\ open override fun add(element: T): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/clear/","title":"clear - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/clear
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/clear/#clear","title":"clear","text":"[jvm]\\ open override fun clear()
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains-all/","title":"containsAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/containsAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains-all/#containsall","title":"containsAll","text":"[jvm]\\ open override fun containsAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains/","title":"contains - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/contains
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/contains/#contains","title":"contains","text":"[jvm]\\ open operator override fun contains(element: T): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/drain-to/","title":"drainTo - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/drainTo
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/drain-to/#drainto","title":"drainTo","text":"[jvm]\\ open override fun drainTo(c: MutableCollection<in T>): Int
open override fun drainTo(c: MutableCollection<in T>?, maxElements: Int): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/element/","title":"element - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/element
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/element/#element","title":"element","text":"[jvm]\\ open override fun element(): T
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/is-empty/","title":"isEmpty - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/isEmpty
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/is-empty/#isempty","title":"isEmpty","text":"[jvm]\\ open override fun isEmpty(): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/iterator/","title":"iterator - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/iterator
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/iterator/#iterator","title":"iterator","text":"[jvm]\\ open operator override fun iterator(): MutableIterator<T>
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/offer/","title":"offer - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/offer
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/offer/#offer","title":"offer","text":"[jvm]\\ open override fun offer(e: T): Boolean
open override fun offer(e: T, timeout: Long, unit: TimeUnit): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek-pending/","title":"peekPending - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/peekPending
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek-pending/#peekpending","title":"peekPending","text":"[jvm]\\ fun peekPending(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek/","title":"peek - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/peek
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/peek/#peek","title":"peek","text":"[jvm]\\ open override fun peek(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/poll/","title":"poll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/poll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/poll/#poll","title":"poll","text":"[jvm]\\ open override fun poll(timeout: Long, unit: TimeUnit): T?
open override fun poll(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/put/","title":"put - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/put
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/put/#put","title":"put","text":"[jvm]\\ open override fun put(e: T)
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release-all/","title":"releaseAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/releaseAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ fun releaseAll(): Int
releases all items from the pending queue, returning the number of items released
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/","title":"release - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/release
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/#release","title":"release","text":"[jvm]\\ fun release(n: Int): Int
releases up to n items from the pending queue, making them visible to take, poll, peek, etc. This method does not \"extend credit\"; if n number of pending items on the queue, every currently pending item is made visible, but any items added in the future continue to go onto the pending queue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/release/#return","title":"Return","text":"the number of items actually releases
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remaining-capacity/","title":"remainingCapacity - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/remainingCapacity
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remaining-capacity/#remainingcapacity","title":"remainingCapacity","text":"[jvm]\\ open override fun remainingCapacity(): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove-all/","title":"removeAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/removeAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove-all/#removeall","title":"removeAll","text":"[jvm]\\ open override fun removeAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove/","title":"remove - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/remove
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/remove/#remove","title":"remove","text":"[jvm]\\ open override fun remove(element: T): Boolean
open override fun remove(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/retain-all/","title":"retainAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/retainAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/retain-all/#retainall","title":"retainAll","text":"[jvm]\\ open override fun retainAll(elements: Collection<T>): Boolean
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/size/","title":"size - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/size
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/size/#size","title":"size","text":"[jvm]\\ open override val size: Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/take/","title":"take - Misk","text":"//misk/misk.concurrent/ExplicitReleaseBlockingQueue/take
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-blocking-queue/take/#take","title":"take","text":"[jvm]\\ open override fun take(): T
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/","title":"ExplicitReleaseDelayQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#explicitreleasedelayqueue","title":"ExplicitReleaseDelayQueue","text":"[jvm]\\ class ExplicitReleaseDelayQueue<T : Delayed> : BlockingQueue<T>
An ExplicitReleaseDelayQueue is an ExplicitReleaseBlockingQueue that release elements in the order in which they expire
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#constructors","title":"Constructors","text":"ExplicitReleaseDelayQueue [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#properties","title":"Properties","text":"Name Summary size [jvm]open override val size: Int"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(element: T): Boolean addAll [jvm]open override fun addAll(elements: Collection<T>): Boolean clear [jvm]open override fun clear() contains [jvm]open operator override fun contains(element: T): Boolean containsAll [jvm]open override fun containsAll(elements: Collection<T>): Boolean drainTo [jvm]open override fun drainTo(p0: MutableCollection<in T>): Intopen override fun drainTo(p0: MutableCollection<in T>, p1: Int): Int element [jvm]open override fun element(): T forEach [jvm]open fun forEach(p0: Consumer<in T>) isEmpty [jvm]open override fun isEmpty(): Boolean iterator [jvm]open operator override fun iterator(): MutableIterator<T> offer [jvm]open override fun offer(p0: T): Booleanopen override fun offer(p0: T, p1: Long, p2: TimeUnit): Boolean parallelStream [jvm]open fun parallelStream(): Stream<T> peek [jvm]open override fun peek(): T peekPending [jvm]fun peekPending(): T? poll [jvm]open override fun poll(): Topen override fun poll(p0: Long, p1: TimeUnit): T put [jvm]open override fun put(p0: T) release [jvm]fun release(n: Int): Int releaseAll [jvm]fun releaseAll(): Int remainingCapacity [jvm]open override fun remainingCapacity(): Int remove [jvm]open override fun remove(): Topen override fun remove(element: T): Boolean removeAll [jvm]open override fun removeAll(elements: Collection<T>): Boolean removeIf [jvm]open fun removeIf(p0: Predicate<in T>): Boolean retainAll [jvm]open override fun retainAll(elements: Collection<T>): Boolean spliterator [jvm]open override fun spliterator(): Spliterator<T> stream [jvm]open fun stream(): Stream<T> take [jvm]open override fun take(): T"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/-explicit-release-delay-queue/","title":"ExplicitReleaseDelayQueue - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/ExplicitReleaseDelayQueue
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/-explicit-release-delay-queue/#explicitreleasedelayqueue","title":"ExplicitReleaseDelayQueue","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/peek-pending/","title":"peekPending - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/peekPending
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/peek-pending/#peekpending","title":"peekPending","text":"[jvm]\\ fun peekPending(): T?
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release-all/","title":"releaseAll - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/releaseAll
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ fun releaseAll(): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release/","title":"release - Misk","text":"//misk/misk.concurrent/ExplicitReleaseDelayQueue/release
"},{"location":"0.x/misk/misk/misk.concurrent/-explicit-release-delay-queue/release/#release","title":"release","text":"[jvm]\\ fun release(n: Int): Int
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"[jvm]\\ abstract class WrappingListeningExecutorService : ForwardingListeningExecutorService
ListeningExecutorService which wraps all calls
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/#constructors","title":"Constructors","text":"WrappingListeningExecutorService [jvm]constructor()"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/WrappingListeningExecutorService
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/execute/","title":"execute - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/execute
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(runnable: Runnable)
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-all/","title":"invokeAll - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/invokeAll
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-all/#invokeall","title":"invokeAll","text":"[jvm]\\ open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>
open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>>
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-any/","title":"invokeAny - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/invokeAny
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/invoke-any/#invokeany","title":"invokeAny","text":"[jvm]\\ open override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Any
open override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/submit/","title":"submit - Misk","text":"//misk/misk.concurrent/WrappingListeningExecutorService/submit
"},{"location":"0.x/misk/misk/misk.concurrent/-wrapping-listening-executor-service/submit/#submit","title":"submit","text":"[jvm]\\ open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>
open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T>
open override fun submit(runnable: Runnable): ListenableFuture<*>
"},{"location":"0.x/misk/misk/misk.environment/","title":"Package-level declarations - Misk","text":"//misk/misk.environment
"},{"location":"0.x/misk/misk/misk.environment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.environment/#types","title":"Types","text":"Name Summary DeploymentModule [jvm]class DeploymentModule@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable()) : KAbstractModuleBinds Deployment to make it available to services and actions EnvVarLoader [jvm]interface EnvVarLoader : EnvironmentVariableLoaderLoads an environment variable value. FakeEnvVarModule [jvm]class FakeEnvVarModule : KAbstractModuleBinds a EnvVarLoader for tests. Tests can contribute values through the@ForEnvVars Map<String, String> binding. ForEnvVars [jvm]@Qualifierannotation class ForEnvVars RealEnvVarModule [jvm]class RealEnvVarModule : KAbstractModuleBinds a EnvVarLoader for production"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/","title":"DeploymentModule - Misk","text":"//misk/misk.environment/DeploymentModule
"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#deploymentmodule","title":"DeploymentModule","text":"[jvm]\\ class DeploymentModule@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable()) : KAbstractModule
Binds Deployment to make it available to services and actions
"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#constructors","title":"Constructors","text":"DeploymentModule [jvm]@JvmOverloadsconstructor(deployment: Deployment = getDeploymentFromEnvironmentVariable())"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/-deployment-module/","title":"DeploymentModule - Misk","text":"//misk/misk.environment/DeploymentModule/DeploymentModule
"},{"location":"0.x/misk/misk/misk.environment/-deployment-module/-deployment-module/#deploymentmodule","title":"DeploymentModule","text":"[jvm]\\
@JvmOverloads
constructor(deployment: Deployment = getDeploymentFromEnvironmentVariable())
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/","title":"EnvVarLoader - Misk","text":"//misk/misk.environment/EnvVarLoader
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/#envvarloader","title":"EnvVarLoader","text":"[jvm]\\ interface EnvVarLoader : EnvironmentVariableLoader
Loads an environment variable value.
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): String getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String getEnvVar [jvm]open fun getEnvVar(name: String): StringGet the environment variable value"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/","title":"getEnvVar - Misk","text":"//misk/misk.environment/EnvVarLoader/getEnvVar
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/#getenvvar","title":"getEnvVar","text":"[jvm]\\ open fun getEnvVar(name: String): String
Get the environment variable value
"},{"location":"0.x/misk/misk/misk.environment/-env-var-loader/get-env-var/#throws","title":"Throws","text":"IllegalStateException if the environment variable is not found"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/","title":"FakeEnvVarModule - Misk","text":"//misk/misk.environment/FakeEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/#fakeenvvarmodule","title":"FakeEnvVarModule","text":"[jvm]\\ class FakeEnvVarModule : KAbstractModule
Binds a EnvVarLoader for tests. Tests can contribute values through the @ForEnvVars Map<String, String> binding.
//misk/misk.environment/FakeEnvVarModule/FakeEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-fake-env-var-module/-fake-env-var-module/#fakeenvvarmodule","title":"FakeEnvVarModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.environment/-for-env-vars/","title":"ForEnvVars - Misk","text":"//misk/misk.environment/ForEnvVars
"},{"location":"0.x/misk/misk/misk.environment/-for-env-vars/#forenvvars","title":"ForEnvVars","text":"[jvm]\\ @Qualifier
annotation class ForEnvVars
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/","title":"RealEnvVarModule - Misk","text":"//misk/misk.environment/RealEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#realenvvarmodule","title":"RealEnvVarModule","text":"[jvm]\\ class RealEnvVarModule : KAbstractModule
Binds a EnvVarLoader for production
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#constructors","title":"Constructors","text":"RealEnvVarModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/-real-env-var-module/","title":"RealEnvVarModule - Misk","text":"//misk/misk.environment/RealEnvVarModule/RealEnvVarModule
"},{"location":"0.x/misk/misk/misk.environment/-real-env-var-module/-real-env-var-module/#realenvvarmodule","title":"RealEnvVarModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.grpc/","title":"Package-level declarations - Misk","text":"//misk/misk.grpc
"},{"location":"0.x/misk/misk/misk.grpc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.grpc/#functions","title":"Functions","text":"Name Summary consumeEachAndClose [jvm]fun <T : Any> MessageSource<T>.consumeEachAndClose(block: (T) -> Unit)"},{"location":"0.x/misk/misk/misk.grpc/consume-each-and-close/","title":"consumeEachAndClose - Misk","text":"//misk/misk.grpc/consumeEachAndClose
"},{"location":"0.x/misk/misk/misk.grpc/consume-each-and-close/#consumeeachandclose","title":"consumeEachAndClose","text":"[jvm]\\ fun <T : Any> MessageSource<T>.consumeEachAndClose(block: (T) -> Unit)
"},{"location":"0.x/misk/misk/misk.io/","title":"Package-level declarations - Misk","text":"//misk/misk.io
"},{"location":"0.x/misk/misk/misk.io/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.io/#functions","title":"Functions","text":"Name Summary listRecursively [jvm]fun Path.listRecursively(includeDirs: Boolean = false): List<Path>"},{"location":"0.x/misk/misk/misk.io/list-recursively/","title":"listRecursively - Misk","text":"//misk/misk.io/listRecursively
"},{"location":"0.x/misk/misk/misk.io/list-recursively/#listrecursively","title":"listRecursively","text":"[jvm]\\ fun Path.listRecursively(includeDirs: Boolean = false): List<Path>
"},{"location":"0.x/misk/misk/misk.io/list-recursively/#return","title":"Return","text":"all of the paths beneath this one, including nested paths
"},{"location":"0.x/misk/misk/misk.jvm/","title":"Package-level declarations - Misk","text":"//misk/misk.jvm
"},{"location":"0.x/misk/misk/misk.jvm/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.jvm/#types","title":"Types","text":"Name Summary JvmManagementFactoryModule [jvm]class JvmManagementFactoryModule : KInstallOnceModuleDefault providers for the ManagementFactory beans that the framework depends on."},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/","title":"JvmManagementFactoryModule - Misk","text":"//misk/misk.jvm/JvmManagementFactoryModule
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#jvmmanagementfactorymodule","title":"JvmManagementFactoryModule","text":"[jvm]\\ class JvmManagementFactoryModule : KInstallOnceModule
Default providers for the ManagementFactory beans that the framework depends on.
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#constructors","title":"Constructors","text":"JvmManagementFactoryModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int provideRuntimeMxBean [jvm]@Providesfun provideRuntimeMxBean(): RuntimeMXBean"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/-jvm-management-factory-module/","title":"JvmManagementFactoryModule - Misk","text":"//misk/misk.jvm/JvmManagementFactoryModule/JvmManagementFactoryModule
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/-jvm-management-factory-module/#jvmmanagementfactorymodule","title":"JvmManagementFactoryModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/provide-runtime-mx-bean/","title":"provideRuntimeMxBean - Misk","text":"//misk/misk.jvm/JvmManagementFactoryModule/provideRuntimeMxBean
"},{"location":"0.x/misk/misk/misk.jvm/-jvm-management-factory-module/provide-runtime-mx-bean/#provideruntimemxbean","title":"provideRuntimeMxBean","text":"[jvm]\\
@Provides
fun provideRuntimeMxBean(): RuntimeMXBean
"},{"location":"0.x/misk/misk/misk.logging/","title":"Package-level declarations - Misk","text":"//misk/misk.logging
"},{"location":"0.x/misk/misk/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.logging/#types","title":"Types","text":"Name Summary MdcModule [jvm]class MdcModule : KInstallOnceModule MiskMdc [jvm]object MiskMdc : Mdc"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/","title":"MdcModule - Misk","text":"//misk/misk.logging/MdcModule
"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#mdcmodule","title":"MdcModule","text":"[jvm]\\ class MdcModule : KInstallOnceModule
"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#constructors","title":"Constructors","text":"MdcModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/-mdc-module/","title":"MdcModule - Misk","text":"//misk/misk.logging/MdcModule/MdcModule
"},{"location":"0.x/misk/misk/misk.logging/-mdc-module/-mdc-module/#mdcmodule","title":"MdcModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/","title":"MiskMdc - Misk","text":"//misk/misk.logging/MiskMdc
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/#miskmdc","title":"MiskMdc","text":"[jvm]\\ object MiskMdc : Mdc
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() get [jvm]open override fun get(key: String): String? put [jvm]open override fun put(key: String, value: String?)"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/clear/","title":"clear - Misk","text":"//misk/misk.logging/MiskMdc/clear
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/clear/#clear","title":"clear","text":"[jvm]\\ open override fun clear()
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/get/","title":"get - Misk","text":"//misk/misk.logging/MiskMdc/get
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/get/#get","title":"get","text":"[jvm]\\ open override fun get(key: String): String?
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/put/","title":"put - Misk","text":"//misk/misk.logging/MiskMdc/put
"},{"location":"0.x/misk/misk/misk.logging/-misk-mdc/put/#put","title":"put","text":"[jvm]\\ open override fun put(key: String, value: String?)
"},{"location":"0.x/misk/misk/misk.monitoring/","title":"Package-level declarations - Misk","text":"//misk/misk.monitoring
"},{"location":"0.x/misk/misk/misk.monitoring/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.monitoring/#types","title":"Types","text":"Name Summary JvmMetrics [jvm]@Singletonclass JvmMetrics@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)Exposes additional JVM metrics. MonitoringModule [jvm]class MonitoringModule : KInstallOnceModule"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/","title":"JvmMetrics - Misk","text":"//misk/misk.monitoring/JvmMetrics
"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/#jvmmetrics","title":"JvmMetrics","text":"[jvm]\\ @Singleton
class JvmMetrics@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)
Exposes additional JVM metrics.
"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/#constructors","title":"Constructors","text":"JvmMetrics [jvm]@Injectconstructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/-jvm-metrics/","title":"JvmMetrics - Misk","text":"//misk/misk.monitoring/JvmMetrics/JvmMetrics
"},{"location":"0.x/misk/misk/misk.monitoring/-jvm-metrics/-jvm-metrics/#jvmmetrics","title":"JvmMetrics","text":"[jvm]\\
@Inject
constructor(runtimeMxBean: RuntimeMXBean, metrics: Metrics)
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/","title":"MonitoringModule - Misk","text":"//misk/misk.monitoring/MonitoringModule
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#monitoringmodule","title":"MonitoringModule","text":"[jvm]\\ class MonitoringModule : KInstallOnceModule
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#constructors","title":"Constructors","text":"MonitoringModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/-monitoring-module/","title":"MonitoringModule - Misk","text":"//misk/misk.monitoring/MonitoringModule/MonitoringModule
"},{"location":"0.x/misk/misk/misk.monitoring/-monitoring-module/-monitoring-module/#monitoringmodule","title":"MonitoringModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.moshi/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi
"},{"location":"0.x/misk/misk/misk.moshi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi/#types","title":"Types","text":"Name Summary MoshiAdapterModule [jvm]class MoshiAdapterModule@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false) : KAbstractModule MoshiModule [jvm]class MoshiModule@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false) : KAbstractModuleFor service setup, prefer to install misk.MiskCommonServiceModule over installing MoshiModule directly."},{"location":"0.x/misk/misk/misk.moshi/#functions","title":"Functions","text":"Name Summary adapter [jvm]inline fun <T> Moshi.adapter(): JsonAdapter<T>"},{"location":"0.x/misk/misk/misk.moshi/adapter/","title":"adapter - Misk","text":"//misk/misk.moshi/adapter
"},{"location":"0.x/misk/misk/misk.moshi/adapter/#adapter","title":"adapter","text":"[jvm]\\ inline fun <T> Moshi.adapter(): JsonAdapter<T>
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/","title":"MoshiAdapterModule - Misk","text":"//misk/misk.moshi/MoshiAdapterModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#moshiadaptermodule","title":"MoshiAdapterModule","text":"[jvm]\\ class MoshiAdapterModule@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#constructors","title":"Constructors","text":"MoshiAdapterModule [jvm]@JvmOverloadsconstructor(jsonAdapter: Any, addLast: Boolean = false)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-moshi-adapter-module/","title":"MoshiAdapterModule - Misk","text":"//misk/misk.moshi/MoshiAdapterModule/MoshiAdapterModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-moshi-adapter-module/#moshiadaptermodule","title":"MoshiAdapterModule","text":"[jvm]\\
@JvmOverloads
constructor(jsonAdapter: Any, addLast: Boolean = false)
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/","title":"Companion - Misk","text":"//misk/misk.moshi/MoshiAdapterModule/Companion
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/#functions","title":"Functions","text":"Name Summary invoke [jvm]inline operator fun <T> invoke(adapter: JsonAdapter<T>, addLast: Boolean = false): MoshiAdapterModule"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/invoke/","title":"invoke - Misk","text":"//misk/misk.moshi/MoshiAdapterModule/Companion/invoke
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-adapter-module/-companion/invoke/#invoke","title":"invoke","text":"[jvm]\\ inline operator fun <T> invoke(adapter: JsonAdapter<T>, addLast: Boolean = false): MoshiAdapterModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/","title":"MoshiModule - Misk","text":"//misk/misk.moshi/MoshiModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#moshimodule","title":"MoshiModule","text":"[jvm]\\ class MoshiModule@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false) : KAbstractModule
For service setup, prefer to install misk.MiskCommonServiceModule over installing MoshiModule directly.
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#constructors","title":"Constructors","text":"MoshiModule [jvm]@JvmOverloadsconstructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false)"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singletonfun provideMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any>): Moshi"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-moshi-module/","title":"MoshiModule - Misk","text":"//misk/misk.moshi/MoshiModule/MoshiModule
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/-moshi-module/#moshimodule","title":"MoshiModule","text":"[jvm]\\
@JvmOverloads
constructor(useWireToRead: Boolean = false, useWireToWrite: Boolean = false)
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/provide-moshi/","title":"provideMoshi - Misk","text":"//misk/misk.moshi/MoshiModule/provideMoshi
"},{"location":"0.x/misk/misk/misk.moshi/-moshi-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"[jvm]\\
@Provides
@Singleton
fun provideMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any>): Moshi
"},{"location":"0.x/misk/misk/misk.moshi.adapters/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi.adapters
"},{"location":"0.x/misk/misk/misk.moshi.adapters/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.adapters/#types","title":"Types","text":"Name Summary BigDecimalAdapter [jvm]object BigDecimalAdapter"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/","title":"BigDecimalAdapter - Misk","text":"//misk/misk.moshi.adapters/BigDecimalAdapter
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/#bigdecimaladapter","title":"BigDecimalAdapter","text":"[jvm]\\ object BigDecimalAdapter
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/#functions","title":"Functions","text":"Name Summary decode [jvm]fun decode(decimal: String): BigDecimal encode [jvm]fun encode(decimal: BigDecimal): String"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/decode/","title":"decode - Misk","text":"//misk/misk.moshi.adapters/BigDecimalAdapter/decode
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/decode/#decode","title":"decode","text":"[jvm]\\ fun decode(decimal: String): BigDecimal
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/encode/","title":"encode - Misk","text":"//misk/misk.moshi.adapters/BigDecimalAdapter/encode
"},{"location":"0.x/misk/misk/misk.moshi.adapters/-big-decimal-adapter/encode/#encode","title":"encode","text":"[jvm]\\ fun encode(decimal: BigDecimal): String
"},{"location":"0.x/misk/misk/misk.moshi.okio/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi.okio
"},{"location":"0.x/misk/misk/misk.moshi.okio/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.okio/#types","title":"Types","text":"Name Summary ByteStringAdapter [jvm]object ByteStringAdapterJSON adapter converting ByteStrings as base64 encoded strings"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/","title":"ByteStringAdapter - Misk","text":"//misk/misk.moshi.okio/ByteStringAdapter
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/#bytestringadapter","title":"ByteStringAdapter","text":"[jvm]\\ object ByteStringAdapter
JSON adapter converting ByteStrings as base64 encoded strings
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(value: String): ByteString toJson [jvm]fun toJson(value: ByteString): String"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.okio/ByteStringAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(value: String): ByteString
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.okio/ByteStringAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.okio/-byte-string-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: ByteString): String
"},{"location":"0.x/misk/misk/misk.moshi.time/","title":"Package-level declarations - Misk","text":"//misk/misk.moshi.time
"},{"location":"0.x/misk/misk/misk.moshi.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.moshi.time/#types","title":"Types","text":"Name Summary InstantAdapter [jvm]object InstantAdapter LocalDateAdapter [jvm]object LocalDateAdapter OffsetDateTimeAdapter [jvm]object OffsetDateTimeAdapter"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/","title":"InstantAdapter - Misk","text":"//misk/misk.moshi.time/InstantAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/#instantadapter","title":"InstantAdapter","text":"[jvm]\\ object InstantAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(date: Date?): Instant? toJson [jvm]fun toJson(value: Instant?): Date?"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.time/InstantAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(date: Date?): Instant?
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.time/InstantAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-instant-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: Instant?): Date?
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/","title":"LocalDateAdapter - Misk","text":"//misk/misk.moshi.time/LocalDateAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/#localdateadapter","title":"LocalDateAdapter","text":"[jvm]\\ object LocalDateAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(date: Date?): LocalDate? toJson [jvm]fun toJson(value: LocalDate?): Date?"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.time/LocalDateAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(date: Date?): LocalDate?
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.time/LocalDateAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-local-date-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: LocalDate?): Date?
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/","title":"OffsetDateTimeAdapter - Misk","text":"//misk/misk.moshi.time/OffsetDateTimeAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/#offsetdatetimeadapter","title":"OffsetDateTimeAdapter","text":"[jvm]\\ object OffsetDateTimeAdapter
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/#functions","title":"Functions","text":"Name Summary fromJson [jvm]fun fromJson(value: String?): OffsetDateTime? toJson [jvm]fun toJson(value: OffsetDateTime?): String?"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/from-json/","title":"fromJson - Misk","text":"//misk/misk.moshi.time/OffsetDateTimeAdapter/fromJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/from-json/#fromjson","title":"fromJson","text":"[jvm]\\ fun fromJson(value: String?): OffsetDateTime?
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/to-json/","title":"toJson - Misk","text":"//misk/misk.moshi.time/OffsetDateTimeAdapter/toJson
"},{"location":"0.x/misk/misk/misk.moshi.time/-offset-date-time-adapter/to-json/#tojson","title":"toJson","text":"[jvm]\\ fun toJson(value: OffsetDateTime?): String?
"},{"location":"0.x/misk/misk/misk.okio/","title":"Package-level declarations - Misk","text":"//misk/misk.okio
"},{"location":"0.x/misk/misk/misk.okio/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.okio/#functions","title":"Functions","text":"Name Summary forEachBlock [jvm]fun BufferedSource.forEachBlock(buffer: ByteArray, f: (buffer: ByteArray, bytesRead: Int) -> Unit)fun BufferedSource.forEachBlock(blockSize: Int, f: (buffer: ByteArray, bytesRead: Int) -> Unit) split [jvm]fun BufferedSource.split(separator: ByteString): Sequence<Buffer>"},{"location":"0.x/misk/misk/misk.okio/for-each-block/","title":"forEachBlock - Misk","text":"//misk/misk.okio/forEachBlock
"},{"location":"0.x/misk/misk/misk.okio/for-each-block/#foreachblock","title":"forEachBlock","text":"[jvm]\\ fun BufferedSource.forEachBlock(buffer: ByteArray, f: (buffer: ByteArray, bytesRead: Int) -> Unit)
fun BufferedSource.forEachBlock(blockSize: Int, f: (buffer: ByteArray, bytesRead: Int) -> Unit)
"},{"location":"0.x/misk/misk/misk.okio/split/","title":"split - Misk","text":"//misk/misk.okio/split
"},{"location":"0.x/misk/misk/misk.okio/split/#split","title":"split","text":"[jvm]\\ fun BufferedSource.split(separator: ByteString): Sequence<Buffer>
"},{"location":"0.x/misk/misk/misk.perf/","title":"Package-level declarations - Misk","text":"//misk/misk.perf
"},{"location":"0.x/misk/misk/misk.perf/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.perf/#types","title":"Types","text":"Name Summary ForPauseDetector [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ForPauseDetectorUsed to bind a Sleeper and Ticker that are suitable for usage by the PauseDetector PauseDetectorConfig [jvm]data class PauseDetectorConfig@JvmOverloadsconstructor(val resolutionMillis: Long = 1, val logInfoMillis: Long = 1000, val logWarnMillis: Long = -1, val logErrorMillis: Long = -1, val metricsUpdateFloor: Long = 0)Configuration for the PauseDetector PauseDetectorModule [jvm]class PauseDetectorModule@JvmOverloadsconstructor(val pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig()) : KAbstractModuleInstall this module to run the PauseDetector in the background."},{"location":"0.x/misk/misk/misk.perf/-for-pause-detector/","title":"ForPauseDetector - Misk","text":"//misk/misk.perf/ForPauseDetector
"},{"location":"0.x/misk/misk/misk.perf/-for-pause-detector/#forpausedetector","title":"ForPauseDetector","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ForPauseDetector
Used to bind a Sleeper and Ticker that are suitable for usage by the PauseDetector
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/","title":"PauseDetectorConfig - Misk","text":"//misk/misk.perf/PauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#pausedetectorconfig","title":"PauseDetectorConfig","text":"[jvm]\\ data class PauseDetectorConfig@JvmOverloadsconstructor(val resolutionMillis: Long = 1, val logInfoMillis: Long = 1000, val logWarnMillis: Long = -1, val logErrorMillis: Long = -1, val metricsUpdateFloor: Long = 0)
Configuration for the PauseDetector
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#constructors","title":"Constructors","text":"PauseDetectorConfig [jvm]@JvmOverloadsconstructor(resolutionMillis: Long = 1, logInfoMillis: Long = 1000, logWarnMillis: Long = -1, logErrorMillis: Long = -1, metricsUpdateFloor: Long = 0)"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/#properties","title":"Properties","text":"Name Summary logErrorMillis [jvm]val logErrorMillis: LongThe minimum number of millis paused before logging at error. -1 for never. logInfoMillis [jvm]val logInfoMillis: Long = 1000The minimum number of millis paused before logging at info. -1 for never. logWarnMillis [jvm]val logWarnMillis: LongThe minimum number of millis paused before logging at warn. -1 for never. metricsUpdateFloor [jvm]val metricsUpdateFloor: Long = 0The minimum number of millis required to trigger an update of the histogram resolutionMillis [jvm]val resolutionMillis: Long = 1The delay between detector runs. If 0, the detector runs in a spin loop."},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/-pause-detector-config/","title":"PauseDetectorConfig - Misk","text":"//misk/misk.perf/PauseDetectorConfig/PauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/-pause-detector-config/#pausedetectorconfig","title":"PauseDetectorConfig","text":"[jvm]\\
@JvmOverloads
constructor(resolutionMillis: Long = 1, logInfoMillis: Long = 1000, logWarnMillis: Long = -1, logErrorMillis: Long = -1, metricsUpdateFloor: Long = 0)
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-error-millis/","title":"logErrorMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/logErrorMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-error-millis/#logerrormillis","title":"logErrorMillis","text":"[jvm]\\ val logErrorMillis: Long
The minimum number of millis paused before logging at error. -1 for never.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-info-millis/","title":"logInfoMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/logInfoMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-info-millis/#loginfomillis","title":"logInfoMillis","text":"[jvm]\\ val logInfoMillis: Long = 1000
The minimum number of millis paused before logging at info. -1 for never.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-warn-millis/","title":"logWarnMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/logWarnMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/log-warn-millis/#logwarnmillis","title":"logWarnMillis","text":"[jvm]\\ val logWarnMillis: Long
The minimum number of millis paused before logging at warn. -1 for never.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/metrics-update-floor/","title":"metricsUpdateFloor - Misk","text":"//misk/misk.perf/PauseDetectorConfig/metricsUpdateFloor
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/metrics-update-floor/#metricsupdatefloor","title":"metricsUpdateFloor","text":"[jvm]\\ val metricsUpdateFloor: Long = 0
The minimum number of millis required to trigger an update of the histogram
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/resolution-millis/","title":"resolutionMillis - Misk","text":"//misk/misk.perf/PauseDetectorConfig/resolutionMillis
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-config/resolution-millis/#resolutionmillis","title":"resolutionMillis","text":"[jvm]\\ val resolutionMillis: Long = 1
The delay between detector runs. If 0, the detector runs in a spin loop.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/","title":"PauseDetectorModule - Misk","text":"//misk/misk.perf/PauseDetectorModule
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#pausedetectormodule","title":"PauseDetectorModule","text":"[jvm]\\ class PauseDetectorModule@JvmOverloadsconstructor(val pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig()) : KAbstractModule
Install this module to run the PauseDetector in the background.
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#constructors","title":"Constructors","text":"PauseDetectorModule [jvm]@JvmOverloadsconstructor(pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig())"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#properties","title":"Properties","text":"Name Summary pauseDetectorConfig [jvm]val pauseDetectorConfig: PauseDetectorConfig"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/-pause-detector-module/","title":"PauseDetectorModule - Misk","text":"//misk/misk.perf/PauseDetectorModule/PauseDetectorModule
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/-pause-detector-module/#pausedetectormodule","title":"PauseDetectorModule","text":"[jvm]\\
@JvmOverloads
constructor(pauseDetectorConfig: PauseDetectorConfig = PauseDetectorConfig())
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/pause-detector-config/","title":"pauseDetectorConfig - Misk","text":"//misk/misk.perf/PauseDetectorModule/pauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.perf/-pause-detector-module/pause-detector-config/#pausedetectorconfig","title":"pauseDetectorConfig","text":"[jvm]\\ val pauseDetectorConfig: PauseDetectorConfig
"},{"location":"0.x/misk/misk/misk.security.authz/","title":"Package-level declarations - Misk","text":"//misk/misk.security.authz
"},{"location":"0.x/misk/misk/misk.security.authz/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.authz/#types","title":"Types","text":"Name Summary AccessAnnotationEntry [jvm]data class AccessAnnotationEntry@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val services: List<String> = listOf(), val capabilities: List<String> = listOf(), val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)Use this to alias an annotation to a set of services and capabilities. This can be used to decouple code that needs access control from the policy that defines it. AccessControlModule [jvm]class AccessControlModule : ActionScopedProviderModuleInstall support for performing access control checks for actions based on the incoming caller. AccessInterceptor [jvm]class AccessInterceptor : ApplicationInterceptor DevelopmentOnly [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class DevelopmentOnly ExcludeFromAllowAnyService [jvm]@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])annotation class ExcludeFromAllowAnyServiceExclude a service from @AllowAnyService. FakeCallerAuthenticator [jvm]@Singletonclass FakeCallerAuthenticator@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>) : MiskCallerAuthenticatorA caller authenticator that blindly trusts HTTP headers. Unsafe for production use. MiskCallerAuthenticator [jvm]interface MiskCallerAuthenticatorInterface for determining the current MiskCaller. Typically use an Request, ClientCertSubject, etc to determine the caller based on request headers or client certificate information."},{"location":"0.x/misk/misk/misk.security.authz/#functions","title":"Functions","text":"Name Summary AccessAnnotationEntry [jvm]inline fun <T : Annotation> AccessAnnotationEntry(services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false): AccessAnnotationEntry"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"[jvm]\\ inline fun <T : Annotation> AccessAnnotationEntry(services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false): AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/","title":"AccessAnnotationEntry - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"[jvm]\\ data class AccessAnnotationEntry@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val services: List<String> = listOf(), val capabilities: List<String> = listOf(), val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)
Use this to alias an annotation to a set of services and capabilities. This can be used to decouple code that needs access control from the policy that defines it.
To demonstrate, let\u2019s define an access annotation. By convention these annotations are suffixed Access:
@Retention(AnnotationRetention.RUNTIME)\n@Target(AnnotationTarget.FUNCTION)\nannotation class PaleontologistAccess\nNext we define actions that apply our annotation:
class DiscoverDinosaurAction @Inject constructor() : WebAction {\n @Get(\"/discover\")\n @PaleontologistAccess\n fun discover()\n}\n\nclass DigUpDinosaurAction @Inject constructor() : WebAction {\n @Get(\"/dig\")\n @PaleontologistAccess\n fun dig()\n}\nFinally we use multibindings to specify which services and capabilities are permitted:
multibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<PaleontologistAccess>(capabilities = listOf(\"paleontologist\", \"intern\")))\n//misk/misk.security.authz/AccessAnnotationEntry/AccessAnnotationEntry
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/-access-annotation-entry/#accessannotationentry","title":"AccessAnnotationEntry","text":"[jvm]\\
@JvmOverloads
constructor(annotation: KClass<out Annotation>, services: List<String> = listOf(), capabilities: List<String> = listOf(), allowAnyService: Boolean = false, allowAnyUser: Boolean = false)
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-service/","title":"allowAnyService - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/allowAnyService
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-service/#allowanyservice","title":"allowAnyService","text":"[jvm]\\ val allowAnyService: Boolean = false
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-user/","title":"allowAnyUser - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/allowAnyUser
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/allow-any-user/#allowanyuser","title":"allowAnyUser","text":"[jvm]\\ val allowAnyUser: Boolean = false
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/annotation/","title":"annotation - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/annotation
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: KClass<out Annotation>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/capabilities/","title":"capabilities - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/capabilities
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: List<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/services/","title":"services - Misk","text":"//misk/misk.security.authz/AccessAnnotationEntry/services
"},{"location":"0.x/misk/misk/misk.security.authz/-access-annotation-entry/services/#services","title":"services","text":"[jvm]\\ val services: List<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/","title":"AccessControlModule - Misk","text":"//misk/misk.security.authz/AccessControlModule
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#accesscontrolmodule","title":"AccessControlModule","text":"[jvm]\\ class AccessControlModule : ActionScopedProviderModule
Install support for performing access control checks for actions based on the incoming caller.
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#constructors","title":"Constructors","text":"AccessControlModule [jvm]constructor()"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/#functions","title":"Functions","text":"Name Summary bindConstant [jvm]fun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation?)fun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation?) bindProvider [jvm]fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)fun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation?)fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)fun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation?) bindSeedData [jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>)fun <T : Any> bindSeedData(kclass: KClass<T>)fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>) configure [jvm]override fun configure(builder: Binder) configureProviders [jvm]open override fun configureProviders()"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/-access-control-module/","title":"AccessControlModule - Misk","text":"//misk/misk.security.authz/AccessControlModule/AccessControlModule
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/-access-control-module/#accesscontrolmodule","title":"AccessControlModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/configure-providers/","title":"configureProviders - Misk","text":"//misk/misk.security.authz/AccessControlModule/configureProviders
"},{"location":"0.x/misk/misk/misk.security.authz/-access-control-module/configure-providers/#configureproviders","title":"configureProviders","text":"[jvm]\\ open override fun configureProviders()
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/","title":"AccessInterceptor - Misk","text":"//misk/misk.security.authz/AccessInterceptor
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#accessinterceptor","title":"AccessInterceptor","text":"[jvm]\\ class AccessInterceptor : ApplicationInterceptor
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#properties","title":"Properties","text":"Name Summary allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String>"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"//misk/misk.security.authz/AccessInterceptor/allowedCapabilities
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"[jvm]\\ val allowedCapabilities: Set<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-services/","title":"allowedServices - Misk","text":"//misk/misk.security.authz/AccessInterceptor/allowedServices
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/allowed-services/#allowedservices","title":"allowedServices","text":"[jvm]\\ val allowedServices: Set<String>
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.security.authz/AccessInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Chain): Any
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/","title":"Companion - Misk","text":"//misk/misk.security.authz/AccessInterceptor/Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/logger/","title":"logger - Misk","text":"//misk/misk.security.authz/AccessInterceptor/Companion/logger
"},{"location":"0.x/misk/misk/misk.security.authz/-access-interceptor/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk/misk/misk.security.authz/-development-only/","title":"DevelopmentOnly - Misk","text":"//misk/misk.security.authz/DevelopmentOnly
"},{"location":"0.x/misk/misk/misk.security.authz/-development-only/#developmentonly","title":"DevelopmentOnly","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])
annotation class DevelopmentOnly
"},{"location":"0.x/misk/misk/misk.security.authz/-exclude-from-allow-any-service/","title":"ExcludeFromAllowAnyService - Misk","text":"//misk/misk.security.authz/ExcludeFromAllowAnyService
"},{"location":"0.x/misk/misk/misk.security.authz/-exclude-from-allow-any-service/#excludefromallowanyservice","title":"ExcludeFromAllowAnyService","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])
annotation class ExcludeFromAllowAnyService
Exclude a service from @AllowAnyService.
Add any external proxies that do service-to-service authentication to prevent AllowAnyService from also allowing external traffic to your service.
You can still explicitly include these services by including them in
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/","title":"FakeCallerAuthenticator - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#fakecallerauthenticator","title":"FakeCallerAuthenticator","text":"[jvm]\\ @Singleton
class FakeCallerAuthenticator@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>) : MiskCallerAuthenticator
A caller authenticator that blindly trusts HTTP headers. Unsafe for production use.
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#constructors","title":"Constructors","text":"FakeCallerAuthenticator [jvm]@Injectconstructor(currentHttpCall: ActionScoped<HttpCall>)"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#properties","title":"Properties","text":"Name Summary developmentCaller [jvm]@Inject(optional = true)var developmentCaller: MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/#functions","title":"Functions","text":"Name Summary getAuthenticatedCaller [jvm]open override fun getAuthenticatedCaller(): MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-fake-caller-authenticator/","title":"FakeCallerAuthenticator - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/FakeCallerAuthenticator
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-fake-caller-authenticator/#fakecallerauthenticator","title":"FakeCallerAuthenticator","text":"[jvm]\\
@Inject
constructor(currentHttpCall: ActionScoped<HttpCall>)
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/development-caller/","title":"developmentCaller - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/developmentCaller
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/development-caller/#developmentcaller","title":"developmentCaller","text":"[jvm]\\
@Inject(optional = true)
var developmentCaller: MiskCaller?
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/get-authenticated-caller/","title":"getAuthenticatedCaller - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/getAuthenticatedCaller
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/get-authenticated-caller/#getauthenticatedcaller","title":"getAuthenticatedCaller","text":"[jvm]\\ open override fun getAuthenticatedCaller(): MiskCaller?
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/","title":"Companion - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/#properties","title":"Properties","text":"Name Summary CAPABILITIES_HEADER [jvm]const val CAPABILITIES_HEADER: String SERVICE_HEADER [jvm]const val SERVICE_HEADER: String USER_HEADER [jvm]const val USER_HEADER: String"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-c-a-p-a-b-i-l-i-t-i-e-s_-h-e-a-d-e-r/","title":"CAPABILITIES_HEADER - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion/CAPABILITIES_HEADER
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-c-a-p-a-b-i-l-i-t-i-e-s_-h-e-a-d-e-r/#capabilities_header","title":"CAPABILITIES_HEADER","text":"[jvm]\\ const val CAPABILITIES_HEADER: String
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-s-e-r-v-i-c-e_-h-e-a-d-e-r/","title":"SERVICE_HEADER - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion/SERVICE_HEADER
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-s-e-r-v-i-c-e_-h-e-a-d-e-r/#service_header","title":"SERVICE_HEADER","text":"[jvm]\\ const val SERVICE_HEADER: String
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-u-s-e-r_-h-e-a-d-e-r/","title":"USER_HEADER - Misk","text":"//misk/misk.security.authz/FakeCallerAuthenticator/Companion/USER_HEADER
"},{"location":"0.x/misk/misk/misk.security.authz/-fake-caller-authenticator/-companion/-u-s-e-r_-h-e-a-d-e-r/#user_header","title":"USER_HEADER","text":"[jvm]\\ const val USER_HEADER: String
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/","title":"MiskCallerAuthenticator - Misk","text":"//misk/misk.security.authz/MiskCallerAuthenticator
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#miskcallerauthenticator","title":"MiskCallerAuthenticator","text":"interface MiskCallerAuthenticator
Interface for determining the current MiskCaller. Typically use an Request, ClientCertSubject, etc to determine the caller based on request headers or client certificate information.
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<MiskCallerAuthenticator>().to<MyAuthenticator>()\nWe allow binding up many authenticators in case applications would like to support alternative ways in which to authenticate requests. For example, one mechanism might leverage HTTP headers while another mechanism might leverage third party authentication services.
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#inheritors","title":"Inheritors","text":"FakeCallerAuthenticator"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/#functions","title":"Functions","text":"Name Summary getAuthenticatedCaller [jvm]abstract fun getAuthenticatedCaller(): MiskCaller?"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/get-authenticated-caller/","title":"getAuthenticatedCaller - Misk","text":"//misk/misk.security.authz/MiskCallerAuthenticator/getAuthenticatedCaller
"},{"location":"0.x/misk/misk/misk.security.authz/-misk-caller-authenticator/get-authenticated-caller/#getauthenticatedcaller","title":"getAuthenticatedCaller","text":"[jvm]\\ abstract fun getAuthenticatedCaller(): MiskCaller?
"},{"location":"0.x/misk/misk/misk.security.cert/","title":"Package-level declarations - Misk","text":"//misk/misk.security.cert
"},{"location":"0.x/misk/misk/misk.security.cert/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.cert/#types","title":"Types","text":"Name Summary X500Name [jvm]data class X500Name(val commonName: String?, val organizationalUnit: String?, val organization: String?, val locality: String?, val state: String?, val country: String?)"},{"location":"0.x/misk/misk/misk.security.cert/#properties","title":"Properties","text":"Name Summary isSelfSigned [jvm]val X509Certificate.isSelfSigned: Boolean"},{"location":"0.x/misk/misk/misk.security.cert/#functions","title":"Functions","text":"Name Summary isSignedBy [jvm]fun X509Certificate.isSignedBy(key: PublicKey): Booleanfun X509Certificate.isSignedBy(cert: Certificate): Boolean"},{"location":"0.x/misk/misk/misk.security.cert/is-self-signed/","title":"isSelfSigned - Misk","text":"//misk/misk.security.cert/isSelfSigned
"},{"location":"0.x/misk/misk/misk.security.cert/is-self-signed/#isselfsigned","title":"isSelfSigned","text":"[jvm]\\ val X509Certificate.isSelfSigned: Boolean
"},{"location":"0.x/misk/misk/misk.security.cert/is-signed-by/","title":"isSignedBy - Misk","text":"//misk/misk.security.cert/isSignedBy
"},{"location":"0.x/misk/misk/misk.security.cert/is-signed-by/#issignedby","title":"isSignedBy","text":"[jvm]\\ fun X509Certificate.isSignedBy(cert: Certificate): Boolean
fun X509Certificate.isSignedBy(key: PublicKey): Boolean
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/","title":"X500Name - Misk","text":"//misk/misk.security.cert/X500Name
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#x500name","title":"X500Name","text":"[jvm]\\ data class X500Name(val commonName: String?, val organizationalUnit: String?, val organization: String?, val locality: String?, val state: String?, val country: String?)
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#constructors","title":"Constructors","text":"X500Name [jvm]constructor(components: Map<String, String>)constructor(commonName: String?, organizationalUnit: String?, organization: String?, locality: String?, state: String?, country: String?)"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/#properties","title":"Properties","text":"Name Summary commonName [jvm]val commonName: String? country [jvm]val country: String? locality [jvm]val locality: String? organization [jvm]val organization: String? organizationalUnit [jvm]val organizationalUnit: String? state [jvm]val state: String?"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-x500-name/","title":"X500Name - Misk","text":"//misk/misk.security.cert/X500Name/X500Name
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-x500-name/#x500name","title":"X500Name","text":"[jvm]\\ constructor(components: Map<String, String>)
constructor(commonName: String?, organizationalUnit: String?, organization: String?, locality: String?, state: String?, country: String?)
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/common-name/","title":"commonName - Misk","text":"//misk/misk.security.cert/X500Name/commonName
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/common-name/#commonname","title":"commonName","text":"[jvm]\\ val commonName: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/country/","title":"country - Misk","text":"//misk/misk.security.cert/X500Name/country
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/country/#country","title":"country","text":"[jvm]\\ val country: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/locality/","title":"locality - Misk","text":"//misk/misk.security.cert/X500Name/locality
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/locality/#locality","title":"locality","text":"[jvm]\\ val locality: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organization/","title":"organization - Misk","text":"//misk/misk.security.cert/X500Name/organization
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organization/#organization","title":"organization","text":"[jvm]\\ val organization: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organizational-unit/","title":"organizationalUnit - Misk","text":"//misk/misk.security.cert/X500Name/organizationalUnit
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/organizational-unit/#organizationalunit","title":"organizationalUnit","text":"[jvm]\\ val organizationalUnit: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/state/","title":"state - Misk","text":"//misk/misk.security.cert/X500Name/state
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/state/#state","title":"state","text":"[jvm]\\ val state: String?
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/","title":"Companion - Misk","text":"//misk/misk.security.cert/X500Name/Companion
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(dnString: String): X500Name"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/parse/","title":"parse - Misk","text":"//misk/misk.security.cert/X500Name/Companion/parse
"},{"location":"0.x/misk/misk/misk.security.cert/-x500-name/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(dnString: String): X500Name
"},{"location":"0.x/misk/misk/misk.security.csp/","title":"Package-level declarations - Misk","text":"//misk/misk.security.csp
"},{"location":"0.x/misk/misk/misk.security.csp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.csp/#types","title":"Types","text":"Name Summary ContentSecurityPolicy [jvm]annotation class ContentSecurityPolicy(val rules: Array<String>)This annotation allows misk endpoints to define their Content-Security-Policy directive. See https://web.archive.org/web/20220906063156/https://content-security-policy.com/ for a reference that\u2019s up to date when this annotation was added. ContentSecurityPolicyInterceptor [jvm]class ContentSecurityPolicyInterceptor(val rules: List<String>) : NetworkInterceptor"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/","title":"ContentSecurityPolicy - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicy
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/#contentsecuritypolicy","title":"ContentSecurityPolicy","text":"annotation class ContentSecurityPolicy(val rules: Array<String>)
This annotation allows misk endpoints to define their Content-Security-Policy directive. See https://web.archive.org/web/20220906063156/https://content-security-policy.com/ for a reference that\u2019s up to date when this annotation was added.
Production CSPs can be very long so a future contribution should add the ability to define CSP into YAML configs and point the @Csp annotation to the config value. This annotation is currently dumb, it adds the rules passed to a Content-Security-Policy header directive, with no inspection or validation. A future change could parse the policy. Developers using this should check out the various browser extensions to verify the actual CSP on their webpages. #### Parameters jvm | | | |---|---| | rules | A list of valid Content-Security-Policy rules. | ## Properties | Name | Summary | |---|---| | [rules](rules.md) | [jvm]val [rules](rules.md): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> |"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/","title":"rules - Misk","text":"
//misk/misk.security.csp/ContentSecurityPolicy/rules
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/#rules","title":"rules","text":"[jvm]\\ val rules: Array<String>
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy/rules/#parameters","title":"Parameters","text":"jvm
rules A list of valid Content-Security-Policy rules."},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/","title":"ContentSecurityPolicyInterceptor - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#contentsecuritypolicyinterceptor","title":"ContentSecurityPolicyInterceptor","text":"[jvm]\\ class ContentSecurityPolicyInterceptor(val rules: List<String>) : NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#constructors","title":"Constructors","text":"ContentSecurityPolicyInterceptor [jvm]constructor(rules: List<String>)"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#properties","title":"Properties","text":"Name Summary rules [jvm]val rules: List<String>"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-content-security-policy-interceptor/","title":"ContentSecurityPolicyInterceptor - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/ContentSecurityPolicyInterceptor
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-content-security-policy-interceptor/#contentsecuritypolicyinterceptor","title":"ContentSecurityPolicyInterceptor","text":"[jvm]\\ constructor(rules: List<String>)
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/rules/","title":"rules - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/rules
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/rules/#rules","title":"rules","text":"[jvm]\\ val rules: List<String>
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory@Injectconstructor : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory/Factory
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.security.csp/ContentSecurityPolicyInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.security.csp/-content-security-policy-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.security.keys/","title":"Package-level declarations - Misk","text":"//misk/misk.security.keys
"},{"location":"0.x/misk/misk/misk.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.keys/#types","title":"Types","text":"Name Summary KeyService [jvm]interface KeyServiceHandles encryption and decryption using keys stored in a key management service"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/","title":"KeyService - Misk","text":"//misk/misk.security.keys/KeyService
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/#keyservice","title":"KeyService","text":"[jvm]\\ interface KeyService
Handles encryption and decryption using keys stored in a key management service
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/#functions","title":"Functions","text":"Name Summary decrypt [jvm]abstract fun decrypt(keyAlias: String, cipherText: ByteString): ByteStringdecrypts the provided cipher text using the given stored key encrypt [jvm]abstract fun encrypt(keyAlias: String, plainText: ByteString): ByteStringencrypts the provided plain text using the given stored key"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/decrypt/","title":"decrypt - Misk","text":"//misk/misk.security.keys/KeyService/decrypt
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/decrypt/#decrypt","title":"decrypt","text":"[jvm]\\ abstract fun decrypt(keyAlias: String, cipherText: ByteString): ByteString
decrypts the provided cipher text using the given stored key
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/encrypt/","title":"encrypt - Misk","text":"//misk/misk.security.keys/KeyService/encrypt
"},{"location":"0.x/misk/misk/misk.security.keys/-key-service/encrypt/#encrypt","title":"encrypt","text":"[jvm]\\ abstract fun encrypt(keyAlias: String, plainText: ByteString): ByteString
encrypts the provided plain text using the given stored key
"},{"location":"0.x/misk/misk/misk.security.ssl/","title":"Package-level declarations - Misk","text":"//misk/misk.security.ssl
"},{"location":"0.x/misk/misk/misk.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.security.ssl/#types","title":"Types","text":"Name Summary CipherSuites [jvm]object CipherSuites ClientCertChain [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertChainQualifier annotation for an ActionScoped array of X509Certificates containing the certificate chain provided by the client (if any) ClientCertIssuer [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertIssuerQualifier annotation for an ActionScoped containing the issuer of the client cert ClientCertSubject [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class ClientCertSubjectQualifier annotation for an ActionScoped containing the subject of the client cert TlsProtocols [jvm]object TlsProtocols"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/","title":"CipherSuites - Misk","text":"//misk/misk.security.ssl/CipherSuites
"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/#ciphersuites","title":"CipherSuites","text":"[jvm]\\ object CipherSuites
"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/#properties","title":"Properties","text":"Name Summary compatible [jvm]val compatible: Array<String>"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/compatible/","title":"compatible - Misk","text":"//misk/misk.security.ssl/CipherSuites/compatible
"},{"location":"0.x/misk/misk/misk.security.ssl/-cipher-suites/compatible/#compatible","title":"compatible","text":"[jvm]\\ val compatible: Array<String>
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-chain/","title":"ClientCertChain - Misk","text":"//misk/misk.security.ssl/ClientCertChain
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-chain/#clientcertchain","title":"ClientCertChain","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ClientCertChain
Qualifier annotation for an ActionScoped array of X509Certificates containing the certificate chain provided by the client (if any)
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-issuer/","title":"ClientCertIssuer - Misk","text":"//misk/misk.security.ssl/ClientCertIssuer
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-issuer/#clientcertissuer","title":"ClientCertIssuer","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ClientCertIssuer
Qualifier annotation for an ActionScoped containing the issuer of the client cert
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-subject/","title":"ClientCertSubject - Misk","text":"//misk/misk.security.ssl/ClientCertSubject
"},{"location":"0.x/misk/misk/misk.security.ssl/-client-cert-subject/#clientcertsubject","title":"ClientCertSubject","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class ClientCertSubject
Qualifier annotation for an ActionScoped containing the subject of the client cert
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/","title":"TlsProtocols - Misk","text":"//misk/misk.security.ssl/TlsProtocols
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/#tlsprotocols","title":"TlsProtocols","text":"[jvm]\\ object TlsProtocols
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/#properties","title":"Properties","text":"Name Summary compatible [jvm]val compatible: Array<String>List of safe to use TLS protocols, in preferred order restricted [jvm]val restricted: Array<String>List of modern TLS protocols for extra security, in preferred order"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/compatible/","title":"compatible - Misk","text":"//misk/misk.security.ssl/TlsProtocols/compatible
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/compatible/#compatible","title":"compatible","text":"[jvm]\\ val compatible: Array<String>
List of safe to use TLS protocols, in preferred order
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/restricted/","title":"restricted - Misk","text":"//misk/misk.security.ssl/TlsProtocols/restricted
"},{"location":"0.x/misk/misk/misk.security.ssl/-tls-protocols/restricted/#restricted","title":"restricted","text":"[jvm]\\ val restricted: Array<String>
List of modern TLS protocols for extra security, in preferred order
"},{"location":"0.x/misk/misk/misk.tasks/","title":"Package-level declarations - Misk","text":"//misk/misk.tasks
"},{"location":"0.x/misk/misk/misk.tasks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.tasks/#types","title":"Types","text":"Name Summary DelayedTask [jvm]class DelayedTask(clock: Clock, executionTime: Instant, val task: () -> Result) : DelayedA DelayedTask is a task that runs in the future RepeatedTaskQueue [jvm]class RepeatedTaskQueue : AbstractExecutionThreadServiceA RepeatedTaskQueue runs repeated tasks at a user controlled rate. Internally it uses a DelayQueue to hold the pending tasks; a background thread pulls the next task from the DelayQueue and hands it off to an executor service for execution. RepeatedTaskQueueConfig [jvm]data class RepeatedTaskQueueConfig@JvmOverloadsconstructor(val default_jitter_ms: Long = 50, val default_max_delay_sec: Long = 60, val num_parallel_tasks: Int = 1) RepeatedTaskQueueFactory [jvm]@Singletonclass RepeatedTaskQueueFactory@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory) RepeatedTaskQueueMetrics [jvm]@Singletonclass RepeatedTaskQueueMetrics@Injectconstructor(metrics: Metrics) Result [jvm]data class Result(val status: Status, val nextDelay: Duration) Status [jvm]enum Status : Enum<Status>"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/","title":"DelayedTask - Misk","text":"//misk/misk.tasks/DelayedTask
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#delayedtask","title":"DelayedTask","text":"[jvm]\\ class DelayedTask(clock: Clock, executionTime: Instant, val task: () -> Result) : Delayed
A DelayedTask is a task that runs in the future
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#constructors","title":"Constructors","text":"DelayedTask [jvm]constructor(clock: Clock, executionTime: Instant, task: () -> Result)"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#properties","title":"Properties","text":"Name Summary task [jvm]val task: () -> Result"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Delayed): Int getDelay [jvm]open override fun getDelay(unit: TimeUnit): Long"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/-delayed-task/","title":"DelayedTask - Misk","text":"//misk/misk.tasks/DelayedTask/DelayedTask
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/-delayed-task/#delayedtask","title":"DelayedTask","text":"[jvm]\\ constructor(clock: Clock, executionTime: Instant, task: () -> Result)
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/compare-to/","title":"compareTo - Misk","text":"//misk/misk.tasks/DelayedTask/compareTo
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Delayed): Int
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/get-delay/","title":"getDelay - Misk","text":"//misk/misk.tasks/DelayedTask/getDelay
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/get-delay/#getdelay","title":"getDelay","text":"[jvm]\\ open override fun getDelay(unit: TimeUnit): Long
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/task/","title":"task - Misk","text":"//misk/misk.tasks/DelayedTask/task
"},{"location":"0.x/misk/misk/misk.tasks/-delayed-task/task/#task","title":"task","text":"[jvm]\\ val task: () -> Result
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/","title":"RepeatedTaskQueue - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#repeatedtaskqueue","title":"RepeatedTaskQueue","text":"[jvm]\\ class RepeatedTaskQueue : AbstractExecutionThreadService
A RepeatedTaskQueue runs repeated tasks at a user controlled rate. Internally it uses a DelayQueue to hold the pending tasks; a background thread pulls the next task from the DelayQueue and hands it off to an executor service for execution.
RepeatedTaskQueue implements the Service interface, which requires proper startup and shutdown. Alternatively, you can add new instances to the Service multibind.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean schedule [jvm]@JvmOverloadsfun schedule(delay: Duration, retryDelayOnFailure: Duration? = null, task: () -> Result)Schedules a task to run repeatedly after an initial delay. The task itself determines the next execution time. Provide an optional retryDelayOnFailure parameter to determine when the job should be retried in the case of an unhandled exception by the client scheduleWithBackoff [jvm]@JvmOverloadsfun scheduleWithBackoff(timeBetweenRuns: Duration, initialDelay: Duration = timeBetweenRuns, noWorkBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), failureBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), task: () -> Status)Schedules a task to run repeatedly at a fixed delay, with back-off for errors and lack of available work startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/name/","title":"name - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/name
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule-with-backoff/","title":"scheduleWithBackoff - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/scheduleWithBackoff
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule-with-backoff/#schedulewithbackoff","title":"scheduleWithBackoff","text":"[jvm]\\
@JvmOverloads
fun scheduleWithBackoff(timeBetweenRuns: Duration, initialDelay: Duration = timeBetweenRuns, noWorkBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), failureBackoff: Backoff = config.defaultBackoff(timeBetweenRuns), task: () -> Status)
Schedules a task to run repeatedly at a fixed delay, with back-off for errors and lack of available work
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule/","title":"schedule - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/schedule
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/schedule/#schedule","title":"schedule","text":"[jvm]\\
@JvmOverloads
fun schedule(delay: Duration, retryDelayOnFailure: Duration? = null, task: () -> Result)
Schedules a task to run repeatedly after an initial delay. The task itself determines the next execution time. Provide an optional retryDelayOnFailure parameter to determine when the job should be retried in the case of an unhandled exception by the client
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/-companion/","title":"Companion - Misk","text":"//misk/misk.tasks/RepeatedTaskQueue/Companion
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/","title":"RepeatedTaskQueueConfig - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#repeatedtaskqueueconfig","title":"RepeatedTaskQueueConfig","text":"[jvm]\\ data class RepeatedTaskQueueConfig@JvmOverloadsconstructor(val default_jitter_ms: Long = 50, val default_max_delay_sec: Long = 60, val num_parallel_tasks: Int = 1)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#constructors","title":"Constructors","text":"RepeatedTaskQueueConfig [jvm]@JvmOverloadsconstructor(default_jitter_ms: Long = 50, default_max_delay_sec: Long = 60, num_parallel_tasks: Int = 1)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#properties","title":"Properties","text":"Name Summary default_jitter_ms [jvm]val default_jitter_ms: Long = 50The default amount of jitter to use when scheduling backoffs. default_max_delay_sec [jvm]val default_max_delay_sec: Long = 60The default maximum backoff time. num_parallel_tasks [jvm]val num_parallel_tasks: Int = 1The fixed number of parallel tasks to run."},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/#functions","title":"Functions","text":"Name Summary defaultBackoff [jvm]fun defaultBackoff(initialDelay: Duration): BackoffConstruct an ExponentialBackoff from the initial delay using the default configs."},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/-repeated-task-queue-config/","title":"RepeatedTaskQueueConfig - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/RepeatedTaskQueueConfig
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/-repeated-task-queue-config/#repeatedtaskqueueconfig","title":"RepeatedTaskQueueConfig","text":"[jvm]\\
@JvmOverloads
constructor(default_jitter_ms: Long = 50, default_max_delay_sec: Long = 60, num_parallel_tasks: Int = 1)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default-backoff/","title":"defaultBackoff - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/defaultBackoff
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default-backoff/#defaultbackoff","title":"defaultBackoff","text":"[jvm]\\ fun defaultBackoff(initialDelay: Duration): Backoff
Construct an ExponentialBackoff from the initial delay using the default configs.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_jitter_ms/","title":"default_jitter_ms - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/default_jitter_ms
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_jitter_ms/#default_jitter_ms","title":"default_jitter_ms","text":"[jvm]\\ val default_jitter_ms: Long = 50
The default amount of jitter to use when scheduling backoffs.
Can be overridden when scheduling a tasks.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_max_delay_sec/","title":"default_max_delay_sec - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/default_max_delay_sec
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/default_max_delay_sec/#default_max_delay_sec","title":"default_max_delay_sec","text":"[jvm]\\ val default_max_delay_sec: Long = 60
The default maximum backoff time.
Can be overridden when scheduling a task.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/num_parallel_tasks/","title":"num_parallel_tasks - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueConfig/num_parallel_tasks
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-config/num_parallel_tasks/#num_parallel_tasks","title":"num_parallel_tasks","text":"[jvm]\\ val num_parallel_tasks: Int = 1
The fixed number of parallel tasks to run.
If -1 then an unbounded number of parallel tasks are allowed. An unbounded number of tasks can be useful for an App that needs to dynamically compute the number of tasks at runtime. However, the App is then responsible for ensuring an upper bound for the number of tasks submitted.
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/","title":"RepeatedTaskQueueFactory - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#repeatedtaskqueuefactory","title":"RepeatedTaskQueueFactory","text":"[jvm]\\ @Singleton
class RepeatedTaskQueueFactory@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#constructors","title":"Constructors","text":"RepeatedTaskQueueFactory [jvm]@Injectconstructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/#functions","title":"Functions","text":"Name Summary forTesting [jvm]@JvmOverloadsfun forTesting(name: String, backingStorage: ExplicitReleaseDelayQueue<DelayedTask>, pollingTimeout: Duration = Duration.ofMillis(50)): RepeatedTaskQueueBuilds a new instance of a RepeatedTaskQueue for testing new [jvm]@JvmOverloadsfun new(name: String, config: RepeatedTaskQueueConfig = RepeatedTaskQueueConfig(), pollingTimeout: Duration = Duration.ofMillis(250)): RepeatedTaskQueueBuilds a new instance of a RepeatedTaskQueue"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/-repeated-task-queue-factory/","title":"RepeatedTaskQueueFactory - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory/RepeatedTaskQueueFactory
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/-repeated-task-queue-factory/#repeatedtaskqueuefactory","title":"RepeatedTaskQueueFactory","text":"[jvm]\\
@Inject
constructor(clock: Clock, metrics: RepeatedTaskQueueMetrics, executorServiceFactory: ExecutorServiceFactory)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/for-testing/","title":"forTesting - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory/forTesting
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/for-testing/#fortesting","title":"forTesting","text":"[jvm]\\
@JvmOverloads
fun forTesting(name: String, backingStorage: ExplicitReleaseDelayQueue<DelayedTask>, pollingTimeout: Duration = Duration.ofMillis(50)): RepeatedTaskQueue
Builds a new instance of a RepeatedTaskQueue for testing
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/new/","title":"new - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueFactory/new
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-factory/new/#new","title":"new","text":"[jvm]\\
@JvmOverloads
fun new(name: String, config: RepeatedTaskQueueConfig = RepeatedTaskQueueConfig(), pollingTimeout: Duration = Duration.ofMillis(250)): RepeatedTaskQueue
Builds a new instance of a RepeatedTaskQueue
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/","title":"RepeatedTaskQueueMetrics - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueMetrics
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/#repeatedtaskqueuemetrics","title":"RepeatedTaskQueueMetrics","text":"[jvm]\\ @Singleton
class RepeatedTaskQueueMetrics@Injectconstructor(metrics: Metrics)
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/#constructors","title":"Constructors","text":"RepeatedTaskQueueMetrics [jvm]@Injectconstructor(metrics: Metrics)"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/-repeated-task-queue-metrics/","title":"RepeatedTaskQueueMetrics - Misk","text":"//misk/misk.tasks/RepeatedTaskQueueMetrics/RepeatedTaskQueueMetrics
"},{"location":"0.x/misk/misk/misk.tasks/-repeated-task-queue-metrics/-repeated-task-queue-metrics/#repeatedtaskqueuemetrics","title":"RepeatedTaskQueueMetrics","text":"[jvm]\\
@Inject
constructor(metrics: Metrics)
"},{"location":"0.x/misk/misk/misk.tasks/-result/","title":"Result - Misk","text":"//misk/misk.tasks/Result
"},{"location":"0.x/misk/misk/misk.tasks/-result/#result","title":"Result","text":"[jvm]\\ data class Result(val status: Status, val nextDelay: Duration)
"},{"location":"0.x/misk/misk/misk.tasks/-result/#constructors","title":"Constructors","text":"Result [jvm]constructor(status: Status, nextDelay: Duration)"},{"location":"0.x/misk/misk/misk.tasks/-result/#properties","title":"Properties","text":"Name Summary nextDelay [jvm]val nextDelay: Duration status [jvm]val status: Status"},{"location":"0.x/misk/misk/misk.tasks/-result/-result/","title":"Result - Misk","text":"//misk/misk.tasks/Result/Result
"},{"location":"0.x/misk/misk/misk.tasks/-result/-result/#result","title":"Result","text":"[jvm]\\ constructor(status: Status, nextDelay: Duration)
"},{"location":"0.x/misk/misk/misk.tasks/-result/next-delay/","title":"nextDelay - Misk","text":"//misk/misk.tasks/Result/nextDelay
"},{"location":"0.x/misk/misk/misk.tasks/-result/next-delay/#nextdelay","title":"nextDelay","text":"[jvm]\\ val nextDelay: Duration
"},{"location":"0.x/misk/misk/misk.tasks/-result/status/","title":"status - Misk","text":"//misk/misk.tasks/Result/status
"},{"location":"0.x/misk/misk/misk.tasks/-result/status/#status","title":"status","text":"[jvm]\\ val status: Status
"},{"location":"0.x/misk/misk/misk.tasks/-status/","title":"Status - Misk","text":"//misk/misk.tasks/Status
"},{"location":"0.x/misk/misk/misk.tasks/-status/#status","title":"Status","text":"[jvm]\\ enum Status : Enum<Status>
"},{"location":"0.x/misk/misk/misk.tasks/-status/#entries","title":"Entries","text":"OK [jvm]OKThe task completed successfully and processed work NO_WORK [jvm]NO_WORKThe task had no work to complete FAILED [jvm]FAILEDThe task resulted in an error NO_RESCHEDULE [jvm]NO_RESCHEDULEThe task should not be rescheduled"},{"location":"0.x/misk/misk/misk.tasks/-status/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Status>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored. valueOf [jvm]fun valueOf(value: String): StatusReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Status>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.tasks/-status/entries/","title":"entries - Misk","text":"//misk/misk.tasks/Status/entries
"},{"location":"0.x/misk/misk/misk.tasks/-status/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Status>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.tasks/-status/metric-label/","title":"metricLabel - Misk","text":"//misk/misk.tasks/Status/metricLabel
"},{"location":"0.x/misk/misk/misk.tasks/-status/metric-label/#metriclabel","title":"metricLabel","text":"[jvm]\\ fun metricLabel(): String
The metric label for the status. This is used instead of name() in case the code is refactored.
"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/","title":"valueOf - Misk","text":"//misk/misk.tasks/Status/valueOf
"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Status
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.tasks/-status/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.tasks/-status/values/","title":"values - Misk","text":"//misk/misk.tasks/Status/values
"},{"location":"0.x/misk/misk/misk.tasks/-status/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Status>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/","title":"FAILED - Misk","text":"//misk/misk.tasks/Status/FAILED
"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#failed","title":"FAILED","text":"[jvm]\\ FAILED
The task resulted in an error
"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-f-a-i-l-e-d/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/","title":"NO_RESCHEDULE - Misk","text":"//misk/misk.tasks/Status/NO_RESCHEDULE
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#no_reschedule","title":"NO_RESCHEDULE","text":"[jvm]\\ NO_RESCHEDULE
The task should not be rescheduled
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/","title":"NO_WORK - Misk","text":"//misk/misk.tasks/Status/NO_WORK
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#no_work","title":"NO_WORK","text":"[jvm]\\ NO_WORK
The task had no work to complete
"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-n-o_-w-o-r-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/","title":"OK - Misk","text":"//misk/misk.tasks/Status/OK
"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#ok","title":"OK","text":"[jvm]\\ OK
The task completed successfully and processed work
"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.tasks/-status/-o-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/misk/misk/misk.time/","title":"Package-level declarations - Misk","text":"//misk/misk.time
"},{"location":"0.x/misk/misk/misk.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.time/#types","title":"Types","text":"Name Summary ForceUtcTimeZoneService [jvm]@Singletonclass ForceUtcTimeZoneService@Injectconstructor : AbstractIdleServiceForces the default JVM timezone to UTC."},{"location":"0.x/misk/misk/misk.time/#functions","title":"Functions","text":"Name Summary timed [jvm]fun <T> timed(f: () -> T): Pair<Duration, T>fun <T> timed(ticker: Ticker, f: () -> T): Pair<Duration, T>"},{"location":"0.x/misk/misk/misk.time/timed/","title":"timed - Misk","text":"//misk/misk.time/timed
"},{"location":"0.x/misk/misk/misk.time/timed/#timed","title":"timed","text":"[jvm]\\ fun <T> timed(f: () -> T): Pair<Duration, T>
fun <T> timed(ticker: Ticker, f: () -> T): Pair<Duration, T>
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/","title":"ForceUtcTimeZoneService - Misk","text":"//misk/misk.time/ForceUtcTimeZoneService
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#forceutctimezoneservice","title":"ForceUtcTimeZoneService","text":"[jvm]\\ @Singleton
class ForceUtcTimeZoneService@Injectconstructor : AbstractIdleService
Forces the default JVM timezone to UTC.
This is useful when running Misk applications on machines that don\u2019t have UTC set as the system timezone (eg. development machines).
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#constructors","title":"Constructors","text":"ForceUtcTimeZoneService [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/-force-utc-time-zone-service/","title":"ForceUtcTimeZoneService - Misk","text":"//misk/misk.time/ForceUtcTimeZoneService/ForceUtcTimeZoneService
"},{"location":"0.x/misk/misk/misk.time/-force-utc-time-zone-service/-force-utc-time-zone-service/#forceutctimezoneservice","title":"ForceUtcTimeZoneService","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web/","title":"Package-level declarations - Misk","text":"//misk/misk.web
"},{"location":"0.x/misk/misk/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web/#types","title":"Types","text":"Name Summary ConcurrencyLimiterConfig [jvm]data class ConcurrencyLimiterConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, val min_limit: Int? = null, val max_concurrency: Int? = null, val initial_limit: Int? = null, val log_level: Level = Level.ERROR) CorsConfig [jvm]data class CorsConfig@JvmOverloadsconstructor(val allowedOrigins: Array<String> = arrayOf(\"*\"), val allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), val allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), val allowCredentials: Boolean = true, val preflightMaxAge: String = \"1800\", val chainPreflight: Boolean = true, val exposedHeaders: Array<String> = arrayOf()) FeatureBinding [jvm]interface FeatureBindingBinds an HTTP call to a WebAction function. HttpCall [jvm]interface HttpCall : HttpRequestA live HTTP call from a client for use by a chain of network interceptors. MiskWebFormBuilder [jvm]class MiskWebFormBuilderProvides a mapping from field name to Type definition given a KType. Useful for processes that want to have a schema definition of a type. For example: used by the WebActions admin dashboard tab to show a statically typed form containing request fields for developers to fill out. Currently only supports Wire request type messages; non-Wire messages return an empty mapping. MiskWebModule [jvm]class MiskWebModule@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList()) : KAbstractModule NetworkChain [jvm]interface NetworkChain NetworkInterceptor [jvm]interface NetworkInterceptor PathPattern [jvm]class PathPattern(val pattern: String, val regex: Pattern, val variableNames: List<String>, val numRegexVariables: Int, val numSegments: Int, val matchesWildcardPath: Boolean) : Comparable<PathPattern> A path with placeholders for variables. Paths may be constant like/app/home/ or dynamic like /user/{username}. Variables are delimited by curly braces and may specify an optional regex like this: {username:[a-z]+}. If no regex is specified the variable is a sequence of non-\u2018/\u2019 characters. SocketAddress [jvm]sealed class SocketAddressInformation about the socket on which a HTTP call arrived. WebActionSeedDataTransformerFactory [jvm]interface WebActionSeedDataTransformerFactoryCreates a SeedDataTransformer for a specific web Action. WebConfig [jvm]data class WebConfig@JvmOverloadsconstructor(val port: Int, val idle_timeout: Long = 0, val health_port: Int = -1, val host: String? = null, val ssl: WebSslConfig? = null, val unix_domain_socket: WebUnixDomainSocketConfig? = null, val http2: Boolean = false, val selectors: Int? = null, val acceptors: Int? = null, val queue_size: Int? = null, val jetty_max_thread_pool_size: Int = 200, val jetty_min_thread_pool_size: Int = 8, val jetty_max_thread_pool_queue_size: Int = 300, val enable_thread_pool_queue_metrics: Boolean = false, val action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), val jetty_max_concurrent_streams: Int? = null, val close_connection_percent: Double = 0.0, val gzip: Boolean = true, val minGzipSize: Int = 1024, val cors: Map<String, CorsConfig> = mapOf(), val concurrency_limiter_disabled: Boolean = true, val concurrency_limiter_log_level: Level = Level.ERROR, val concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), val shutdown_sleep_ms: Int = 0, val http_request_header_size: Int? = 32768, val http_header_cache_size: Int? = null, val override_shutdown_idle_timeout: Long? = null, val readiness_refresh_interval_ms: Int = 1000, val readiness_max_age_ms: Int = 10000, val use_virtual_threads: Boolean = false, val install_default_not_found_action: Boolean = true, val jetty_output_buffer_size: Int? = null, val jetty_initial_session_recv_window: Int? = null, val jetty_initial_stream_recv_window: Int? = null, val enable_thread_pool_health_check: Boolean = false, val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null) : Config WebSslConfig [jvm]data class WebSslConfig@JvmOverloadsconstructor(val port: Int, val cert_store: CertStoreConfig, val trust_store: TrustStoreConfig? = null, val mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, val cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN) WebUnixDomainSocketConfig [jvm]data class WebUnixDomainSocketConfig@JvmOverloadsconstructor(val path: String, val h2c: Boolean? = true)"},{"location":"0.x/misk/misk/misk.web/#functions","title":"Functions","text":"Name Summary readUtf8 [jvm]fun Response<*>.readUtf8(): String toMisk [jvm]fun Response.toMisk(): Response<ResponseBody> toResponseBody [jvm]fun String.toResponseBody(): ResponseBodyReturns a ResponseBody that writes this out as UTF-8.[jvm]fun ByteString.toResponseBody(): ResponseBodyReturns a ResponseBody that writes this out as bytestring."},{"location":"0.x/misk/misk/misk.web/read-utf8/","title":"readUtf8 - Misk","text":"//misk/misk.web/readUtf8
"},{"location":"0.x/misk/misk/misk.web/read-utf8/#readutf8","title":"readUtf8","text":"[jvm]\\ fun Response<*>.readUtf8(): String
"},{"location":"0.x/misk/misk/misk.web/to-misk/","title":"toMisk - Misk","text":"//misk/misk.web/toMisk
"},{"location":"0.x/misk/misk/misk.web/to-misk/#tomisk","title":"toMisk","text":"[jvm]\\ fun Response.toMisk(): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web/to-response-body/","title":"toResponseBody - Misk","text":"//misk/misk.web/toResponseBody
"},{"location":"0.x/misk/misk/misk.web/to-response-body/#toresponsebody","title":"toResponseBody","text":"[jvm]\\ fun String.toResponseBody(): ResponseBody
Returns a ResponseBody that writes this out as UTF-8.
[jvm]\\ fun ByteString.toResponseBody(): ResponseBody
Returns a ResponseBody that writes this out as bytestring.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/","title":"ConcurrencyLimiterConfig - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#concurrencylimiterconfig","title":"ConcurrencyLimiterConfig","text":"[jvm]\\ data class ConcurrencyLimiterConfig@JvmOverloadsconstructor(val disabled: Boolean = false, val strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, val min_limit: Int? = null, val max_concurrency: Int? = null, val initial_limit: Int? = null, val log_level: Level = Level.ERROR)
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#constructors","title":"Constructors","text":"ConcurrencyLimiterConfig [jvm]@JvmOverloadsconstructor(disabled: Boolean = false, strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, min_limit: Int? = null, max_concurrency: Int? = null, initial_limit: Int? = null, log_level: Level = Level.ERROR)"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/#properties","title":"Properties","text":"Name Summary disabled [jvm]val disabled: Boolean = falseIf true, disables automatic load shedding when degraded. initial_limit [jvm]val initial_limit: Int? = nullInitial limit used by the concurrency limiter. log_level [jvm]val log_level: LevelThe level of log when concurrency shedding. Same as concurrency_limiter_log_level default for backwards compatibility. max_concurrency [jvm]val max_concurrency: Int? = nullMaximum allowed concurrency limit providing an upper bound failsafe. min_limit [jvm]val min_limit: Int? = nullMinimum concurrency limit allowed. strategy [jvm]val strategy: ConcurrencyLimiterStrategyThe algorithm to use for determining concurrency limits."},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/-concurrency-limiter-config/","title":"ConcurrencyLimiterConfig - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/ConcurrencyLimiterConfig
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/-concurrency-limiter-config/#concurrencylimiterconfig","title":"ConcurrencyLimiterConfig","text":"[jvm]\\
@JvmOverloads
constructor(disabled: Boolean = false, strategy: ConcurrencyLimiterStrategy = ConcurrencyLimiterStrategy.GRADIENT2, min_limit: Int? = null, max_concurrency: Int? = null, initial_limit: Int? = null, log_level: Level = Level.ERROR)
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/disabled/","title":"disabled - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/disabled
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/disabled/#disabled","title":"disabled","text":"[jvm]\\ val disabled: Boolean = false
If true, disables automatic load shedding when degraded.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/initial_limit/","title":"initial_limit - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/initial_limit
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/initial_limit/#initial_limit","title":"initial_limit","text":"[jvm]\\ val initial_limit: Int? = null
Initial limit used by the concurrency limiter.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/log_level/","title":"log_level - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/log_level
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/log_level/#log_level","title":"log_level","text":"[jvm]\\ val log_level: Level
The level of log when concurrency shedding. Same as concurrency_limiter_log_level default for backwards compatibility.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/max_concurrency/","title":"max_concurrency - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/max_concurrency
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/max_concurrency/#max_concurrency","title":"max_concurrency","text":"[jvm]\\ val max_concurrency: Int? = null
Maximum allowed concurrency limit providing an upper bound failsafe.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/min_limit/","title":"min_limit - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/min_limit
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/min_limit/#min_limit","title":"min_limit","text":"[jvm]\\ val min_limit: Int? = null
Minimum concurrency limit allowed.
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/strategy/","title":"strategy - Misk","text":"//misk/misk.web/ConcurrencyLimiterConfig/strategy
"},{"location":"0.x/misk/misk/misk.web/-concurrency-limiter-config/strategy/#strategy","title":"strategy","text":"[jvm]\\ val strategy: ConcurrencyLimiterStrategy
The algorithm to use for determining concurrency limits.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/","title":"CorsConfig - Misk","text":"//misk/misk.web/CorsConfig
"},{"location":"0.x/misk/misk/misk.web/-cors-config/#corsconfig","title":"CorsConfig","text":"[jvm]\\ data class CorsConfig@JvmOverloadsconstructor(val allowedOrigins: Array<String> = arrayOf(\"*\"), val allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), val allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), val allowCredentials: Boolean = true, val preflightMaxAge: String = \"1800\", val chainPreflight: Boolean = true, val exposedHeaders: Array<String> = arrayOf())
"},{"location":"0.x/misk/misk/misk.web/-cors-config/#constructors","title":"Constructors","text":"CorsConfig [jvm]@JvmOverloadsconstructor(allowedOrigins: Array<String> = arrayOf(\"*\"), allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), allowCredentials: Boolean = true, preflightMaxAge: String = \"1800\", chainPreflight: Boolean = true, exposedHeaders: Array<String> = arrayOf())"},{"location":"0.x/misk/misk/misk.web/-cors-config/#properties","title":"Properties","text":"Name Summary allowCredentials [jvm]val allowCredentials: Boolean = trueA boolean indicating if the resource allows requests with credentials. allowedHeaders [jvm]val allowedHeaders: Array<String>A comma separated list of HTTP headers that are allowed to be specified when accessing the resources. allowedMethods [jvm]val allowedMethods: Array<String>A comma separated list of HTTP methods that are allowed to be used when accessing the resources. allowedOrigins [jvm]val allowedOrigins: Array<String>A comma separated list of origins that are allowed to access the resources. chainPreflight [jvm]val chainPreflight: Boolean = trueTrue if preflight requests are chained to their target resource for normal handling (as an OPTION request). exposedHeaders [jvm]val exposedHeaders: Array<String>A comma separated list of HTTP headers that are allowed to be exposed on the client. preflightMaxAge [jvm]val preflightMaxAge: StringThe number of seconds that preflight requests can be cached by the client."},{"location":"0.x/misk/misk/misk.web/-cors-config/-cors-config/","title":"CorsConfig - Misk","text":"//misk/misk.web/CorsConfig/CorsConfig
"},{"location":"0.x/misk/misk/misk.web/-cors-config/-cors-config/#corsconfig","title":"CorsConfig","text":"[jvm]\\
@JvmOverloads
constructor(allowedOrigins: Array<String> = arrayOf(\"*\"), allowedMethods: Array<String> = arrayOf(\"GET\", \"POST\", \"HEAD\"), allowedHeaders: Array<String> = arrayOf( \"X-Requested-With\", \"Content-Type\", \"Accept\", \"Origin\" ), allowCredentials: Boolean = true, preflightMaxAge: String = \"1800\", chainPreflight: Boolean = true, exposedHeaders: Array<String> = arrayOf())
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allow-credentials/","title":"allowCredentials - Misk","text":"//misk/misk.web/CorsConfig/allowCredentials
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allow-credentials/#allowcredentials","title":"allowCredentials","text":"[jvm]\\ val allowCredentials: Boolean = true
A boolean indicating if the resource allows requests with credentials.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-headers/","title":"allowedHeaders - Misk","text":"//misk/misk.web/CorsConfig/allowedHeaders
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-headers/#allowedheaders","title":"allowedHeaders","text":"[jvm]\\ val allowedHeaders: Array<String>
A comma separated list of HTTP headers that are allowed to be specified when accessing the resources.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-methods/","title":"allowedMethods - Misk","text":"//misk/misk.web/CorsConfig/allowedMethods
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-methods/#allowedmethods","title":"allowedMethods","text":"[jvm]\\ val allowedMethods: Array<String>
A comma separated list of HTTP methods that are allowed to be used when accessing the resources.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-origins/","title":"allowedOrigins - Misk","text":"//misk/misk.web/CorsConfig/allowedOrigins
"},{"location":"0.x/misk/misk/misk.web/-cors-config/allowed-origins/#allowedorigins","title":"allowedOrigins","text":"[jvm]\\ val allowedOrigins: Array<String>
A comma separated list of origins that are allowed to access the resources.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/chain-preflight/","title":"chainPreflight - Misk","text":"//misk/misk.web/CorsConfig/chainPreflight
"},{"location":"0.x/misk/misk/misk.web/-cors-config/chain-preflight/#chainpreflight","title":"chainPreflight","text":"[jvm]\\ val chainPreflight: Boolean = true
True if preflight requests are chained to their target resource for normal handling (as an OPTION request).
"},{"location":"0.x/misk/misk/misk.web/-cors-config/exposed-headers/","title":"exposedHeaders - Misk","text":"//misk/misk.web/CorsConfig/exposedHeaders
"},{"location":"0.x/misk/misk/misk.web/-cors-config/exposed-headers/#exposedheaders","title":"exposedHeaders","text":"[jvm]\\ val exposedHeaders: Array<String>
A comma separated list of HTTP headers that are allowed to be exposed on the client.
"},{"location":"0.x/misk/misk/misk.web/-cors-config/preflight-max-age/","title":"preflightMaxAge - Misk","text":"//misk/misk.web/CorsConfig/preflightMaxAge
"},{"location":"0.x/misk/misk/misk.web/-cors-config/preflight-max-age/#preflightmaxage","title":"preflightMaxAge","text":"[jvm]\\ val preflightMaxAge: String
The number of seconds that preflight requests can be cached by the client.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/","title":"FeatureBinding - Misk","text":"//misk/misk.web/FeatureBinding
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#featurebinding","title":"FeatureBinding","text":"[jvm]\\ interface FeatureBinding
Binds an HTTP call to a WebAction function.
Each web action has several features:
Each bindings claims one or more features that it is responsible for. Some examples:
A binding can claim multiple features. beforeCall is invoked if any features are claimed, and afterCall is only invoked if the return value is claimed.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#creating-bindings","title":"Creating Bindings","text":"Each factory is executed once for each endpoint at service startup time. Factories should interrogate the function and claim whichever features that intend to bind. This happens early so Misk can validate that every feature is bound exactly once.
Factories that return null must make no claims. If no claims are made then no binding is executed.
Misk will validate that every feature is claimed exactly once. If a feature is unclaimed that is a fatal error and the service will not be started.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#binding-execution","title":"Binding Execution","text":"Once a functions bindings have been created and validated, each binding will be executed once before and once after every each HTTP call. In this method it must bind the features it claimed by providing parameters, reading the request body, writing the response body, or taking the return value.
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#types","title":"Types","text":"Name Summary Claimer [jvm]interface Claimer Factory [jvm]interface Factory Subject [jvm]interface Subject"},{"location":"0.x/misk/misk/misk.web/-feature-binding/#functions","title":"Functions","text":"Name Summary afterCall [jvm]open fun afterCall(subject: FeatureBinding.Subject) beforeCall [jvm]open fun beforeCall(subject: FeatureBinding.Subject)"},{"location":"0.x/misk/misk/misk.web/-feature-binding/after-call/","title":"afterCall - Misk","text":"//misk/misk.web/FeatureBinding/afterCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/after-call/#aftercall","title":"afterCall","text":"[jvm]\\ open fun afterCall(subject: FeatureBinding.Subject)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/before-call/","title":"beforeCall - Misk","text":"//misk/misk.web/FeatureBinding/beforeCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/before-call/#beforecall","title":"beforeCall","text":"[jvm]\\ open fun beforeCall(subject: FeatureBinding.Subject)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/","title":"Claimer - Misk","text":"//misk/misk.web/FeatureBinding/Claimer
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/#claimer","title":"Claimer","text":"[jvm]\\ interface Claimer
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/#functions","title":"Functions","text":"Name Summary claimParameter [jvm]abstract fun claimParameter(index: Int)abstract fun claimParameter(parameter: KParameter) claimRequestBody [jvm]abstract fun claimRequestBody() claimResponseBody [jvm]abstract fun claimResponseBody() claimReturnValue [jvm]abstract fun claimReturnValue()"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-parameter/","title":"claimParameter - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimParameter
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-parameter/#claimparameter","title":"claimParameter","text":"[jvm]\\ abstract fun claimParameter(index: Int)
abstract fun claimParameter(parameter: KParameter)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-request-body/","title":"claimRequestBody - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimRequestBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-request-body/#claimrequestbody","title":"claimRequestBody","text":"[jvm]\\ abstract fun claimRequestBody()
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-response-body/","title":"claimResponseBody - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimResponseBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-response-body/#claimresponsebody","title":"claimResponseBody","text":"[jvm]\\ abstract fun claimResponseBody()
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-return-value/","title":"claimReturnValue - Misk","text":"//misk/misk.web/FeatureBinding/Claimer/claimReturnValue
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-claimer/claim-return-value/#claimreturnvalue","title":"claimReturnValue","text":"[jvm]\\ abstract fun claimReturnValue()
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/","title":"Factory - Misk","text":"//misk/misk.web/FeatureBinding/Factory
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/#factory","title":"Factory","text":"[jvm]\\ interface Factory
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action, pathPattern: PathPattern, claimer: FeatureBinding.Claimer): FeatureBinding?"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/create/","title":"create - Misk","text":"//misk/misk.web/FeatureBinding/Factory/create
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action, pathPattern: PathPattern, claimer: FeatureBinding.Claimer): FeatureBinding?
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/","title":"Subject - Misk","text":"//misk/misk.web/FeatureBinding/Subject
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#subject","title":"Subject","text":"[jvm]\\ interface Subject
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#properties","title":"Properties","text":"Name Summary httpCall [jvm]abstract val httpCall: HttpCall pathMatcher [jvm]abstract val pathMatcher: Matcher webAction [jvm]abstract val webAction: WebAction"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/#functions","title":"Functions","text":"Name Summary setParameter [jvm]abstract fun setParameter(index: Int, value: Any?)abstract fun setParameter(parameter: KParameter, value: Any?) takeRequestBody [jvm]abstract fun takeRequestBody(): BufferedSource takeResponseBody [jvm]abstract fun takeResponseBody(): BufferedSink takeReturnValue [jvm]abstract fun takeReturnValue(): Any?"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/http-call/","title":"httpCall - Misk","text":"//misk/misk.web/FeatureBinding/Subject/httpCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/http-call/#httpcall","title":"httpCall","text":"[jvm]\\ abstract val httpCall: HttpCall
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/path-matcher/","title":"pathMatcher - Misk","text":"//misk/misk.web/FeatureBinding/Subject/pathMatcher
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/path-matcher/#pathmatcher","title":"pathMatcher","text":"[jvm]\\ abstract val pathMatcher: Matcher
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/set-parameter/","title":"setParameter - Misk","text":"//misk/misk.web/FeatureBinding/Subject/setParameter
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/set-parameter/#setparameter","title":"setParameter","text":"[jvm]\\ abstract fun setParameter(parameter: KParameter, value: Any?)
abstract fun setParameter(index: Int, value: Any?)
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-request-body/","title":"takeRequestBody - Misk","text":"//misk/misk.web/FeatureBinding/Subject/takeRequestBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-request-body/#takerequestbody","title":"takeRequestBody","text":"[jvm]\\ abstract fun takeRequestBody(): BufferedSource
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-response-body/","title":"takeResponseBody - Misk","text":"//misk/misk.web/FeatureBinding/Subject/takeResponseBody
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"[jvm]\\ abstract fun takeResponseBody(): BufferedSink
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-return-value/","title":"takeReturnValue - Misk","text":"//misk/misk.web/FeatureBinding/Subject/takeReturnValue
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/take-return-value/#takereturnvalue","title":"takeReturnValue","text":"[jvm]\\ abstract fun takeReturnValue(): Any?
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/web-action/","title":"webAction - Misk","text":"//misk/misk.web/FeatureBinding/Subject/webAction
"},{"location":"0.x/misk/misk/misk.web/-feature-binding/-subject/web-action/#webaction","title":"webAction","text":"[jvm]\\ abstract val webAction: WebAction
"},{"location":"0.x/misk/misk/misk.web/-http-call/","title":"HttpCall - Misk","text":"//misk/misk.web/HttpCall
"},{"location":"0.x/misk/misk/misk.web/-http-call/#httpcall","title":"HttpCall","text":"[jvm]\\ interface HttpCall : HttpRequest
A live HTTP call from a client for use by a chain of network interceptors.
"},{"location":"0.x/misk/misk/misk.web/-http-call/#properties","title":"Properties","text":"Name Summary cookies [jvm]abstract var cookies: List<Cookie>Cookies derived from request\u2019s \"Cookie\" header, if any dispatchMechanism [jvm]abstract val dispatchMechanism: DispatchMechanism linkLayerLocalAddress [jvm]abstract val linkLayerLocalAddress: SocketAddress? networkStatusCode [jvm]abstract val networkStatusCode: IntThe HTTP status code actually sent over the network. For gRPC, this is always 200, even for errors, per the spec. requestHeaders [jvm]abstract var requestHeaders: Headers responseHeaders [jvm]abstract val responseHeaders: Headers statusCode [jvm]abstract var statusCode: IntMeaningful HTTP status about what actually happened. Not sent over the wire in the case of gRPC, which always returns HTTP 200 even for errors. url [jvm]abstract val url: HttpUrl"},{"location":"0.x/misk/misk/misk.web/-http-call/#functions","title":"Functions","text":"Name Summary accepts [jvm]open fun accepts(): List<MediaRange> addResponseHeaders [jvm]abstract fun addResponseHeaders(headers: Headers) asOkHttpRequest [jvm]open fun asOkHttpRequest(): Request computeRequestHeader [jvm]open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?)Set or replaces an existing HTTP request header. contentType [jvm]open fun contentType(): MediaType? initWebSocketListener [jvm]abstract fun initWebSocketListener(webSocketListener: WebSocketListener)Set the call\u2019s web socket listener. This should only be called once, and only for web socket calls. putRequestBody [jvm]abstract fun putRequestBody(requestBody: BufferedSource)Changes this call so that the next call to takeRequestBody returns requestBody. Use this to apply filters such as decompression or metrics. putResponseBody [jvm]abstract fun putResponseBody(responseBody: BufferedSink)Changes this call so that the next call to takeResponseBody returns responseBody. Use this to apply filters such as decompression or metrics. putWebSocket [jvm]abstract fun putWebSocket(webSocket: WebSocket)Changes this call so that the next call to takeWebSocket returns webSocket. Use this to apply filters such as decompression or metrics. requireTrailers [jvm]abstract fun requireTrailers()Call this before the response body is written to make sure it is encoded in a way that\u2019ll permit trailers to be sent. This will do chunked encoding for HTTP/1. For HTTP/2 trailers are always permitted. It is an error to call this for web socket calls. setResponseHeader [jvm]abstract fun setResponseHeader(name: String, value: String) setResponseTrailer [jvm]abstract fun setResponseTrailer(name: String, value: String)Add a trailer. This requires that requireTrailers was called before the response body is written. setStatusCodes [jvm]abstract fun setStatusCodes(statusCode: Int, networkStatusCode: Int)Set both the raw network status code and the meaningful status code that\u2019s recorded in metrics takeRequestBody [jvm]abstract fun takeRequestBody(): BufferedSource?Claim ownership of the request body stream. Returns null if the stream has already been claimed. Callers should read the HTTP request body or call putRequestBody to create a new chain with a request body that is unclaimed. takeResponseBody [jvm]abstract fun takeResponseBody(): BufferedSink?Claim ownership of the response body stream. Returns null if the stream has already been claimed. Callers should write the HTTP response body or call putRequestBody to create a new chain with a response body that is unclaimed. takeWebSocket [jvm]abstract fun takeWebSocket(): WebSocket?Claim ownership of the call\u2019s web socket."},{"location":"0.x/misk/misk/misk.web/-http-call/accepts/","title":"accepts - Misk","text":"//misk/misk.web/HttpCall/accepts
"},{"location":"0.x/misk/misk/misk.web/-http-call/accepts/#accepts","title":"accepts","text":"[jvm]\\ open fun accepts(): List<MediaRange>
"},{"location":"0.x/misk/misk/misk.web/-http-call/add-response-headers/","title":"addResponseHeaders - Misk","text":"//misk/misk.web/HttpCall/addResponseHeaders
"},{"location":"0.x/misk/misk/misk.web/-http-call/add-response-headers/#addresponseheaders","title":"addResponseHeaders","text":"[jvm]\\ abstract fun addResponseHeaders(headers: Headers)
"},{"location":"0.x/misk/misk/misk.web/-http-call/as-ok-http-request/","title":"asOkHttpRequest - Misk","text":"//misk/misk.web/HttpCall/asOkHttpRequest
"},{"location":"0.x/misk/misk/misk.web/-http-call/as-ok-http-request/#asokhttprequest","title":"asOkHttpRequest","text":"[jvm]\\ open fun asOkHttpRequest(): Request
"},{"location":"0.x/misk/misk/misk.web/-http-call/compute-request-header/","title":"computeRequestHeader - Misk","text":"//misk/misk.web/HttpCall/computeRequestHeader
"},{"location":"0.x/misk/misk/misk.web/-http-call/compute-request-header/#computerequestheader","title":"computeRequestHeader","text":"[jvm]\\ open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?)
Set or replaces an existing HTTP request header.
"},{"location":"0.x/misk/misk/misk.web/-http-call/content-type/","title":"contentType - Misk","text":"//misk/misk.web/HttpCall/contentType
"},{"location":"0.x/misk/misk/misk.web/-http-call/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web/-http-call/cookies/","title":"cookies - Misk","text":"//misk/misk.web/HttpCall/cookies
"},{"location":"0.x/misk/misk/misk.web/-http-call/cookies/#cookies","title":"cookies","text":"[jvm]\\ abstract var cookies: List<Cookie>
Cookies derived from request\u2019s \"Cookie\" header, if any
"},{"location":"0.x/misk/misk/misk.web/-http-call/init-web-socket-listener/","title":"initWebSocketListener - Misk","text":"//misk/misk.web/HttpCall/initWebSocketListener
"},{"location":"0.x/misk/misk/misk.web/-http-call/init-web-socket-listener/#initwebsocketlistener","title":"initWebSocketListener","text":"[jvm]\\ abstract fun initWebSocketListener(webSocketListener: WebSocketListener)
Set the call\u2019s web socket listener. This should only be called once, and only for web socket calls.
"},{"location":"0.x/misk/misk/misk.web/-http-call/link-layer-local-address/","title":"linkLayerLocalAddress - Misk","text":"//misk/misk.web/HttpCall/linkLayerLocalAddress
"},{"location":"0.x/misk/misk/misk.web/-http-call/link-layer-local-address/#linklayerlocaladdress","title":"linkLayerLocalAddress","text":"[jvm]\\ abstract val linkLayerLocalAddress: SocketAddress?
"},{"location":"0.x/misk/misk/misk.web/-http-call/network-status-code/","title":"networkStatusCode - Misk","text":"//misk/misk.web/HttpCall/networkStatusCode
"},{"location":"0.x/misk/misk/misk.web/-http-call/network-status-code/#networkstatuscode","title":"networkStatusCode","text":"[jvm]\\ abstract val networkStatusCode: Int
The HTTP status code actually sent over the network. For gRPC, this is always 200, even for errors, per the spec.
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-request-body/","title":"putRequestBody - Misk","text":"//misk/misk.web/HttpCall/putRequestBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-request-body/#putrequestbody","title":"putRequestBody","text":"[jvm]\\ abstract fun putRequestBody(requestBody: BufferedSource)
Changes this call so that the next call to takeRequestBody returns requestBody. Use this to apply filters such as decompression or metrics.
This may only be called on calls whose request body has been taken. Otherwise that would be leaked.
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-response-body/","title":"putResponseBody - Misk","text":"//misk/misk.web/HttpCall/putResponseBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-response-body/#putresponsebody","title":"putResponseBody","text":"[jvm]\\ abstract fun putResponseBody(responseBody: BufferedSink)
Changes this call so that the next call to takeResponseBody returns responseBody. Use this to apply filters such as decompression or metrics.
This may only be called on calls whose response body has been taken. Otherwise that would be leaked.
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-web-socket/","title":"putWebSocket - Misk","text":"//misk/misk.web/HttpCall/putWebSocket
"},{"location":"0.x/misk/misk/misk.web/-http-call/put-web-socket/#putwebsocket","title":"putWebSocket","text":"[jvm]\\ abstract fun putWebSocket(webSocket: WebSocket)
Changes this call so that the next call to takeWebSocket returns webSocket. Use this to apply filters such as decompression or metrics.
This may only be called on calls whose web socket has been taken. Otherwise that would be leaked.
"},{"location":"0.x/misk/misk/misk.web/-http-call/require-trailers/","title":"requireTrailers - Misk","text":"//misk/misk.web/HttpCall/requireTrailers
"},{"location":"0.x/misk/misk/misk.web/-http-call/require-trailers/#requiretrailers","title":"requireTrailers","text":"[jvm]\\ abstract fun requireTrailers()
Call this before the response body is written to make sure it is encoded in a way that\u2019ll permit trailers to be sent. This will do chunked encoding for HTTP/1. For HTTP/2 trailers are always permitted. It is an error to call this for web socket calls.
"},{"location":"0.x/misk/misk/misk.web/-http-call/response-headers/","title":"responseHeaders - Misk","text":"//misk/misk.web/HttpCall/responseHeaders
"},{"location":"0.x/misk/misk/misk.web/-http-call/response-headers/#responseheaders","title":"responseHeaders","text":"[jvm]\\ abstract val responseHeaders: Headers
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-header/","title":"setResponseHeader - Misk","text":"//misk/misk.web/HttpCall/setResponseHeader
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-header/#setresponseheader","title":"setResponseHeader","text":"[jvm]\\ abstract fun setResponseHeader(name: String, value: String)
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-trailer/","title":"setResponseTrailer - Misk","text":"//misk/misk.web/HttpCall/setResponseTrailer
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-response-trailer/#setresponsetrailer","title":"setResponseTrailer","text":"[jvm]\\ abstract fun setResponseTrailer(name: String, value: String)
Add a trailer. This requires that requireTrailers was called before the response body is written.
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-status-codes/","title":"setStatusCodes - Misk","text":"//misk/misk.web/HttpCall/setStatusCodes
"},{"location":"0.x/misk/misk/misk.web/-http-call/set-status-codes/#setstatuscodes","title":"setStatusCodes","text":"[jvm]\\ abstract fun setStatusCodes(statusCode: Int, networkStatusCode: Int)
Set both the raw network status code and the meaningful status code that\u2019s recorded in metrics
"},{"location":"0.x/misk/misk/misk.web/-http-call/status-code/","title":"statusCode - Misk","text":"//misk/misk.web/HttpCall/statusCode
"},{"location":"0.x/misk/misk/misk.web/-http-call/status-code/#statuscode","title":"statusCode","text":"[jvm]\\ abstract var statusCode: Int
Meaningful HTTP status about what actually happened. Not sent over the wire in the case of gRPC, which always returns HTTP 200 even for errors.
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-request-body/","title":"takeRequestBody - Misk","text":"//misk/misk.web/HttpCall/takeRequestBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-request-body/#takerequestbody","title":"takeRequestBody","text":"[jvm]\\ abstract fun takeRequestBody(): BufferedSource?
Claim ownership of the request body stream. Returns null if the stream has already been claimed. Callers should read the HTTP request body or call putRequestBody to create a new chain with a request body that is unclaimed.
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-response-body/","title":"takeResponseBody - Misk","text":"//misk/misk.web/HttpCall/takeResponseBody
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"[jvm]\\ abstract fun takeResponseBody(): BufferedSink?
Claim ownership of the response body stream. Returns null if the stream has already been claimed. Callers should write the HTTP response body or call putRequestBody to create a new chain with a response body that is unclaimed.
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-web-socket/","title":"takeWebSocket - Misk","text":"//misk/misk.web/HttpCall/takeWebSocket
"},{"location":"0.x/misk/misk/misk.web/-http-call/take-web-socket/#takewebsocket","title":"takeWebSocket","text":"[jvm]\\ abstract fun takeWebSocket(): WebSocket?
Claim ownership of the call\u2019s web socket.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/","title":"MiskWebFormBuilder - Misk","text":"//misk/misk.web/MiskWebFormBuilder
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#miskwebformbuilder","title":"MiskWebFormBuilder","text":"[jvm]\\ class MiskWebFormBuilder
Provides a mapping from field name to Type definition given a KType. Useful for processes that want to have a schema definition of a type. For example: used by the WebActions admin dashboard tab to show a statically typed form containing request fields for developers to fill out. Currently only supports Wire request type messages; non-Wire messages return an empty mapping.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#constructors","title":"Constructors","text":"MiskWebFormBuilder [jvm]constructor()"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Field [jvm]data class Field@JvmOverloadsconstructor(val name: String, val type: String, val repeated: Boolean, val annotations: List<String> = listOf())Akin to a Proto field, a field can be of primitive or another Message type, and can be repeated to become a list. Type [jvm]data class Type(val fields: List<MiskWebFormBuilder.Field>)Akin to a Proto Message, a Type has a list of fields"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/#functions","title":"Functions","text":"Name Summary calculateTypes [jvm]fun calculateTypes(requestType: KType?): Map<String, MiskWebFormBuilder.Type>"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-misk-web-form-builder/","title":"MiskWebFormBuilder - Misk","text":"//misk/misk.web/MiskWebFormBuilder/MiskWebFormBuilder
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-misk-web-form-builder/#miskwebformbuilder","title":"MiskWebFormBuilder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/calculate-types/","title":"calculateTypes - Misk","text":"//misk/misk.web/MiskWebFormBuilder/calculateTypes
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/calculate-types/#calculatetypes","title":"calculateTypes","text":"[jvm]\\ fun calculateTypes(requestType: KType?): Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/","title":"Companion - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Companion
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/#functions","title":"Functions","text":"Name Summary createEnumField [jvm]fun createEnumField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.FieldAdds a field with a type that has the class name and enum values embedded Example: \"Enum\" createSyntheticEnumField [jvm]fun createSyntheticEnumField(fieldClassName: String, fieldName: String, enumValues: List<String>, repeated: Boolean, annotations: List<Annotation> = listOf()): MiskWebFormBuilder.FieldAdds a field with a type that has the class name and enum values embedded Example: \"Enum\" maybeCreatePrimitiveField [jvm]fun maybeCreatePrimitiveField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field?Create misk-web Fields for primitives and enum types. Returns null if the type cannot be mapped."},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-enum-field/","title":"createEnumField - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Companion/createEnumField
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-enum-field/#createenumfield","title":"createEnumField","text":"[jvm]\\ fun createEnumField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field
Adds a field with a type that has the class name and enum values embedded Example: \"Enum\""},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-synthetic-enum-field/","title":"createSyntheticEnumField - Misk","text":"
//misk/misk.web/MiskWebFormBuilder/Companion/createSyntheticEnumField
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/create-synthetic-enum-field/#createsyntheticenumfield","title":"createSyntheticEnumField","text":"[jvm]\\ fun createSyntheticEnumField(fieldClassName: String, fieldName: String, enumValues: List<String>, repeated: Boolean, annotations: List<Annotation> = listOf()): MiskWebFormBuilder.Field
Adds a field with a type that has the class name and enum values embedded Example: \"Enum\""},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/maybe-create-primitive-field/","title":"maybeCreatePrimitiveField - Misk","text":"
//misk/misk.web/MiskWebFormBuilder/Companion/maybeCreatePrimitiveField
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-companion/maybe-create-primitive-field/#maybecreateprimitivefield","title":"maybeCreatePrimitiveField","text":"[jvm]\\ fun maybeCreatePrimitiveField(fieldClass: Class<*>, fieldName: String, repeated: Boolean, annotations: List<Annotation> = emptyList()): MiskWebFormBuilder.Field?
Create misk-web Fields for primitives and enum types. Returns null if the type cannot be mapped.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/","title":"Field - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#field","title":"Field","text":"[jvm]\\ data class Field@JvmOverloadsconstructor(val name: String, val type: String, val repeated: Boolean, val annotations: List<String> = listOf())
Akin to a Proto field, a field can be of primitive or another Message type, and can be repeated to become a list.
Enums are encoded to contain their values within their Type definition as opposed to a unique Type.
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#constructors","title":"Constructors","text":"Field [jvm]@JvmOverloadsconstructor(name: String, type: String, repeated: Boolean, annotations: List<String> = listOf())"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/#properties","title":"Properties","text":"Name Summary annotations [jvm]val annotations: List<String> name [jvm]val name: String repeated [jvm]val repeated: Boolean type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/-field/","title":"Field - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/Field
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/-field/#field","title":"Field","text":"[jvm]\\
@JvmOverloads
constructor(name: String, type: String, repeated: Boolean, annotations: List<String> = listOf())
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/annotations/","title":"annotations - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/annotations
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/annotations/#annotations","title":"annotations","text":"[jvm]\\ val annotations: List<String>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/name/","title":"name - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/name
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/repeated/","title":"repeated - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/repeated
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/repeated/#repeated","title":"repeated","text":"[jvm]\\ val repeated: Boolean
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/type/","title":"type - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Field/type
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-field/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/","title":"Type - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Type
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#type","title":"Type","text":"[jvm]\\ data class Type(val fields: List<MiskWebFormBuilder.Field>)
Akin to a Proto Message, a Type has a list of fields
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#constructors","title":"Constructors","text":"Type [jvm]constructor(fields: List<MiskWebFormBuilder.Field>)"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/#properties","title":"Properties","text":"Name Summary fields [jvm]val fields: List<MiskWebFormBuilder.Field>"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/-type/","title":"Type - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Type/Type
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/-type/#type","title":"Type","text":"[jvm]\\ constructor(fields: List<MiskWebFormBuilder.Field>)
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/fields/","title":"fields - Misk","text":"//misk/misk.web/MiskWebFormBuilder/Type/fields
"},{"location":"0.x/misk/misk/misk.web/-misk-web-form-builder/-type/fields/#fields","title":"fields","text":"[jvm]\\ val fields: List<MiskWebFormBuilder.Field>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/","title":"MiskWebModule - Misk","text":"//misk/misk.web/MiskWebModule
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#miskwebmodule","title":"MiskWebModule","text":"[jvm]\\ class MiskWebModule@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList()) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#constructors","title":"Constructors","text":"MiskWebModule [jvm]@JvmOverloadsconstructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList())"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#types","title":"Types","text":"Name Summary MiskCallerProvider [jvm]class MiskCallerProvider@Injectconstructor(authenticators: List<MiskCallerAuthenticator>) : ActionScopedProvider<MiskCaller?>"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideGzipHandler [jvm]@Provides@Singletonfun provideGzipHandler(): GzipHandler provideStatisticsHandler [jvm]@Provides@Singletonfun provideStatisticsHandler(): StatisticsHandler readinessRefreshQueue [jvm]@Provides@Singletonfun readinessRefreshQueue(queueFactory: RepeatedTaskQueueFactory, deployment: Deployment): RepeatedTaskQueue"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-web-module/","title":"MiskWebModule - Misk","text":"//misk/misk.web/MiskWebModule/MiskWebModule
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-web-module/#miskwebmodule","title":"MiskWebModule","text":"[jvm]\\
@JvmOverloads
constructor(config: WebConfig, jettyDependsOn: List<Key<out Service>> = emptyList())
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-gzip-handler/","title":"provideGzipHandler - Misk","text":"//misk/misk.web/MiskWebModule/provideGzipHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-gzip-handler/#providegziphandler","title":"provideGzipHandler","text":"[jvm]\\
@Provides
@Singleton
fun provideGzipHandler(): GzipHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-statistics-handler/","title":"provideStatisticsHandler - Misk","text":"//misk/misk.web/MiskWebModule/provideStatisticsHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/provide-statistics-handler/#providestatisticshandler","title":"provideStatisticsHandler","text":"[jvm]\\
@Provides
@Singleton
fun provideStatisticsHandler(): StatisticsHandler
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/readiness-refresh-queue/","title":"readinessRefreshQueue - Misk","text":"//misk/misk.web/MiskWebModule/readinessRefreshQueue
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/readiness-refresh-queue/#readinessrefreshqueue","title":"readinessRefreshQueue","text":"[jvm]\\
@Provides
@Singleton
fun readinessRefreshQueue(queueFactory: RepeatedTaskQueueFactory, deployment: Deployment): RepeatedTaskQueue
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/","title":"MiskCallerProvider - Misk","text":"//misk/misk.web/MiskWebModule/MiskCallerProvider
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#miskcallerprovider","title":"MiskCallerProvider","text":"[jvm]\\ class MiskCallerProvider@Injectconstructor(authenticators: List<MiskCallerAuthenticator>) : ActionScopedProvider<MiskCaller?>
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#constructors","title":"Constructors","text":"MiskCallerProvider [jvm]@Injectconstructor(authenticators: List<MiskCallerAuthenticator>)"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): MiskCaller?"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/-misk-caller-provider/","title":"MiskCallerProvider - Misk","text":"//misk/misk.web/MiskWebModule/MiskCallerProvider/MiskCallerProvider
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/-misk-caller-provider/#miskcallerprovider","title":"MiskCallerProvider","text":"[jvm]\\
@Inject
constructor(authenticators: List<MiskCallerAuthenticator>)
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/get/","title":"get - Misk","text":"//misk/misk.web/MiskWebModule/MiskCallerProvider/get
"},{"location":"0.x/misk/misk/misk.web/-misk-web-module/-misk-caller-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): MiskCaller?
"},{"location":"0.x/misk/misk/misk.web/-network-chain/","title":"NetworkChain - Misk","text":"//misk/misk.web/NetworkChain
"},{"location":"0.x/misk/misk/misk.web/-network-chain/#networkchain","title":"NetworkChain","text":"[jvm]\\ interface NetworkChain
"},{"location":"0.x/misk/misk/misk.web/-network-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ActionThe action for this call. httpCall [jvm]abstract val httpCall: HttpCallThe live HTTP call. You can access hot streams on this call. webAction [jvm]abstract val webAction: WebActionThe action instance this call is routing to."},{"location":"0.x/misk/misk/misk.web/-network-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(httpCall: HttpCall)Invoke the next call in the interceptor chain."},{"location":"0.x/misk/misk/misk.web/-network-chain/action/","title":"action - Misk","text":"//misk/misk.web/NetworkChain/action
"},{"location":"0.x/misk/misk/misk.web/-network-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: Action
The action for this call.
"},{"location":"0.x/misk/misk/misk.web/-network-chain/http-call/","title":"httpCall - Misk","text":"//misk/misk.web/NetworkChain/httpCall
"},{"location":"0.x/misk/misk/misk.web/-network-chain/http-call/#httpcall","title":"httpCall","text":"[jvm]\\ abstract val httpCall: HttpCall
The live HTTP call. You can access hot streams on this call.
"},{"location":"0.x/misk/misk/misk.web/-network-chain/proceed/","title":"proceed - Misk","text":"//misk/misk.web/NetworkChain/proceed
"},{"location":"0.x/misk/misk/misk.web/-network-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(httpCall: HttpCall)
Invoke the next call in the interceptor chain.
"},{"location":"0.x/misk/misk/misk.web/-network-chain/web-action/","title":"webAction - Misk","text":"//misk/misk.web/NetworkChain/webAction
"},{"location":"0.x/misk/misk/misk.web/-network-chain/web-action/#webaction","title":"webAction","text":"[jvm]\\ abstract val webAction: WebAction
The action instance this call is routing to.
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/","title":"NetworkInterceptor - Misk","text":"//misk/misk.web/NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#networkinterceptor","title":"NetworkInterceptor","text":"interface NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#inheritors","title":"Inheritors","text":"ContentSecurityPolicyInterceptor ExceptionHandlingInterceptor RebalancingInterceptor RequestLoggingInterceptor WideOpenDevelopmentInterceptor"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface Factory"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web/NetworkInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ abstract fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web/NetworkInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#factory","title":"Factory","text":"interface Factory
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#inheritors","title":"Inheritors","text":"Factory Factory InternalErrorInterceptorFactory Factory Factory WideOpenDevelopmentInterceptorFactory"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]abstract fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web/NetworkInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web/-network-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/","title":"PathPattern - Misk","text":"//misk/misk.web/PathPattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/#pathpattern","title":"PathPattern","text":"[jvm]\\ class PathPattern(val pattern: String, val regex: Pattern, val variableNames: List<String>, val numRegexVariables: Int, val numSegments: Int, val matchesWildcardPath: Boolean) : Comparable<PathPattern>
A path with placeholders for variables. Paths may be constant like /app/home/ or dynamic like /user/{username}. Variables are delimited by curly braces and may specify an optional regex like this: {username:[a-z]+}. If no regex is specified the variable is a sequence of non-\u2018/\u2019 characters.
//misk/misk.web/PathPattern/PathPattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-path-pattern/#pathpattern","title":"PathPattern","text":"[jvm]\\ constructor(pattern: String, regex: Pattern, variableNames: List<String>, numRegexVariables: Int, numSegments: Int, matchesWildcardPath: Boolean)
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/compare-to/","title":"compareTo - Misk","text":"//misk/misk.web/PathPattern/compareTo
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: PathPattern): Int
Compares path patterns by specificity with the more specific pattern ordered first.
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/equals/","title":"equals - Misk","text":"//misk/misk.web/PathPattern/equals
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/hash-code/","title":"hashCode - Misk","text":"//misk/misk.web/PathPattern/hashCode
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matcher/","title":"matcher - Misk","text":"//misk/misk.web/PathPattern/matcher
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matcher/#matcher","title":"matcher","text":"[jvm]\\ fun matcher(requestUrl: HttpUrl): Matcher?
Returns a Matcher if requestUrl can be matched, else null
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matches-wildcard-path/","title":"matchesWildcardPath - Misk","text":"//misk/misk.web/PathPattern/matchesWildcardPath
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/matches-wildcard-path/#matcheswildcardpath","title":"matchesWildcardPath","text":"[jvm]\\ val matchesWildcardPath: Boolean
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-regex-variables/","title":"numRegexVariables - Misk","text":"//misk/misk.web/PathPattern/numRegexVariables
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-regex-variables/#numregexvariables","title":"numRegexVariables","text":"[jvm]\\ val numRegexVariables: Int
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-segments/","title":"numSegments - Misk","text":"//misk/misk.web/PathPattern/numSegments
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/num-segments/#numsegments","title":"numSegments","text":"[jvm]\\ val numSegments: Int
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/pattern/","title":"pattern - Misk","text":"//misk/misk.web/PathPattern/pattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/pattern/#pattern","title":"pattern","text":"[jvm]\\ val pattern: String
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/regex/","title":"regex - Misk","text":"//misk/misk.web/PathPattern/regex
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/regex/#regex","title":"regex","text":"[jvm]\\ val regex: Pattern
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/to-string/","title":"toString - Misk","text":"//misk/misk.web/PathPattern/toString
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/variable-names/","title":"variableNames - Misk","text":"//misk/misk.web/PathPattern/variableNames
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/variable-names/#variablenames","title":"variableNames","text":"[jvm]\\ val variableNames: List<String>
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/","title":"Companion - Misk","text":"//misk/misk.web/PathPattern/Companion
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(pattern: String): PathPattern"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/parse/","title":"parse - Misk","text":"//misk/misk.web/PathPattern/Companion/parse
"},{"location":"0.x/misk/misk/misk.web/-path-pattern/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(pattern: String): PathPattern
"},{"location":"0.x/misk/misk/misk.web/-socket-address/","title":"SocketAddress - Misk","text":"//misk/misk.web/SocketAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/#socketaddress","title":"SocketAddress","text":"sealed class SocketAddress
Information about the socket on which a HTTP call arrived.
"},{"location":"0.x/misk/misk/misk.web/-socket-address/#inheritors","title":"Inheritors","text":"Network Unix"},{"location":"0.x/misk/misk/misk.web/-socket-address/#types","title":"Types","text":"Name Summary Network [jvm]class Network(val ipAddress: String, val port: Int) : SocketAddress Unix [jvm]class Unix(val path: String) : SocketAddress"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/","title":"Network - Misk","text":"//misk/misk.web/SocketAddress/Network
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#network","title":"Network","text":"[jvm]\\ class Network(val ipAddress: String, val port: Int) : SocketAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#constructors","title":"Constructors","text":"Network [jvm]constructor(ipAddress: String, port: Int)"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/#properties","title":"Properties","text":"Name Summary ipAddress [jvm]val ipAddress: String port [jvm]val port: Int"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/-network/","title":"Network - Misk","text":"//misk/misk.web/SocketAddress/Network/Network
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/-network/#network","title":"Network","text":"[jvm]\\ constructor(ipAddress: String, port: Int)
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/ip-address/","title":"ipAddress - Misk","text":"//misk/misk.web/SocketAddress/Network/ipAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/ip-address/#ipaddress","title":"ipAddress","text":"[jvm]\\ val ipAddress: String
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/port/","title":"port - Misk","text":"//misk/misk.web/SocketAddress/Network/port
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-network/port/#port","title":"port","text":"[jvm]\\ val port: Int
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/","title":"Unix - Misk","text":"//misk/misk.web/SocketAddress/Unix
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#unix","title":"Unix","text":"[jvm]\\ class Unix(val path: String) : SocketAddress
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#constructors","title":"Constructors","text":"Unix [jvm]constructor(path: String)"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/#properties","title":"Properties","text":"Name Summary path [jvm]val path: String"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/-unix/","title":"Unix - Misk","text":"//misk/misk.web/SocketAddress/Unix/Unix
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/-unix/#unix","title":"Unix","text":"[jvm]\\ constructor(path: String)
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/path/","title":"path - Misk","text":"//misk/misk.web/SocketAddress/Unix/path
"},{"location":"0.x/misk/misk/misk.web/-socket-address/-unix/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/","title":"WebActionSeedDataTransformerFactory - Misk","text":"//misk/misk.web/WebActionSeedDataTransformerFactory
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/#webactionseeddatatransformerfactory","title":"WebActionSeedDataTransformerFactory","text":"[jvm]\\ interface WebActionSeedDataTransformerFactory
Creates a SeedDataTransformer for a specific web Action.
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<WebActionSeedDataTransformerFactory>().toInstance(WebActionSeedDataTransformerFactory(...))\n//misk/misk.web/WebActionSeedDataTransformerFactory/create
"},{"location":"0.x/misk/misk/misk.web/-web-action-seed-data-transformer-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(pathPattern: PathPattern, action: Action): SeedDataTransformer?
Returns null to not transform the map on action.
"},{"location":"0.x/misk/misk/misk.web/-web-config/","title":"WebConfig - Misk","text":"//misk/misk.web/WebConfig
"},{"location":"0.x/misk/misk/misk.web/-web-config/#webconfig","title":"WebConfig","text":"[jvm]\\ data class WebConfig@JvmOverloadsconstructor(val port: Int, val idle_timeout: Long = 0, val health_port: Int = -1, val host: String? = null, val ssl: WebSslConfig? = null, val unix_domain_socket: WebUnixDomainSocketConfig? = null, val http2: Boolean = false, val selectors: Int? = null, val acceptors: Int? = null, val queue_size: Int? = null, val jetty_max_thread_pool_size: Int = 200, val jetty_min_thread_pool_size: Int = 8, val jetty_max_thread_pool_queue_size: Int = 300, val enable_thread_pool_queue_metrics: Boolean = false, val action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), val jetty_max_concurrent_streams: Int? = null, val close_connection_percent: Double = 0.0, val gzip: Boolean = true, val minGzipSize: Int = 1024, val cors: Map<String, CorsConfig> = mapOf(), val concurrency_limiter_disabled: Boolean = true, val concurrency_limiter_log_level: Level = Level.ERROR, val concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), val shutdown_sleep_ms: Int = 0, val http_request_header_size: Int? = 32768, val http_header_cache_size: Int? = null, val override_shutdown_idle_timeout: Long? = null, val readiness_refresh_interval_ms: Int = 1000, val readiness_max_age_ms: Int = 10000, val use_virtual_threads: Boolean = false, val install_default_not_found_action: Boolean = true, val jetty_output_buffer_size: Int? = null, val jetty_initial_session_recv_window: Int? = null, val jetty_initial_stream_recv_window: Int? = null, val enable_thread_pool_health_check: Boolean = false, val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null) : Config
"},{"location":"0.x/misk/misk/misk.web/-web-config/#constructors","title":"Constructors","text":"WebConfig [jvm]@JvmOverloadsconstructor(port: Int, idle_timeout: Long = 0, health_port: Int = -1, host: String? = null, ssl: WebSslConfig? = null, unix_domain_socket: WebUnixDomainSocketConfig? = null, http2: Boolean = false, selectors: Int? = null, acceptors: Int? = null, queue_size: Int? = null, jetty_max_thread_pool_size: Int = 200, jetty_min_thread_pool_size: Int = 8, jetty_max_thread_pool_queue_size: Int = 300, enable_thread_pool_queue_metrics: Boolean = false, action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), jetty_max_concurrent_streams: Int? = null, close_connection_percent: Double = 0.0, gzip: Boolean = true, minGzipSize: Int = 1024, cors: Map<String, CorsConfig> = mapOf(), concurrency_limiter_disabled: Boolean = true, concurrency_limiter_log_level: Level = Level.ERROR, concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), shutdown_sleep_ms: Int = 0, http_request_header_size: Int? = 32768, http_header_cache_size: Int? = null, override_shutdown_idle_timeout: Long? = null, readiness_refresh_interval_ms: Int = 1000, readiness_max_age_ms: Int = 10000, use_virtual_threads: Boolean = false, install_default_not_found_action: Boolean = true, jetty_output_buffer_size: Int? = null, jetty_initial_session_recv_window: Int? = null, jetty_initial_stream_recv_window: Int? = null, enable_thread_pool_health_check: Boolean = false, unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null)"},{"location":"0.x/misk/misk/misk.web/-web-config/#properties","title":"Properties","text":"Name Summary acceptors [jvm]val acceptors: Int? = nullNumber of acceptor threads. action_exception_log_level [jvm]val action_exception_log_level: ActionExceptionLogLevelConfig close_connection_percent [jvm]val close_connection_percent: Double = 0.0A value in 0.0..100.0. Include \u2018Connection: close\u2019 in this percentage of responses. concurrency_limiter [jvm]val concurrency_limiter: ConcurrencyLimiterConfig? concurrency_limiter_disabled [jvm]val concurrency_limiter_disabled: Boolean = trueIf true, disables automatic load shedding when degraded. concurrency_limiter_log_level [jvm]val concurrency_limiter_log_level: LevelThe level of log when concurrency shedding. cors [jvm]val cors: Map<String, CorsConfig> enable_thread_pool_health_check [jvm]val enable_thread_pool_health_check: Boolean = falseWires up health checks on whether Jetty\u2019s thread pool is low on threads. enable_thread_pool_queue_metrics [jvm]val enable_thread_pool_queue_metrics: Boolean = falseFlag to enable thread pool queue metrics gzip [jvm]val gzip: Boolean = trueIf true responses which are larger than the minGzipSize will be compressed. health_port [jvm]val health_port: IntIf >= 0, use a dedicated jetty thread pool for health checking. host [jvm]val host: String? = nullThe network interface to bind to. Null or 0.0.0.0 to bind to all interfaces. http2 [jvm]val http2: Boolean = falseHTTP/2 support is currently opt-in because we can\u2019t load balance it dynamically. http_header_cache_size [jvm]val http_header_cache_size: Int? = nullThe size of Jetty\u2019s header field cache, in terms of unique character branches. http_request_header_size [jvm]val http_request_header_size: Int? = 32768The maximum allowed size in bytes for the HTTP request line and HTTP request headers. idle_timeout [jvm]val idle_timeout: Long = 0If a connection is unused for this many milliseconds, it is closed. If zero, it is not closed. install_default_not_found_action [jvm]val install_default_not_found_action: Boolean = trueIf true install NotFoundAction, the default action when a path is not found. jetty_initial_session_recv_window [jvm]val jetty_initial_session_recv_window: Int? = nullThe initial size of session\u2019s flow control receive window. jetty_initial_stream_recv_window [jvm]val jetty_initial_stream_recv_window: Int? = nullThe initial size of stream\u2019s flow control receive window. jetty_max_concurrent_streams [jvm]val jetty_max_concurrent_streams: Int? = nullThe maximum number of streams per HTTP/2 connection. jetty_max_thread_pool_queue_size [jvm]val jetty_max_thread_pool_queue_size: Int = 300Maximum number of items in the queue for Jetty\u2019s thread pool. jetty_max_thread_pool_size [jvm]val jetty_max_thread_pool_size: Int = 200Maximum number of threads in Jetty\u2019s thread pool. jetty_min_thread_pool_size [jvm]val jetty_min_thread_pool_size: Int = 8Minimum number of threads in Jetty\u2019s thread pool. jetty_output_buffer_size [jvm]val jetty_output_buffer_size: Int? = nullThe output buffer size of Jetty (default is 32KB). minGzipSize [jvm]val minGzipSize: Int = 1024The minimum size in bytes before the response body will be compressed. override_shutdown_idle_timeout [jvm]val override_shutdown_idle_timeout: Long? = nullThe number of milliseconds a connection can be idling before commencing service shutdown. If zero, it is never closed and may cause ungraceful shutdown. port [jvm]val port: IntHTTP port to listen on, or 0 for any available port. queue_size [jvm]val queue_size: Int? = nullThe accept backlog. readiness_max_age_ms [jvm]val readiness_max_age_ms: Int = 10000Maximum age of readiness status. If exceeded readiness will return an error readiness_refresh_interval_ms [jvm]val readiness_refresh_interval_ms: Int = 1000How often readiness will re-run its status check. selectors [jvm]val selectors: Int? = nullNumber of NIO selector threads. shutdown_sleep_ms [jvm]val shutdown_sleep_ms: Int = 0The number of milliseconds to sleep before commencing service shutdown. ssl [jvm]val ssl: WebSslConfig? = null unix_domain_socket [jvm]val unix_domain_socket: WebUnixDomainSocketConfig? = nullConfiguration to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (like Envoy). unix_domain_sockets [jvm]val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = nullConfigurations to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (e.g. envoy, istio) use_virtual_threads [jvm]val use_virtual_threads: Boolean = falseIf possible (e.g. running on JDK 21) misk will attempt to use a virtual thread executor for jetty."},{"location":"0.x/misk/misk/misk.web/-web-config/-web-config/","title":"WebConfig - Misk","text":"//misk/misk.web/WebConfig/WebConfig
"},{"location":"0.x/misk/misk/misk.web/-web-config/-web-config/#webconfig","title":"WebConfig","text":"[jvm]\\
@JvmOverloads
constructor(port: Int, idle_timeout: Long = 0, health_port: Int = -1, host: String? = null, ssl: WebSslConfig? = null, unix_domain_socket: WebUnixDomainSocketConfig? = null, http2: Boolean = false, selectors: Int? = null, acceptors: Int? = null, queue_size: Int? = null, jetty_max_thread_pool_size: Int = 200, jetty_min_thread_pool_size: Int = 8, jetty_max_thread_pool_queue_size: Int = 300, enable_thread_pool_queue_metrics: Boolean = false, action_exception_log_level: ActionExceptionLogLevelConfig = ActionExceptionLogLevelConfig(), jetty_max_concurrent_streams: Int? = null, close_connection_percent: Double = 0.0, gzip: Boolean = true, minGzipSize: Int = 1024, cors: Map<String, CorsConfig> = mapOf(), concurrency_limiter_disabled: Boolean = true, concurrency_limiter_log_level: Level = Level.ERROR, concurrency_limiter: ConcurrencyLimiterConfig? = ConcurrencyLimiterConfig( disabled = concurrency_limiter_disabled, strategy = ConcurrencyLimiterStrategy.GRADIENT2, max_concurrency = null, // 2 is chosen somewhat arbitrarily here. Most services have one or two endpoints that // receive the majority of traffic (power law, yay!), and those endpoints should start up // without triggering the concurrency limiter at the parallelism that we configured Jetty // to support. initial_limit = jetty_max_thread_pool_size / 2, log_level = concurrency_limiter_log_level, ), shutdown_sleep_ms: Int = 0, http_request_header_size: Int? = 32768, http_header_cache_size: Int? = null, override_shutdown_idle_timeout: Long? = null, readiness_refresh_interval_ms: Int = 1000, readiness_max_age_ms: Int = 10000, use_virtual_threads: Boolean = false, install_default_not_found_action: Boolean = true, jetty_output_buffer_size: Int? = null, jetty_initial_session_recv_window: Int? = null, jetty_initial_stream_recv_window: Int? = null, enable_thread_pool_health_check: Boolean = false, unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null)
"},{"location":"0.x/misk/misk/misk.web/-web-config/acceptors/","title":"acceptors - Misk","text":"//misk/misk.web/WebConfig/acceptors
"},{"location":"0.x/misk/misk/misk.web/-web-config/acceptors/#acceptors","title":"acceptors","text":"[jvm]\\ val acceptors: Int? = null
Number of acceptor threads.
"},{"location":"0.x/misk/misk/misk.web/-web-config/action_exception_log_level/","title":"action_exception_log_level - Misk","text":"//misk/misk.web/WebConfig/action_exception_log_level
"},{"location":"0.x/misk/misk/misk.web/-web-config/action_exception_log_level/#action_exception_log_level","title":"action_exception_log_level","text":"[jvm]\\ val action_exception_log_level: ActionExceptionLogLevelConfig
"},{"location":"0.x/misk/misk/misk.web/-web-config/close_connection_percent/","title":"close_connection_percent - Misk","text":"//misk/misk.web/WebConfig/close_connection_percent
"},{"location":"0.x/misk/misk/misk.web/-web-config/close_connection_percent/#close_connection_percent","title":"close_connection_percent","text":"[jvm]\\ val close_connection_percent: Double = 0.0
A value in 0.0..100.0. Include \u2018Connection: close\u2019 in this percentage of responses.
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter/","title":"concurrency_limiter - Misk","text":"//misk/misk.web/WebConfig/concurrency_limiter
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter/#concurrency_limiter","title":"concurrency_limiter","text":"[jvm]\\ val concurrency_limiter: ConcurrencyLimiterConfig?
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_disabled/","title":"concurrency_limiter_disabled - Misk","text":"//misk/misk.web/WebConfig/concurrency_limiter_disabled
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_disabled/#concurrency_limiter_disabled","title":"concurrency_limiter_disabled","text":"[jvm]\\ val concurrency_limiter_disabled: Boolean = true
If true, disables automatic load shedding when degraded.
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_log_level/","title":"concurrency_limiter_log_level - Misk","text":"//misk/misk.web/WebConfig/concurrency_limiter_log_level
"},{"location":"0.x/misk/misk/misk.web/-web-config/concurrency_limiter_log_level/#concurrency_limiter_log_level","title":"concurrency_limiter_log_level","text":"[jvm]\\ val concurrency_limiter_log_level: Level
The level of log when concurrency shedding.
"},{"location":"0.x/misk/misk/misk.web/-web-config/cors/","title":"cors - Misk","text":"//misk/misk.web/WebConfig/cors
"},{"location":"0.x/misk/misk/misk.web/-web-config/cors/#cors","title":"cors","text":"[jvm]\\ val cors: Map<String, CorsConfig>
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_health_check/","title":"enable_thread_pool_health_check - Misk","text":"//misk/misk.web/WebConfig/enable_thread_pool_health_check
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_health_check/#enable_thread_pool_health_check","title":"enable_thread_pool_health_check","text":"[jvm]\\ val enable_thread_pool_health_check: Boolean = false
Wires up health checks on whether Jetty\u2019s thread pool is low on threads.
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_queue_metrics/","title":"enable_thread_pool_queue_metrics - Misk","text":"//misk/misk.web/WebConfig/enable_thread_pool_queue_metrics
"},{"location":"0.x/misk/misk/misk.web/-web-config/enable_thread_pool_queue_metrics/#enable_thread_pool_queue_metrics","title":"enable_thread_pool_queue_metrics","text":"[jvm]\\ val enable_thread_pool_queue_metrics: Boolean = false
Flag to enable thread pool queue metrics
"},{"location":"0.x/misk/misk/misk.web/-web-config/gzip/","title":"gzip - Misk","text":"//misk/misk.web/WebConfig/gzip
"},{"location":"0.x/misk/misk/misk.web/-web-config/gzip/#gzip","title":"gzip","text":"[jvm]\\ val gzip: Boolean = true
If true responses which are larger than the minGzipSize will be compressed.
"},{"location":"0.x/misk/misk/misk.web/-web-config/health_port/","title":"health_port - Misk","text":"//misk/misk.web/WebConfig/health_port
"},{"location":"0.x/misk/misk/misk.web/-web-config/health_port/#health_port","title":"health_port","text":"[jvm]\\ val health_port: Int
If >= 0, use a dedicated jetty thread pool for health checking.
A dedicated thread pool ensures that health checks are not queued or rejected when the service is saturated and queueing requests. If health checks are rejected and/or queued, the health checks may fail and k8s will kill the container, even though it might be perfectly healthy. This can cause cascading failures by sending more requests to other containers, resulting in longer queues and more health checks failures.
"},{"location":"0.x/misk/misk/misk.web/-web-config/host/","title":"host - Misk","text":"//misk/misk.web/WebConfig/host
"},{"location":"0.x/misk/misk/misk.web/-web-config/host/#host","title":"host","text":"[jvm]\\ val host: String? = null
The network interface to bind to. Null or 0.0.0.0 to bind to all interfaces.
"},{"location":"0.x/misk/misk/misk.web/-web-config/http2/","title":"http2 - Misk","text":"//misk/misk.web/WebConfig/http2
"},{"location":"0.x/misk/misk/misk.web/-web-config/http2/#http2","title":"http2","text":"[jvm]\\ val http2: Boolean = false
HTTP/2 support is currently opt-in because we can\u2019t load balance it dynamically.
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_header_cache_size/","title":"http_header_cache_size - Misk","text":"//misk/misk.web/WebConfig/http_header_cache_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_header_cache_size/#http_header_cache_size","title":"http_header_cache_size","text":"[jvm]\\ val http_header_cache_size: Int? = null
The size of Jetty\u2019s header field cache, in terms of unique character branches.
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_request_header_size/","title":"http_request_header_size - Misk","text":"//misk/misk.web/WebConfig/http_request_header_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/http_request_header_size/#http_request_header_size","title":"http_request_header_size","text":"[jvm]\\ val http_request_header_size: Int? = 32768
The maximum allowed size in bytes for the HTTP request line and HTTP request headers.
"},{"location":"0.x/misk/misk/misk.web/-web-config/idle_timeout/","title":"idle_timeout - Misk","text":"//misk/misk.web/WebConfig/idle_timeout
"},{"location":"0.x/misk/misk/misk.web/-web-config/idle_timeout/#idle_timeout","title":"idle_timeout","text":"[jvm]\\ val idle_timeout: Long = 0
If a connection is unused for this many milliseconds, it is closed. If zero, it is not closed.
"},{"location":"0.x/misk/misk/misk.web/-web-config/install_default_not_found_action/","title":"install_default_not_found_action - Misk","text":"//misk/misk.web/WebConfig/install_default_not_found_action
"},{"location":"0.x/misk/misk/misk.web/-web-config/install_default_not_found_action/#install_default_not_found_action","title":"install_default_not_found_action","text":"[jvm]\\ val install_default_not_found_action: Boolean = true
If true install NotFoundAction, the default action when a path is not found.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_session_recv_window/","title":"jetty_initial_session_recv_window - Misk","text":"//misk/misk.web/WebConfig/jetty_initial_session_recv_window
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_session_recv_window/#jetty_initial_session_recv_window","title":"jetty_initial_session_recv_window","text":"[jvm]\\ val jetty_initial_session_recv_window: Int? = null
The initial size of session\u2019s flow control receive window.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_stream_recv_window/","title":"jetty_initial_stream_recv_window - Misk","text":"//misk/misk.web/WebConfig/jetty_initial_stream_recv_window
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_initial_stream_recv_window/#jetty_initial_stream_recv_window","title":"jetty_initial_stream_recv_window","text":"[jvm]\\ val jetty_initial_stream_recv_window: Int? = null
The initial size of stream\u2019s flow control receive window.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_concurrent_streams/","title":"jetty_max_concurrent_streams - Misk","text":"//misk/misk.web/WebConfig/jetty_max_concurrent_streams
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_concurrent_streams/#jetty_max_concurrent_streams","title":"jetty_max_concurrent_streams","text":"[jvm]\\ val jetty_max_concurrent_streams: Int? = null
The maximum number of streams per HTTP/2 connection.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_queue_size/","title":"jetty_max_thread_pool_queue_size - Misk","text":"//misk/misk.web/WebConfig/jetty_max_thread_pool_queue_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_queue_size/#jetty_max_thread_pool_queue_size","title":"jetty_max_thread_pool_queue_size","text":"[jvm]\\ val jetty_max_thread_pool_queue_size: Int = 300
Maximum number of items in the queue for Jetty\u2019s thread pool.
If 0, no queueing is used and requests are directly handed off to the thread pool. If a thread is not available (i.e max threads in use) the request is rejected. Unfortunately Jetty rejects requests by closing the socket instead of returning a 429. This can lead to confusing EOFExceptions for the client.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_size/","title":"jetty_max_thread_pool_size - Misk","text":"//misk/misk.web/WebConfig/jetty_max_thread_pool_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_max_thread_pool_size/#jetty_max_thread_pool_size","title":"jetty_max_thread_pool_size","text":"[jvm]\\ val jetty_max_thread_pool_size: Int = 200
Maximum number of threads in Jetty\u2019s thread pool.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_min_thread_pool_size/","title":"jetty_min_thread_pool_size - Misk","text":"//misk/misk.web/WebConfig/jetty_min_thread_pool_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_min_thread_pool_size/#jetty_min_thread_pool_size","title":"jetty_min_thread_pool_size","text":"[jvm]\\ val jetty_min_thread_pool_size: Int = 8
Minimum number of threads in Jetty\u2019s thread pool.
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_output_buffer_size/","title":"jetty_output_buffer_size - Misk","text":"//misk/misk.web/WebConfig/jetty_output_buffer_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/jetty_output_buffer_size/#jetty_output_buffer_size","title":"jetty_output_buffer_size","text":"[jvm]\\ val jetty_output_buffer_size: Int? = null
The output buffer size of Jetty (default is 32KB).
"},{"location":"0.x/misk/misk/misk.web/-web-config/min-gzip-size/","title":"minGzipSize - Misk","text":"//misk/misk.web/WebConfig/minGzipSize
"},{"location":"0.x/misk/misk/misk.web/-web-config/min-gzip-size/#mingzipsize","title":"minGzipSize","text":"[jvm]\\ val minGzipSize: Int = 1024
The minimum size in bytes before the response body will be compressed.
"},{"location":"0.x/misk/misk/misk.web/-web-config/override_shutdown_idle_timeout/","title":"override_shutdown_idle_timeout - Misk","text":"//misk/misk.web/WebConfig/override_shutdown_idle_timeout
"},{"location":"0.x/misk/misk/misk.web/-web-config/override_shutdown_idle_timeout/#override_shutdown_idle_timeout","title":"override_shutdown_idle_timeout","text":"[jvm]\\ val override_shutdown_idle_timeout: Long? = null
The number of milliseconds a connection can be idling before commencing service shutdown. If zero, it is never closed and may cause ungraceful shutdown.
Note: There is an underlying strategy to determine the default shutdown idle timeout. Use this value only when necessary.
"},{"location":"0.x/misk/misk/misk.web/-web-config/port/","title":"port - Misk","text":"//misk/misk.web/WebConfig/port
"},{"location":"0.x/misk/misk/misk.web/-web-config/port/#port","title":"port","text":"[jvm]\\ val port: Int
HTTP port to listen on, or 0 for any available port.
"},{"location":"0.x/misk/misk/misk.web/-web-config/queue_size/","title":"queue_size - Misk","text":"//misk/misk.web/WebConfig/queue_size
"},{"location":"0.x/misk/misk/misk.web/-web-config/queue_size/#queue_size","title":"queue_size","text":"[jvm]\\ val queue_size: Int? = null
The accept backlog.
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_max_age_ms/","title":"readiness_max_age_ms - Misk","text":"//misk/misk.web/WebConfig/readiness_max_age_ms
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_max_age_ms/#readiness_max_age_ms","title":"readiness_max_age_ms","text":"[jvm]\\ val readiness_max_age_ms: Int = 10000
Maximum age of readiness status. If exceeded readiness will return an error
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_refresh_interval_ms/","title":"readiness_refresh_interval_ms - Misk","text":"//misk/misk.web/WebConfig/readiness_refresh_interval_ms
"},{"location":"0.x/misk/misk/misk.web/-web-config/readiness_refresh_interval_ms/#readiness_refresh_interval_ms","title":"readiness_refresh_interval_ms","text":"[jvm]\\ val readiness_refresh_interval_ms: Int = 1000
How often readiness will re-run its status check.
Ensure that readiness_refresh_interval_ms + \"readiness latency\" is less than readiness_max_age_ms or readiness will fail.\"
"},{"location":"0.x/misk/misk/misk.web/-web-config/selectors/","title":"selectors - Misk","text":"//misk/misk.web/WebConfig/selectors
"},{"location":"0.x/misk/misk/misk.web/-web-config/selectors/#selectors","title":"selectors","text":"[jvm]\\ val selectors: Int? = null
Number of NIO selector threads.
"},{"location":"0.x/misk/misk/misk.web/-web-config/shutdown_sleep_ms/","title":"shutdown_sleep_ms - Misk","text":"//misk/misk.web/WebConfig/shutdown_sleep_ms
"},{"location":"0.x/misk/misk/misk.web/-web-config/shutdown_sleep_ms/#shutdown_sleep_ms","title":"shutdown_sleep_ms","text":"[jvm]\\ val shutdown_sleep_ms: Int = 0
The number of milliseconds to sleep before commencing service shutdown.
"},{"location":"0.x/misk/misk/misk.web/-web-config/ssl/","title":"ssl - Misk","text":"//misk/misk.web/WebConfig/ssl
"},{"location":"0.x/misk/misk/misk.web/-web-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: WebSslConfig? = null
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_socket/","title":"unix_domain_socket - Misk","text":"//misk/misk.web/WebConfig/unix_domain_socket
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_socket/#unix_domain_socket","title":"unix_domain_socket","text":"[jvm]\\ val unix_domain_socket: WebUnixDomainSocketConfig? = null
Configuration to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (like Envoy).
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_sockets/","title":"unix_domain_sockets - Misk","text":"//misk/misk.web/WebConfig/unix_domain_sockets
"},{"location":"0.x/misk/misk/misk.web/-web-config/unix_domain_sockets/#unix_domain_sockets","title":"unix_domain_sockets","text":"[jvm]\\ val unix_domain_sockets: List<WebUnixDomainSocketConfig>? = null
Configurations to enable Jetty to listen for traffic on a unix domain socket being proxied through a sidecar (e.g. envoy, istio)
"},{"location":"0.x/misk/misk/misk.web/-web-config/use_virtual_threads/","title":"use_virtual_threads - Misk","text":"//misk/misk.web/WebConfig/use_virtual_threads
"},{"location":"0.x/misk/misk/misk.web/-web-config/use_virtual_threads/#use_virtual_threads","title":"use_virtual_threads","text":"[jvm]\\ val use_virtual_threads: Boolean = false
If possible (e.g. running on JDK 21) misk will attempt to use a virtual thread executor for jetty.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/","title":"WebSslConfig - Misk","text":"//misk/misk.web/WebSslConfig
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#websslconfig","title":"WebSslConfig","text":"[jvm]\\ data class WebSslConfig@JvmOverloadsconstructor(val port: Int, val cert_store: CertStoreConfig, val trust_store: TrustStoreConfig? = null, val mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, val cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#constructors","title":"Constructors","text":"WebSslConfig [jvm]@JvmOverloadsconstructor(port: Int, cert_store: CertStoreConfig, trust_store: TrustStoreConfig? = null, mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#types","title":"Types","text":"Name Summary CipherCompatibility [jvm]enum CipherCompatibility : Enum<WebSslConfig.CipherCompatibility> MutualAuth [jvm]enum MutualAuth : Enum<WebSslConfig.MutualAuth>"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig cipher_compatibility [jvm]val cipher_compatibility: WebSslConfig.CipherCompatibility mutual_auth [jvm]val mutual_auth: WebSslConfig.MutualAuth port [jvm]val port: IntHTTPS port to listen on, or 0 for any available port. trust_store [jvm]val trust_store: TrustStoreConfig? = null"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-web-ssl-config/","title":"WebSslConfig - Misk","text":"//misk/misk.web/WebSslConfig/WebSslConfig
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-web-ssl-config/#websslconfig","title":"WebSslConfig","text":"[jvm]\\
@JvmOverloads
constructor(port: Int, cert_store: CertStoreConfig, trust_store: TrustStoreConfig? = null, mutual_auth: WebSslConfig.MutualAuth = MutualAuth.REQUIRED, cipher_compatibility: WebSslConfig.CipherCompatibility = CipherCompatibility.MODERN)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cert_store/","title":"cert_store - Misk","text":"//misk/misk.web/WebSslConfig/cert_store
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cert_store/#cert_store","title":"cert_store","text":"[jvm]\\ val cert_store: CertStoreConfig
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cipher_compatibility/","title":"cipher_compatibility - Misk","text":"//misk/misk.web/WebSslConfig/cipher_compatibility
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/cipher_compatibility/#cipher_compatibility","title":"cipher_compatibility","text":"[jvm]\\ val cipher_compatibility: WebSslConfig.CipherCompatibility
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/mutual_auth/","title":"mutual_auth - Misk","text":"//misk/misk.web/WebSslConfig/mutual_auth
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/mutual_auth/#mutual_auth","title":"mutual_auth","text":"[jvm]\\ val mutual_auth: WebSslConfig.MutualAuth
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/port/","title":"port - Misk","text":"//misk/misk.web/WebSslConfig/port
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/port/#port","title":"port","text":"[jvm]\\ val port: Int
HTTPS port to listen on, or 0 for any available port.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/trust_store/","title":"trust_store - Misk","text":"//misk/misk.web/WebSslConfig/trust_store
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/trust_store/#trust_store","title":"trust_store","text":"[jvm]\\ val trust_store: TrustStoreConfig? = null
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/","title":"CipherCompatibility - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#ciphercompatibility","title":"CipherCompatibility","text":"[jvm]\\ enum CipherCompatibility : Enum<WebSslConfig.CipherCompatibility>
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#entries","title":"Entries","text":"COMPATIBLE [jvm]COMPATIBLEAllows the broadest set of clients, including clients that support only out-of-date SSL features. MODERN [jvm]MODERNSupports a wide set of SSL features, allowing modern clients to negotiate SSL. RESTRICTED [jvm]RESTRICTEDSupports a reduced set of SSL features, intended to meet stricter compliance requirements."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<WebSslConfig.CipherCompatibility>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): WebSslConfig.CipherCompatibilityReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<WebSslConfig.CipherCompatibility>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/entries/","title":"entries - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/entries
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<WebSslConfig.CipherCompatibility>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/","title":"valueOf - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/valueOf
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): WebSslConfig.CipherCompatibility
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/values/","title":"values - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/values
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<WebSslConfig.CipherCompatibility>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/","title":"COMPATIBLE - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/COMPATIBLE
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/#compatible","title":"COMPATIBLE","text":"[jvm]\\ COMPATIBLE
Allows the broadest set of clients, including clients that support only out-of-date SSL features.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-c-o-m-p-a-t-i-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/","title":"MODERN - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/MODERN
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/#modern","title":"MODERN","text":"[jvm]\\ MODERN
Supports a wide set of SSL features, allowing modern clients to negotiate SSL.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-m-o-d-e-r-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/","title":"RESTRICTED - Misk","text":"//misk/misk.web/WebSslConfig/CipherCompatibility/RESTRICTED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/#restricted","title":"RESTRICTED","text":"[jvm]\\ RESTRICTED
Supports a reduced set of SSL features, intended to meet stricter compliance requirements.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-cipher-compatibility/-r-e-s-t-r-i-c-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/","title":"MutualAuth - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#mutualauth","title":"MutualAuth","text":"[jvm]\\ enum MutualAuth : Enum<WebSslConfig.MutualAuth>
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#entries","title":"Entries","text":"NONE [jvm]NONE REQUIRED [jvm]REQUIRED DESIRED [jvm]DESIRED"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<WebSslConfig.MutualAuth>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): WebSslConfig.MutualAuthReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<WebSslConfig.MutualAuth>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/entries/","title":"entries - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/entries
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<WebSslConfig.MutualAuth>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/","title":"valueOf - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/valueOf
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): WebSslConfig.MutualAuth
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/values/","title":"values - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/values
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<WebSslConfig.MutualAuth>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/","title":"DESIRED - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/DESIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/#desired","title":"DESIRED","text":"[jvm]\\ DESIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-d-e-s-i-r-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/","title":"NONE - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/NONE
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/#none","title":"NONE","text":"[jvm]\\ NONE
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-n-o-n-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/","title":"REQUIRED - Misk","text":"//misk/misk.web/WebSslConfig/MutualAuth/REQUIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/#required","title":"REQUIRED","text":"[jvm]\\ REQUIRED
"},{"location":"0.x/misk/misk/misk.web/-web-ssl-config/-mutual-auth/-r-e-q-u-i-r-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/","title":"WebUnixDomainSocketConfig - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#webunixdomainsocketconfig","title":"WebUnixDomainSocketConfig","text":"[jvm]\\ data class WebUnixDomainSocketConfig@JvmOverloadsconstructor(val path: String, val h2c: Boolean? = true)
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#constructors","title":"Constructors","text":"WebUnixDomainSocketConfig [jvm]@JvmOverloadsconstructor(path: String, h2c: Boolean? = true)"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/#properties","title":"Properties","text":"Name Summary h2c [jvm]val h2c: Boolean? = trueIf true, the listener will support H2C. path [jvm]val path: StringThe Unix Domain Socket to listen on. Will attempt to use the JEP-380 connector when supported (using Java 16+ and file path)"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/-web-unix-domain-socket-config/","title":"WebUnixDomainSocketConfig - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig/WebUnixDomainSocketConfig
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/-web-unix-domain-socket-config/#webunixdomainsocketconfig","title":"WebUnixDomainSocketConfig","text":"[jvm]\\
@JvmOverloads
constructor(path: String, h2c: Boolean? = true)
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/h2c/","title":"h2c - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig/h2c
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/h2c/#h2c","title":"h2c","text":"[jvm]\\ val h2c: Boolean? = true
If true, the listener will support H2C.
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/path/","title":"path - Misk","text":"//misk/misk.web/WebUnixDomainSocketConfig/path
"},{"location":"0.x/misk/misk/misk.web/-web-unix-domain-socket-config/path/#path","title":"path","text":"[jvm]\\ val path: String
The Unix Domain Socket to listen on. Will attempt to use the JEP-380 connector when supported (using Java 16+ and file path)
"},{"location":"0.x/misk/misk/misk.web.actions/","title":"Package-level declarations - Misk","text":"//misk/misk.web.actions
"},{"location":"0.x/misk/misk/misk.web.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.actions/#types","title":"Types","text":"Name Summary InternalErrorAction [jvm]@Singletonclass InternalErrorAction@Injectconstructor : WebAction LivenessCheckAction [jvm]@Singletonclass LivenessCheckAction : WebAction NotFoundAction [jvm]@Singletonclass NotFoundAction : WebAction ReadinessCheckAction [jvm]@Singletonclass ReadinessCheckAction : WebAction StatusAction [jvm]@Singletonclass StatusAction : WebActionReturns the current status of the service for programmatic tools that want to query for the current state of the server"},{"location":"0.x/misk/misk/misk.web.actions/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain"},{"location":"0.x/misk/misk/misk.web.actions/as-chain/","title":"asChain - Misk","text":"//misk/misk.web.actions/asChain
"},{"location":"0.x/misk/misk/misk.web.actions/as-chain/#aschain","title":"asChain","text":"[jvm]\\ fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/","title":"InternalErrorAction - Misk","text":"//misk/misk.web.actions/InternalErrorAction
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#internalerroraction","title":"InternalErrorAction","text":"[jvm]\\ @Singleton
class InternalErrorAction@Injectconstructor : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#constructors","title":"Constructors","text":"InternalErrorAction [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain error [jvm]fun error(): Nothing"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/-internal-error-action/","title":"InternalErrorAction - Misk","text":"//misk/misk.web.actions/InternalErrorAction/InternalErrorAction
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/-internal-error-action/#internalerroraction","title":"InternalErrorAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/error/","title":"error - Misk","text":"//misk/misk.web.actions/InternalErrorAction/error
"},{"location":"0.x/misk/misk/misk.web.actions/-internal-error-action/error/#error","title":"error","text":"[jvm]\\ fun error(): Nothing
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/","title":"LivenessCheckAction - Misk","text":"//misk/misk.web.actions/LivenessCheckAction
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#livenesscheckaction","title":"LivenessCheckAction","text":"[jvm]\\ @Singleton
class LivenessCheckAction : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain livenessCheck [jvm]fun livenessCheck(): Response<String>"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/liveness-check/","title":"livenessCheck - Misk","text":"//misk/misk.web.actions/LivenessCheckAction/livenessCheck
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/liveness-check/#livenesscheck","title":"livenessCheck","text":"[jvm]\\ fun livenessCheck(): Response<String>
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/LivenessCheckAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-liveness-check-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/","title":"NotFoundAction - Misk","text":"//misk/misk.web.actions/NotFoundAction
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#notfoundaction","title":"NotFoundAction","text":"[jvm]\\ @Singleton
class NotFoundAction : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain notFound [jvm]fun notFound(path: String): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/not-found/","title":"notFound - Misk","text":"//misk/misk.web.actions/NotFoundAction/notFound
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/not-found/#notfound","title":"notFound","text":"[jvm]\\ fun notFound(path: String): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/NotFoundAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/#functions","title":"Functions","text":"Name Summary response [jvm]fun response(path: String): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/response/","title":"response - Misk","text":"//misk/misk.web.actions/NotFoundAction/Companion/response
"},{"location":"0.x/misk/misk/misk.web.actions/-not-found-action/-companion/response/#response","title":"response","text":"[jvm]\\ fun response(path: String): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/","title":"ReadinessCheckAction - Misk","text":"//misk/misk.web.actions/ReadinessCheckAction
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#readinesscheckaction","title":"ReadinessCheckAction","text":"[jvm]\\ @Singleton
class ReadinessCheckAction : WebAction
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain readinessCheck [jvm]fun readinessCheck(): Response<String>"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/readiness-check/","title":"readinessCheck - Misk","text":"//misk/misk.web.actions/ReadinessCheckAction/readinessCheck
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/readiness-check/#readinesscheck","title":"readinessCheck","text":"[jvm]\\ fun readinessCheck(): Response<String>
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/ReadinessCheckAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-readiness-check-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/","title":"StatusAction - Misk","text":"//misk/misk.web.actions/StatusAction
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#statusaction","title":"StatusAction","text":"[jvm]\\ @Singleton
class StatusAction : WebAction
Returns the current status of the service for programmatic tools that want to query for the current state of the server
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ServerStatus [jvm]data class ServerStatus(val serviceStatus: Map<String, Service.State>, val healthCheckStatus: Map<String, HealthStatus>)"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain getStatus [jvm]fun getStatus(): StatusAction.ServerStatus"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/get-status/","title":"getStatus - Misk","text":"//misk/misk.web.actions/StatusAction/getStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/get-status/#getstatus","title":"getStatus","text":"[jvm]\\ fun getStatus(): StatusAction.ServerStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-companion/","title":"Companion - Misk","text":"//misk/misk.web.actions/StatusAction/Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/","title":"ServerStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#serverstatus","title":"ServerStatus","text":"[jvm]\\ data class ServerStatus(val serviceStatus: Map<String, Service.State>, val healthCheckStatus: Map<String, HealthStatus>)
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#constructors","title":"Constructors","text":"ServerStatus [jvm]constructor(serviceStatus: Map<String, Service.State>, healthCheckStatus: Map<String, HealthStatus>)"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/#properties","title":"Properties","text":"Name Summary healthCheckStatus [jvm]val healthCheckStatus: Map<String, HealthStatus> serviceStatus [jvm]val serviceStatus: Map<String, Service.State>"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/-server-status/","title":"ServerStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus/ServerStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/-server-status/#serverstatus","title":"ServerStatus","text":"[jvm]\\ constructor(serviceStatus: Map<String, Service.State>, healthCheckStatus: Map<String, HealthStatus>)
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/health-check-status/","title":"healthCheckStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus/healthCheckStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/health-check-status/#healthcheckstatus","title":"healthCheckStatus","text":"[jvm]\\ val healthCheckStatus: Map<String, HealthStatus>
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/service-status/","title":"serviceStatus - Misk","text":"//misk/misk.web.actions/StatusAction/ServerStatus/serviceStatus
"},{"location":"0.x/misk/misk/misk.web.actions/-status-action/-server-status/service-status/#servicestatus","title":"serviceStatus","text":"[jvm]\\ val serviceStatus: Map<String, Service.State>
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/","title":"Package-level declarations - Misk","text":"//misk/misk.web.concurrencylimits
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.concurrencylimits/#types","title":"Types","text":"Name Summary ConcurrencyLimiterFactory [jvm]interface ConcurrencyLimiterFactoryMultibind an instance to provide a custom Limiter for concurrency shedding. The first instance to return non-null is used. ConcurrencyLimiterStrategy [jvm]enum ConcurrencyLimiterStrategy : Enum<ConcurrencyLimiterStrategy> Per the Netflix library, strategies for calculating concurrency limits based on existing traffic. For more information, please consult the documentation. ConcurrencyLimitsModule [jvm]class ConcurrencyLimitsModule(config: ConcurrencyLimiterConfig) : KAbstractModule"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/","title":"ConcurrencyLimiterFactory - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterFactory
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/#concurrencylimiterfactory","title":"ConcurrencyLimiterFactory","text":"[jvm]\\ interface ConcurrencyLimiterFactory
Multibind an instance to provide a custom Limiter for concurrency shedding. The first instance to return non-null is used.
Misk\u2019s ConcurrencyLimitsInterceptor honors the Quota-Path HTTP header to give callers control of how their calls are aggregated when computing system throughput. The create function will be called for each unique Quota-Path received from an application. If the same Quota-Path header is used on different actions, create is only called for the first action that uses the header.
//misk/misk.web.concurrencylimits/ConcurrencyLimiterFactory/create
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: Action): Limiter<String>?
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/","title":"ConcurrencyLimiterStrategy - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#concurrencylimiterstrategy","title":"ConcurrencyLimiterStrategy","text":"[jvm]\\ enum ConcurrencyLimiterStrategy : Enum<ConcurrencyLimiterStrategy>
Per the Netflix library, strategies for calculating concurrency limits based on existing traffic. For more information, please consult the documentation.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#entries","title":"Entries","text":"VEGAS [jvm]VEGASA limiter based on TCP Vegas where the limit increases by alpha if the queue_use is small (< alpha) and decreases by alpha if the queue_use is large (> beta). See documentation for more information. GRADIENT [jvm]GRADIENTConcurrency limit algorithm that adjust the limits based on the gradient of change in the samples minimum RTT and absolute minimum RTT allowing for a queue of square root of the current limit. See documentation for more information. GRADIENT2 [jvm]GRADIENT2Concurrency limit algorithm that adjusts the limit based on the gradient of change of the current average RTT and a long term exponentially smoothed average RTT. See documentation for more information. AIMD [jvm]AIMDLoss based dynamic Limit that does an additive increment as long as there are no errors and a multiplicative decrement when there is an error. See documentation for more information. SETTABLE [jvm]SETTABLELimit to be used mostly for testing where the limit can be manually adjusted. See documentation for more information. FIXED [jvm]FIXEDNon dynamic limit with fixed value. See documentation for more information."},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<ConcurrencyLimiterStrategy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): ConcurrencyLimiterStrategyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<ConcurrencyLimiterStrategy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/entries/","title":"entries - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/entries
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<ConcurrencyLimiterStrategy>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/","title":"valueOf - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/valueOf
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): ConcurrencyLimiterStrategy
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/values/","title":"values - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/values
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<ConcurrencyLimiterStrategy>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/","title":"AIMD - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/AIMD
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/#aimd","title":"AIMD","text":"[jvm]\\ AIMD
Loss based dynamic Limit that does an additive increment as long as there are no errors and a multiplicative decrement when there is an error. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-a-i-m-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/","title":"FIXED - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/FIXED
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/#fixed","title":"FIXED","text":"[jvm]\\ FIXED
Non dynamic limit with fixed value. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-f-i-x-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/","title":"GRADIENT - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/GRADIENT
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/#gradient","title":"GRADIENT","text":"[jvm]\\ GRADIENT
Concurrency limit algorithm that adjust the limits based on the gradient of change in the samples minimum RTT and absolute minimum RTT allowing for a queue of square root of the current limit. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/","title":"GRADIENT2 - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/GRADIENT2
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/#gradient2","title":"GRADIENT2","text":"[jvm]\\ GRADIENT2
Concurrency limit algorithm that adjusts the limit based on the gradient of change of the current average RTT and a long term exponentially smoothed average RTT. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-g-r-a-d-i-e-n-t2/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/","title":"SETTABLE - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/SETTABLE
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/#settable","title":"SETTABLE","text":"[jvm]\\ SETTABLE
Limit to be used mostly for testing where the limit can be manually adjusted. See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-s-e-t-t-a-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/","title":"VEGAS - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimiterStrategy/VEGAS
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/#vegas","title":"VEGAS","text":"[jvm]\\ VEGAS
A limiter based on TCP Vegas where the limit increases by alpha if the queue_use is small (< alpha) and decreases by alpha if the queue_use is large (> beta). See documentation for more information.
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limiter-strategy/-v-e-g-a-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/","title":"ConcurrencyLimitsModule - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#concurrencylimitsmodule","title":"ConcurrencyLimitsModule","text":"[jvm]\\ class ConcurrencyLimitsModule(config: ConcurrencyLimiterConfig) : KAbstractModule
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#constructors","title":"Constructors","text":"ConcurrencyLimitsModule [jvm]constructor(config: ConcurrencyLimiterConfig)"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/#functions","title":"Functions","text":"Name Summary concurrencyLimiterFactory [jvm]@ProvidesIntoSet@Singletonfun concurrencyLimiterFactory(limit: Provider<Limit>, clock: Clock): ConcurrencyLimiterFactoryThis will create the SimpleLimiter with the same Limit algorithm for each every action. This can be configured per action if needed. configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/-concurrency-limits-module/","title":"ConcurrencyLimitsModule - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule/ConcurrencyLimitsModule
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/-concurrency-limits-module/#concurrencylimitsmodule","title":"ConcurrencyLimitsModule","text":"[jvm]\\ constructor(config: ConcurrencyLimiterConfig)
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/concurrency-limiter-factory/","title":"concurrencyLimiterFactory - Misk","text":"//misk/misk.web.concurrencylimits/ConcurrencyLimitsModule/concurrencyLimiterFactory
"},{"location":"0.x/misk/misk/misk.web.concurrencylimits/-concurrency-limits-module/concurrency-limiter-factory/#concurrencylimiterfactory","title":"concurrencyLimiterFactory","text":"[jvm]\\
@ProvidesIntoSet
@Singleton
fun concurrencyLimiterFactory(limit: Provider<Limit>, clock: Clock): ConcurrencyLimiterFactory
This will create the SimpleLimiter with the same Limit algorithm for each every action. This can be configured per action if needed.
"},{"location":"0.x/misk/misk/misk.web.exceptions/","title":"Package-level declarations - Misk","text":"//misk/misk.web.exceptions
"},{"location":"0.x/misk/misk/misk.web.exceptions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.exceptions/#types","title":"Types","text":"Name Summary ActionExceptionLogLevelConfig [jvm]data class ActionExceptionLogLevelConfig@JvmOverloadsconstructor(val client_error_level: Level = Level.WARN, val server_error_level: Level = Level.ERROR) : ConfigConfigures the log Level for an ActionException. ExceptionHandlingInterceptor [jvm]class ExceptionHandlingInterceptor(actionName: String, mapperResolver: ExceptionMapperResolver) : NetworkInterceptorConverts and logs application and component level dispatch exceptions into the appropriate response format. Allows application and component code to control how exceptions are represented to clients; for example by setting the status code appropriately, or by returning a specialized response format specific to the error. Components can control how exceptions are mapped by installing ExceptionMapper via the ExceptionMapperModule ExceptionMapper [jvm]interface ExceptionMapper<in T : Throwable>Maps an exception to a Response ExceptionMapperModule [jvm]class ExceptionMapperModule<M : ExceptionMapper<T>, in T : Throwable>(exceptionClass: KClass<T>, mapperClass: KClass<M>) : KAbstractModuleBinds a Throwable to an ExceptionMapper. ExceptionMapperResolver [jvm]@Singletonclass ExceptionMapperResolver GrpcErrorResponse [jvm]data class GrpcErrorResponse@JvmOverloadsconstructor(val status: GrpcStatus, val message: String?, val details: List<AnyMessage> = listOf()) RequestBodyExceptionMapper [jvm]class RequestBodyExceptionMapper : ExceptionMapper<RequestBodyException>"},{"location":"0.x/misk/misk/misk.web.exceptions/#functions","title":"Functions","text":"Name Summary toGrpcStatus [jvm]fun toGrpcStatus(statusCode: Int): GrpcStatushttps://grpc.github.io/grpc/core/md_doc_http-grpc-status-mapping.html"},{"location":"0.x/misk/misk/misk.web.exceptions/to-grpc-status/","title":"toGrpcStatus - Misk","text":"//misk/misk.web.exceptions/toGrpcStatus
"},{"location":"0.x/misk/misk/misk.web.exceptions/to-grpc-status/#togrpcstatus","title":"toGrpcStatus","text":"[jvm]\\ fun toGrpcStatus(statusCode: Int): GrpcStatus
https://grpc.github.io/grpc/core/md_doc_http-grpc-status-mapping.html
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/","title":"ActionExceptionLogLevelConfig - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#actionexceptionloglevelconfig","title":"ActionExceptionLogLevelConfig","text":"[jvm]\\ data class ActionExceptionLogLevelConfig@JvmOverloadsconstructor(val client_error_level: Level = Level.WARN, val server_error_level: Level = Level.ERROR) : Config
Configures the log Level for an ActionException.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#constructors","title":"Constructors","text":"ActionExceptionLogLevelConfig [jvm]@JvmOverloadsconstructor(client_error_level: Level = Level.WARN, server_error_level: Level = Level.ERROR)"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/#properties","title":"Properties","text":"Name Summary client_error_level [jvm]val client_error_level: Levelthe level used for 4xx error codes server_error_level [jvm]val server_error_level: Levelthe level used for 5xx error codes"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/-action-exception-log-level-config/","title":"ActionExceptionLogLevelConfig - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/ActionExceptionLogLevelConfig
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/-action-exception-log-level-config/#actionexceptionloglevelconfig","title":"ActionExceptionLogLevelConfig","text":"[jvm]\\
@JvmOverloads
constructor(client_error_level: Level = Level.WARN, server_error_level: Level = Level.ERROR)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/client_error_level/","title":"client_error_level - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/client_error_level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/client_error_level/#client_error_level","title":"client_error_level","text":"[jvm]\\ val client_error_level: Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/server_error_level/","title":"server_error_level - Misk","text":"//misk/misk.web.exceptions/ActionExceptionLogLevelConfig/server_error_level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-action-exception-log-level-config/server_error_level/#server_error_level","title":"server_error_level","text":"[jvm]\\ val server_error_level: Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/","title":"ExceptionHandlingInterceptor - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#exceptionhandlinginterceptor","title":"ExceptionHandlingInterceptor","text":"[jvm]\\ class ExceptionHandlingInterceptor(actionName: String, mapperResolver: ExceptionMapperResolver) : NetworkInterceptor
Converts and logs application and component level dispatch exceptions into the appropriate response format. Allows application and component code to control how exceptions are represented to clients; for example by setting the status code appropriately, or by returning a specialized response format specific to the error. Components can control how exceptions are mapped by installing ExceptionMapper via the ExceptionMapperModule
TODO(isabel): Set the response body in a ThreadLocal to log in RequestLoggingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#constructors","title":"Constructors","text":"ExceptionHandlingInterceptor [jvm]constructor(actionName: String, mapperResolver: ExceptionMapperResolver)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-exception-handling-interceptor/","title":"ExceptionHandlingInterceptor - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/ExceptionHandlingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-exception-handling-interceptor/#exceptionhandlinginterceptor","title":"ExceptionHandlingInterceptor","text":"[jvm]\\ constructor(actionName: String, mapperResolver: ExceptionMapperResolver)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): ExceptionHandlingInterceptor"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.exceptions/ExceptionHandlingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-handling-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): ExceptionHandlingInterceptor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/","title":"ExceptionMapper - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#exceptionmapper","title":"ExceptionMapper","text":"interface ExceptionMapper<in T : Throwable>
Maps an exception to a Response
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#inheritors","title":"Inheritors","text":"RequestBodyExceptionMapper"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open fun loggingLevel(th: T): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: T): GrpcErrorResponse? toResponse [jvm]abstract fun toResponse(th: T): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper/loggingLevel
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"[jvm]\\ open fun loggingLevel(th: T): Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/logging-level/#return","title":"Return","text":"the level at which the given exception should be logged. defaults to ERROR but can be overridden by the mapper for the given exception
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-grpc-response/","title":"toGrpcResponse - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper/toGrpcResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-grpc-response/#togrpcresponse","title":"toGrpcResponse","text":"[jvm]\\ open fun toGrpcResponse(th: T): GrpcErrorResponse?
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk/misk.web.exceptions/ExceptionMapper/toResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ abstract fun toResponse(th: T): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper/to-response/#return","title":"Return","text":"the Response corresponding to the exception.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/","title":"ExceptionMapperModule - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#exceptionmappermodule","title":"ExceptionMapperModule","text":"[jvm]\\ class ExceptionMapperModule<M : ExceptionMapper<T>, in T : Throwable>(exceptionClass: KClass<T>, mapperClass: KClass<M>) : KAbstractModule
Binds a Throwable to an ExceptionMapper.
When an Exception occurs dispatching an Action, the bound ExceptionMapper is called to handle the Exception. If there is not an explicit binding for the thrown Exception, the mapper for the closest superclass is used.
Given the example code
install(ExceptionMapperModule.create<ActionException, ActionExceptionMapper>())\ninstall(ExceptionMapperModule.create<MyActionException, MyActionExceptionMapper>())\n\nclass MyActionException : ActionException {}\nclass MyOtherActionException : ActionException {}\nMyActionException maps to the specific MyActionExceptionMapper and MyOtherActionException maps to the ActionExceptionMapper since uses the binding of the closest bound superclass.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#constructors","title":"Constructors","text":"ExceptionMapperModule [jvm]constructor(exceptionClass: KClass<T>, mapperClass: KClass<M>)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-exception-mapper-module/","title":"ExceptionMapperModule - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule/ExceptionMapperModule
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-exception-mapper-module/#exceptionmappermodule","title":"ExceptionMapperModule","text":"[jvm]\\ constructor(exceptionClass: KClass<T>, mapperClass: KClass<M>)
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/","title":"Companion - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule/Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Throwable, M : ExceptionMapper<T>> create(): ExceptionMapperModule<M, T>"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/create/","title":"create - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperModule/Companion/create
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Throwable, M : ExceptionMapper<T>> create(): ExceptionMapperModule<M, T>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/","title":"ExceptionMapperResolver - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperResolver
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/#exceptionmapperresolver","title":"ExceptionMapperResolver","text":"[jvm]\\ @Singleton
class ExceptionMapperResolver
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/#functions","title":"Functions","text":"Name Summary mapperFor [jvm]fun mapperFor(th: Throwable): ExceptionMapper<Throwable>?"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/mapper-for/","title":"mapperFor - Misk","text":"//misk/misk.web.exceptions/ExceptionMapperResolver/mapperFor
"},{"location":"0.x/misk/misk/misk.web.exceptions/-exception-mapper-resolver/mapper-for/#mapperfor","title":"mapperFor","text":"[jvm]\\ fun mapperFor(th: Throwable): ExceptionMapper<Throwable>?
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/","title":"GrpcErrorResponse - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#grpcerrorresponse","title":"GrpcErrorResponse","text":"[jvm]\\ data class GrpcErrorResponse@JvmOverloadsconstructor(val status: GrpcStatus, val message: String?, val details: List<AnyMessage> = listOf())
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#constructors","title":"Constructors","text":"GrpcErrorResponse [jvm]@JvmOverloadsconstructor(status: GrpcStatus, message: String?, details: List<AnyMessage> = listOf())"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#properties","title":"Properties","text":"Name Summary details [jvm]val details: List<AnyMessage> message [jvm]val message: String? status [jvm]val status: GrpcStatus"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/#functions","title":"Functions","text":"Name Summary copy [jvm]@JvmOverloadsfun copy(status: GrpcStatus = this.status, message: String? = this.message): GrpcErrorResponse"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-grpc-error-response/","title":"GrpcErrorResponse - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-grpc-error-response/#grpcerrorresponse","title":"GrpcErrorResponse","text":"[jvm]\\
@JvmOverloads
constructor(status: GrpcStatus, message: String?, details: List<AnyMessage> = listOf())
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/copy/","title":"copy - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/copy
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/copy/#copy","title":"copy","text":"[jvm]\\
@JvmOverloads
fun copy(status: GrpcStatus = this.status, message: String? = this.message): GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/details/","title":"details - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/details
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/details/#details","title":"details","text":"[jvm]\\ val details: List<AnyMessage>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/message/","title":"message - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/message
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/message/#message","title":"message","text":"[jvm]\\ val message: String?
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/status/","title":"status - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/status
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/status/#status","title":"status","text":"[jvm]\\ val status: GrpcStatus
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/","title":"Companion - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/#properties","title":"Properties","text":"Name Summary INTERNAL_SERVER_ERROR [jvm]val INTERNAL_SERVER_ERROR: GrpcErrorResponse"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/-i-n-t-e-r-n-a-l_-s-e-r-v-e-r_-e-r-r-o-r/","title":"INTERNAL_SERVER_ERROR - Misk","text":"//misk/misk.web.exceptions/GrpcErrorResponse/Companion/INTERNAL_SERVER_ERROR
"},{"location":"0.x/misk/misk/misk.web.exceptions/-grpc-error-response/-companion/-i-n-t-e-r-n-a-l_-s-e-r-v-e-r_-e-r-r-o-r/#internal_server_error","title":"INTERNAL_SERVER_ERROR","text":"[jvm]\\ val INTERNAL_SERVER_ERROR: GrpcErrorResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/","title":"RequestBodyExceptionMapper - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#requestbodyexceptionmapper","title":"RequestBodyExceptionMapper","text":"[jvm]\\ class RequestBodyExceptionMapper : ExceptionMapper<RequestBodyException>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open override fun loggingLevel(th: RequestBodyException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: RequestBodyException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: RequestBodyException): Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/loggingLevel
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"[jvm]\\ open override fun loggingLevel(th: RequestBodyException): Level
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/logging-level/#return","title":"Return","text":"the level at which the given exception should be logged. defaults to ERROR but can be overridden by the mapper for the given exception
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/toResponse
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ open override fun toResponse(th: RequestBodyException): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/to-response/#return","title":"Return","text":"the Response corresponding to the exception.
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/","title":"Companion - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/#properties","title":"Properties","text":"Name Summary CLIENT_CLOSED_REQUEST [jvm]val CLIENT_CLOSED_REQUEST: Response<ResponseBody>"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/-c-l-i-e-n-t_-c-l-o-s-e-d_-r-e-q-u-e-s-t/","title":"CLIENT_CLOSED_REQUEST - Misk","text":"//misk/misk.web.exceptions/RequestBodyExceptionMapper/Companion/CLIENT_CLOSED_REQUEST
"},{"location":"0.x/misk/misk/misk.web.exceptions/-request-body-exception-mapper/-companion/-c-l-i-e-n-t_-c-l-o-s-e-d_-r-e-q-u-e-s-t/#client_closed_request","title":"CLIENT_CLOSED_REQUEST","text":"[jvm]\\ val CLIENT_CLOSED_REQUEST: Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.extractors/","title":"Package-level declarations - Misk","text":"//misk/misk.web.extractors
"},{"location":"0.x/misk/misk/misk.web.extractors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.extractors/#types","title":"Types","text":"Name Summary RequestBodyException [jvm]class RequestBodyException(cause: Throwable) : IOException StringConverter [jvm]typealias StringConverter = (String) -> Any?"},{"location":"0.x/misk/misk/misk.web.extractors/#functions","title":"Functions","text":"Name Summary converterFor [jvm]fun converterFor(type: KType): StringConverter?"},{"location":"0.x/misk/misk/misk.web.extractors/converter-for/","title":"converterFor - Misk","text":"//misk/misk.web.extractors/converterFor
"},{"location":"0.x/misk/misk/misk.web.extractors/converter-for/#converterfor","title":"converterFor","text":"[jvm]\\ fun converterFor(type: KType): StringConverter?
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/","title":"RequestBodyException - Misk","text":"//misk/misk.web.extractors/RequestBodyException
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#requestbodyexception","title":"RequestBodyException","text":"[jvm]\\ class RequestBodyException(cause: Throwable) : IOException
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#constructors","title":"Constructors","text":"RequestBodyException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/-request-body-exception/","title":"RequestBodyException - Misk","text":"//misk/misk.web.extractors/RequestBodyException/RequestBodyException
"},{"location":"0.x/misk/misk/misk.web.extractors/-request-body-exception/-request-body-exception/#requestbodyexception","title":"RequestBodyException","text":"[jvm]\\ constructor(cause: Throwable)
"},{"location":"0.x/misk/misk/misk.web.extractors/-string-converter/","title":"StringConverter - Misk","text":"//misk/misk.web.extractors/StringConverter
"},{"location":"0.x/misk/misk/misk.web.extractors/-string-converter/#stringconverter","title":"StringConverter","text":"[jvm]\\ typealias StringConverter = (String) -> Any?
"},{"location":"0.x/misk/misk/misk.web.formatter/","title":"Package-level declarations - Misk","text":"//misk/misk.web.formatter
"},{"location":"0.x/misk/misk/misk.web.formatter/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.formatter/#types","title":"Types","text":"Name Summary ClassNameFormatter [jvm]class ClassNameFormatter@Injectconstructor"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/","title":"ClassNameFormatter - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#classnameformatter","title":"ClassNameFormatter","text":"[jvm]\\ class ClassNameFormatter@Injectconstructor
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#constructors","title":"Constructors","text":"ClassNameFormatter [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-class-name-formatter/","title":"ClassNameFormatter - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter/ClassNameFormatter
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-class-name-formatter/#classnameformatter","title":"ClassNameFormatter","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/","title":"Companion - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter/Companion
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/#functions","title":"Functions","text":"Name Summary format [jvm]fun <T : Any> format(kclass: KClass<T>): String"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/format/","title":"format - Misk","text":"//misk/misk.web.formatter/ClassNameFormatter/Companion/format
"},{"location":"0.x/misk/misk/misk.web.formatter/-class-name-formatter/-companion/format/#format","title":"format","text":"[jvm]\\ fun <T : Any> format(kclass: KClass<T>): String
"},{"location":"0.x/misk/misk/misk.web.interceptors/","title":"Package-level declarations - Misk","text":"//misk/misk.web.interceptors
"},{"location":"0.x/misk/misk/misk.web.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.interceptors/#types","title":"Types","text":"Name Summary ActionLoggingConfig [jvm]data class ActionLoggingConfig@JvmOverloadsconstructor(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: List<String> = listOf(), val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)This class should have all the same config options as LogRequestResponse. See that class for details. BeforeContentEncoding [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])annotation class BeforeContentEncodingDenotes a target to be in the first order of execution before any content decoding happens. A NetworkInterceptor bound with BeforeContentEncoding is automatically installed before interceptors annotated with ForContentEncoding. InternalErrorInterceptorFactory [jvm]@Singletonclass InternalErrorInterceptorFactory@Injectconstructor : NetworkInterceptor.Factory LogRateLimiter [jvm]@Singletonclass LogRateLimiter@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)Holds rate limiters for logging success and error responses. There is a rate limiter for every action and service that calls it, for both success and error. The rate limiters are created according to the value set in LogRequestResponse annotation. MiskConcurrencyLimiterFeature [jvm]interface MiskConcurrencyLimiterFeatureInterface for a Feature flag that can dynamically enable/disable the concurrency limiter RebalancingInterceptor [jvm]class RebalancingInterceptor@Injectconstructor(random: ThreadLocalRandom, probability: Double) : NetworkInterceptorWhen we\u2019re deploying and redeploying our pods, we want to make sure that clients rebalance onto the new pods. This randomly closes connections so they will be recreated, naturally balancing connections across pods. RequestBodyLoggingInterceptor [jvm]class RequestBodyLoggingInterceptor : ApplicationInterceptorStores request and response information for an action in a ThreadLocal, to be logged in RequestLoggingInterceptor RequestLoggingConfig [jvm]data class RequestLoggingConfig(val actions: Map<String, ActionLoggingConfig>)A set of per-action logging config overrides. RequestLoggingInterceptor [jvm]class RequestLoggingInterceptor : NetworkInterceptorLogs request and response information for an action. Timing information doesn\u2019t count time writing the response to the remote client. RequestLoggingTransformer [jvm]interface RequestLoggingTransformerTransforms request and/or response bodies before they get logged by RequestLoggingInterceptor. Useful for things like stripping out noisy data. RequestResponseBody [jvm]data class RequestResponseBody@JvmOverloadsconstructor(val request: Any?, val response: Any?, val requestHeaders: Any? = null, val responseHeaders: Any? = null) ResponseBodyMarshallerFactory [jvm]@Singletonclass ResponseBodyMarshallerFactory WideOpenDevelopmentInterceptor [jvm]class WideOpenDevelopmentInterceptor@Injectconstructor : NetworkInterceptor WideOpenDevelopmentInterceptorFactory [jvm]class WideOpenDevelopmentInterceptorFactory@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment) : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/#functions","title":"Functions","text":"Name Summary tryTransform [jvm]fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?"},{"location":"0.x/misk/misk/misk.web.interceptors/try-transform/","title":"tryTransform - Misk","text":"//misk/misk.web.interceptors/tryTransform
"},{"location":"0.x/misk/misk/misk.web.interceptors/try-transform/#trytransform","title":"tryTransform","text":"[jvm]\\ fun RequestLoggingTransformer.tryTransform(requestResponseBody: RequestResponseBody?): RequestResponseBody?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/","title":"ActionLoggingConfig - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#actionloggingconfig","title":"ActionLoggingConfig","text":"[jvm]\\ data class ActionLoggingConfig@JvmOverloadsconstructor(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: List<String> = listOf(), val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)
This class should have all the same config options as LogRequestResponse. See that class for details.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#constructors","title":"Constructors","text":"ActionLoggingConfig [jvm]@JvmOverloadsconstructor(ratePerSecond: Long = 10, errorRatePerSecond: Long = 0, bodySampling: Double = 0.0, errorBodySampling: Double = 0.0, excludedEnvironments: List<String> = listOf(), requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/#properties","title":"Properties","text":"Name Summary bodySampling [jvm]val bodySampling: Double = 0.0 errorBodySampling [jvm]val errorBodySampling: Double = 0.0 errorRatePerSecond [jvm]val errorRatePerSecond: Long = 0 excludedEnvironments [jvm]val excludedEnvironments: List<String> ratePerSecond [jvm]val ratePerSecond: Long = 10 requestLoggingMode [jvm]val requestLoggingMode: RequestLoggingMode"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-action-logging-config/","title":"ActionLoggingConfig - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-action-logging-config/#actionloggingconfig","title":"ActionLoggingConfig","text":"[jvm]\\
@JvmOverloads
constructor(ratePerSecond: Long = 10, errorRatePerSecond: Long = 0, bodySampling: Double = 0.0, errorBodySampling: Double = 0.0, excludedEnvironments: List<String> = listOf(), requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/body-sampling/","title":"bodySampling - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/bodySampling
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/body-sampling/#bodysampling","title":"bodySampling","text":"[jvm]\\ val bodySampling: Double = 0.0
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-body-sampling/","title":"errorBodySampling - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/errorBodySampling
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-body-sampling/#errorbodysampling","title":"errorBodySampling","text":"[jvm]\\ val errorBodySampling: Double = 0.0
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-rate-per-second/","title":"errorRatePerSecond - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/errorRatePerSecond
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/error-rate-per-second/#errorratepersecond","title":"errorRatePerSecond","text":"[jvm]\\ val errorRatePerSecond: Long = 0
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/excluded-environments/","title":"excludedEnvironments - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/excludedEnvironments
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/excluded-environments/#excludedenvironments","title":"excludedEnvironments","text":"[jvm]\\ val excludedEnvironments: List<String>
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/rate-per-second/","title":"ratePerSecond - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/ratePerSecond
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/rate-per-second/#ratepersecond","title":"ratePerSecond","text":"[jvm]\\ val ratePerSecond: Long = 10
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/request-logging-mode/","title":"requestLoggingMode - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/requestLoggingMode
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/request-logging-mode/#requestloggingmode","title":"requestLoggingMode","text":"[jvm]\\ val requestLoggingMode: RequestLoggingMode
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/","title":"Companion - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/Companion
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/#functions","title":"Functions","text":"Name Summary fromAnnotation [jvm]fun fromAnnotation(logRequestResponse: LogRequestResponse): ActionLoggingConfig fromConfigMapOrAnnotation [jvm]fun fromConfigMapOrAnnotation(action: Action, configs: Set<RequestLoggingConfig>, annotation: LogRequestResponse): ActionLoggingConfig"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-annotation/","title":"fromAnnotation - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/Companion/fromAnnotation
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-annotation/#fromannotation","title":"fromAnnotation","text":"[jvm]\\ fun fromAnnotation(logRequestResponse: LogRequestResponse): ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-config-map-or-annotation/","title":"fromConfigMapOrAnnotation - Misk","text":"//misk/misk.web.interceptors/ActionLoggingConfig/Companion/fromConfigMapOrAnnotation
"},{"location":"0.x/misk/misk/misk.web.interceptors/-action-logging-config/-companion/from-config-map-or-annotation/#fromconfigmaporannotation","title":"fromConfigMapOrAnnotation","text":"[jvm]\\ fun fromConfigMapOrAnnotation(action: Action, configs: Set<RequestLoggingConfig>, annotation: LogRequestResponse): ActionLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-before-content-encoding/","title":"BeforeContentEncoding - Misk","text":"//misk/misk.web.interceptors/BeforeContentEncoding
"},{"location":"0.x/misk/misk/misk.web.interceptors/-before-content-encoding/#beforecontentencoding","title":"BeforeContentEncoding","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD, AnnotationTarget.TYPE])
annotation class BeforeContentEncoding
Denotes a target to be in the first order of execution before any content decoding happens. A NetworkInterceptor bound with BeforeContentEncoding is automatically installed before interceptors annotated with ForContentEncoding.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/","title":"InternalErrorInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/InternalErrorInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#internalerrorinterceptorfactory","title":"InternalErrorInterceptorFactory","text":"[jvm]\\ @Singleton
class InternalErrorInterceptorFactory@Injectconstructor : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#constructors","title":"Constructors","text":"InternalErrorInterceptorFactory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/-internal-error-interceptor-factory/","title":"InternalErrorInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/InternalErrorInterceptorFactory/InternalErrorInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/-internal-error-interceptor-factory/#internalerrorinterceptorfactory","title":"InternalErrorInterceptorFactory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/InternalErrorInterceptorFactory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-internal-error-interceptor-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/","title":"LogRateLimiter - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#logratelimiter","title":"LogRateLimiter","text":"[jvm]\\ @Singleton
class LogRateLimiter@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)
Holds rate limiters for logging success and error responses. There is a rate limiter for every action and service that calls it, for both success and error. The rate limiters are created according to the value set in LogRequestResponse annotation.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#constructors","title":"Constructors","text":"LogRateLimiter [jvm]@Injectconstructor(rateLimiterFactory: RateLimiter.Factory)"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#types","title":"Types","text":"Name Summary LogBucketId [jvm]data class LogBucketId(val actionClass: String, val isError: Boolean) : Comparable<LogRateLimiter.LogBucketId>"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/#functions","title":"Functions","text":"Name Summary tryAcquire [jvm]fun tryAcquire(bucketId: LogRateLimiter.LogBucketId, ratePerSecond: Long): Boolean"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-rate-limiter/","title":"LogRateLimiter - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogRateLimiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-rate-limiter/#logratelimiter","title":"LogRateLimiter","text":"[jvm]\\
@Inject
constructor(rateLimiterFactory: RateLimiter.Factory)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/tryAcquire
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"[jvm]\\ fun tryAcquire(bucketId: LogRateLimiter.LogBucketId, ratePerSecond: Long): Boolean
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/","title":"LogBucketId - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#logbucketid","title":"LogBucketId","text":"[jvm]\\ data class LogBucketId(val actionClass: String, val isError: Boolean) : Comparable<LogRateLimiter.LogBucketId>
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#constructors","title":"Constructors","text":"LogBucketId [jvm]constructor(actionClass: String, isError: Boolean)"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: StringActionClass from which we can grab the LogRequestResponse isError [jvm]val isError: BooleanIf the response code is error, we look up the errorRateLimiter"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: LogRateLimiter.LogBucketId): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/-log-bucket-id/","title":"LogBucketId - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/LogBucketId
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/-log-bucket-id/#logbucketid","title":"LogBucketId","text":"[jvm]\\ constructor(actionClass: String, isError: Boolean)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/action-class/","title":"actionClass - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/actionClass
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/action-class/#actionclass","title":"actionClass","text":"[jvm]\\ val actionClass: String
ActionClass from which we can grab the LogRequestResponse
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/compare-to/","title":"compareTo - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/compareTo
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: LogRateLimiter.LogBucketId): Int
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/is-error/","title":"isError - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/isError
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/is-error/#iserror","title":"isError","text":"[jvm]\\ val isError: Boolean
If the response code is error, we look up the errorRateLimiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/to-string/","title":"toString - Misk","text":"//misk/misk.web.interceptors/LogRateLimiter/LogBucketId/toString
"},{"location":"0.x/misk/misk/misk.web.interceptors/-log-rate-limiter/-log-bucket-id/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/","title":"MiskConcurrencyLimiterFeature - Misk","text":"//misk/misk.web.interceptors/MiskConcurrencyLimiterFeature
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/#miskconcurrencylimiterfeature","title":"MiskConcurrencyLimiterFeature","text":"[jvm]\\ interface MiskConcurrencyLimiterFeature
Interface for a Feature flag that can dynamically enable/disable the concurrency limiter
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/#functions","title":"Functions","text":"Name Summary enabled [jvm]abstract fun enabled(): Boolean"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/enabled/","title":"enabled - Misk","text":"//misk/misk.web.interceptors/MiskConcurrencyLimiterFeature/enabled
"},{"location":"0.x/misk/misk/misk.web.interceptors/-misk-concurrency-limiter-feature/enabled/#enabled","title":"enabled","text":"[jvm]\\ abstract fun enabled(): Boolean
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/","title":"RebalancingInterceptor - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#rebalancinginterceptor","title":"RebalancingInterceptor","text":"[jvm]\\ class RebalancingInterceptor@Injectconstructor(random: ThreadLocalRandom, probability: Double) : NetworkInterceptor
When we\u2019re deploying and redeploying our pods, we want to make sure that clients rebalance onto the new pods. This randomly closes connections so they will be recreated, naturally balancing connections across pods.
This does not close Unix domain socket connections. This interceptor is intended to mitigate imbalanced load from long-lived client connections maintained from client apps. Connections over UDS are oriented towards service mesh sidecars that employ sufficient client-side load balancing.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#constructors","title":"Constructors","text":"RebalancingInterceptor [jvm]@Injectconstructor(random: ThreadLocalRandom, probability: Double)"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-rebalancing-interceptor/","title":"RebalancingInterceptor - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/RebalancingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-rebalancing-interceptor/#rebalancinginterceptor","title":"RebalancingInterceptor","text":"[jvm]\\
@Inject
constructor(random: ThreadLocalRandom, probability: Double)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/RebalancingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-rebalancing-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/","title":"RequestBodyLoggingInterceptor - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#requestbodylogginginterceptor","title":"RequestBodyLoggingInterceptor","text":"[jvm]\\ class RequestBodyLoggingInterceptor : ApplicationInterceptor
Stores request and response information for an action in a ThreadLocal, to be logged in RequestLoggingInterceptor
Timing information doesn\u2019t count time writing the response to the remote client.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : ApplicationInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Chain): Any"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Chain): Any
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : ApplicationInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): ApplicationInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/RequestBodyLoggingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-body-logging-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): ApplicationInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/","title":"RequestLoggingConfig - Misk","text":"//misk/misk.web.interceptors/RequestLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#requestloggingconfig","title":"RequestLoggingConfig","text":"[jvm]\\ data class RequestLoggingConfig(val actions: Map<String, ActionLoggingConfig>)
A set of per-action logging config overrides.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#constructors","title":"Constructors","text":"RequestLoggingConfig [jvm]constructor(actions: Map<String, ActionLoggingConfig>)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/#properties","title":"Properties","text":"Name Summary actions [jvm]val actions: Map<String, ActionLoggingConfig>"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/-request-logging-config/","title":"RequestLoggingConfig - Misk","text":"//misk/misk.web.interceptors/RequestLoggingConfig/RequestLoggingConfig
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/-request-logging-config/#requestloggingconfig","title":"RequestLoggingConfig","text":"[jvm]\\ constructor(actions: Map<String, ActionLoggingConfig>)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/actions/","title":"actions - Misk","text":"//misk/misk.web.interceptors/RequestLoggingConfig/actions
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-config/actions/#actions","title":"actions","text":"[jvm]\\ val actions: Map<String, ActionLoggingConfig>
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/","title":"RequestLoggingInterceptor - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#requestlogginginterceptor","title":"RequestLoggingInterceptor","text":"[jvm]\\ class RequestLoggingInterceptor : NetworkInterceptor
Logs request and response information for an action. Timing information doesn\u2019t count time writing the response to the remote client.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : NetworkInterceptor.Factory"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain) maybeLog [jvm]fun maybeLog(httpCall: HttpCall, stopwatch: Stopwatch, error: Throwable?)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/maybe-log/","title":"maybeLog - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/maybeLog
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/maybe-log/#maybelog","title":"maybeLog","text":"[jvm]\\ fun maybeLog(httpCall: HttpCall, stopwatch: Stopwatch, error: Throwable?)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/","title":"Factory - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/RequestLoggingInterceptor/Factory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/","title":"RequestLoggingTransformer - Misk","text":"//misk/misk.web.interceptors/RequestLoggingTransformer
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/#requestloggingtransformer","title":"RequestLoggingTransformer","text":"[jvm]\\ interface RequestLoggingTransformer
Transforms request and/or response bodies before they get logged by RequestLoggingInterceptor. Useful for things like stripping out noisy data.
Note that the order in which RequestLoggingTransformers get applied is considered undefined and cannot be reliably controlled.
//misk/misk.web.interceptors/RequestLoggingTransformer/transform
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-logging-transformer/transform/#transform","title":"transform","text":"[jvm]\\ abstract fun transform(requestResponseBody: RequestResponseBody?): RequestResponseBody?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/","title":"RequestResponseBody - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#requestresponsebody","title":"RequestResponseBody","text":"[jvm]\\ data class RequestResponseBody@JvmOverloadsconstructor(val request: Any?, val response: Any?, val requestHeaders: Any? = null, val responseHeaders: Any? = null)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#constructors","title":"Constructors","text":"RequestResponseBody [jvm]@JvmOverloadsconstructor(request: Any?, response: Any?, requestHeaders: Any? = null, responseHeaders: Any? = null)"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/#properties","title":"Properties","text":"Name Summary request [jvm]val request: Any? requestHeaders [jvm]val requestHeaders: Any? = null response [jvm]val response: Any? responseHeaders [jvm]val responseHeaders: Any? = null"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/-request-response-body/","title":"RequestResponseBody - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/RequestResponseBody
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/-request-response-body/#requestresponsebody","title":"RequestResponseBody","text":"[jvm]\\
@JvmOverloads
constructor(request: Any?, response: Any?, requestHeaders: Any? = null, responseHeaders: Any? = null)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request-headers/","title":"requestHeaders - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/requestHeaders
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request-headers/#requestheaders","title":"requestHeaders","text":"[jvm]\\ val requestHeaders: Any? = null
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request/","title":"request - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/request
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/request/#request","title":"request","text":"[jvm]\\ val request: Any?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response-headers/","title":"responseHeaders - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/responseHeaders
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response-headers/#responseheaders","title":"responseHeaders","text":"[jvm]\\ val responseHeaders: Any? = null
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response/","title":"response - Misk","text":"//misk/misk.web.interceptors/RequestResponseBody/response
"},{"location":"0.x/misk/misk/misk.web.interceptors/-request-response-body/response/#response","title":"response","text":"[jvm]\\ val response: Any?
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/","title":"ResponseBodyMarshallerFactory - Misk","text":"//misk/misk.web.interceptors/ResponseBodyMarshallerFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/#responsebodymarshallerfactory","title":"ResponseBodyMarshallerFactory","text":"[jvm]\\ @Singleton
class ResponseBodyMarshallerFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(action: Action): Marshaller<Any>Returns a marshaller for action, or null if it has no response to marshal."},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/ResponseBodyMarshallerFactory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-response-body-marshaller-factory/create/#create","title":"create","text":"[jvm]\\ fun create(action: Action): Marshaller<Any>
Returns a marshaller for action, or null if it has no response to marshal.
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/","title":"WideOpenDevelopmentInterceptor - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#wideopendevelopmentinterceptor","title":"WideOpenDevelopmentInterceptor","text":"[jvm]\\ class WideOpenDevelopmentInterceptor@Injectconstructor : NetworkInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#constructors","title":"Constructors","text":"WideOpenDevelopmentInterceptor [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/-wide-open-development-interceptor/","title":"WideOpenDevelopmentInterceptor - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor/WideOpenDevelopmentInterceptor
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/-wide-open-development-interceptor/#wideopendevelopmentinterceptor","title":"WideOpenDevelopmentInterceptor","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/intercept/","title":"intercept - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptor/intercept
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/","title":"WideOpenDevelopmentInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#wideopendevelopmentinterceptorfactory","title":"WideOpenDevelopmentInterceptorFactory","text":"[jvm]\\ class WideOpenDevelopmentInterceptorFactory@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment) : NetworkInterceptor.Factory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#constructors","title":"Constructors","text":"WideOpenDevelopmentInterceptorFactory [jvm]@Injectconstructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment)"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/-wide-open-development-interceptor-factory/","title":"WideOpenDevelopmentInterceptorFactory - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory/WideOpenDevelopmentInterceptorFactory
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/-wide-open-development-interceptor-factory/#wideopendevelopmentinterceptorfactory","title":"WideOpenDevelopmentInterceptorFactory","text":"[jvm]\\
@Inject
constructor(wideOpenDevelopmentInterceptor: WideOpenDevelopmentInterceptor, deployment: Deployment)
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/create/","title":"create - Misk","text":"//misk/misk.web.interceptors/WideOpenDevelopmentInterceptorFactory/create
"},{"location":"0.x/misk/misk/misk.web.interceptors/-wide-open-development-interceptor-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk/misk/misk.web.jetty/","title":"Package-level declarations - Misk","text":"//misk/misk.web.jetty
"},{"location":"0.x/misk/misk/misk.web.jetty/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.jetty/#types","title":"Types","text":"Name Summary JettyService [jvm]@Singletonclass JettyService : AbstractIdleService MeasuredQueuedThreadPool [jvm]class MeasuredQueuedThreadPool(threadPool: QueuedThreadPool) : MeasuredThreadPoolA MeasuredThreadPool for a QueuedThreadPool MeasuredThreadPool [jvm]interface MeasuredThreadPoolA common interface that can emit metrics about a thread pool. MeasuredThreadPoolExecutor [jvm]class MeasuredThreadPoolExecutor(threadPool: ThreadPoolExecutor) : MeasuredThreadPoolA MeasuredThreadPool for a ThreadPoolExecutor ThreadPoolQueueMetrics [jvm]@Singletonclass ThreadPoolQueueMetrics"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/","title":"JettyService - Misk","text":"//misk/misk.web.jetty/JettyService
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#jettyservice","title":"JettyService","text":"[jvm]\\ @Singleton
class JettyService : AbstractIdleService
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#properties","title":"Properties","text":"Name Summary healthServerUrl [jvm]val healthServerUrl: HttpUrl? httpServerUrl [jvm]val httpServerUrl: HttpUrl httpsServerUrl [jvm]val httpsServerUrl: HttpUrl?"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/health-server-url/","title":"healthServerUrl - Misk","text":"//misk/misk.web.jetty/JettyService/healthServerUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/health-server-url/#healthserverurl","title":"healthServerUrl","text":"[jvm]\\ val healthServerUrl: HttpUrl?
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/http-server-url/","title":"httpServerUrl - Misk","text":"//misk/misk.web.jetty/JettyService/httpServerUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/http-server-url/#httpserverurl","title":"httpServerUrl","text":"[jvm]\\ val httpServerUrl: HttpUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/https-server-url/","title":"httpsServerUrl - Misk","text":"//misk/misk.web.jetty/JettyService/httpsServerUrl
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/https-server-url/#httpsserverurl","title":"httpsServerUrl","text":"[jvm]\\ val httpsServerUrl: HttpUrl?
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/-companion/","title":"Companion - Misk","text":"//misk/misk.web.jetty/JettyService/Companion
"},{"location":"0.x/misk/misk/misk.web.jetty/-jetty-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/","title":"MeasuredQueuedThreadPool - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#measuredqueuedthreadpool","title":"MeasuredQueuedThreadPool","text":"[jvm]\\ class MeasuredQueuedThreadPool(threadPool: QueuedThreadPool) : MeasuredThreadPool
A MeasuredThreadPool for a QueuedThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#constructors","title":"Constructors","text":"MeasuredQueuedThreadPool [jvm]constructor(threadPool: QueuedThreadPool)"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/#functions","title":"Functions","text":"Name Summary activeCount [jvm]open override fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]open override fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]open override fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]open override fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/-measured-queued-thread-pool/","title":"MeasuredQueuedThreadPool - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/MeasuredQueuedThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/-measured-queued-thread-pool/#measuredqueuedthreadpool","title":"MeasuredQueuedThreadPool","text":"[jvm]\\ constructor(threadPool: QueuedThreadPool)
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/active-count/","title":"activeCount - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/activeCount
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/active-count/#activecount","title":"activeCount","text":"[jvm]\\ open override fun activeCount(): Int
The number of active threads.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/max-pool-size/","title":"maxPoolSize - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/maxPoolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"[jvm]\\ open override fun maxPoolSize(): Int
The maximum size the pool can grow to.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/pool-size/","title":"poolSize - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/poolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/pool-size/#poolsize","title":"poolSize","text":"[jvm]\\ open override fun poolSize(): Int
The current size of the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/queue-size/","title":"queueSize - Misk","text":"//misk/misk.web.jetty/MeasuredQueuedThreadPool/queueSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-queued-thread-pool/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ open override fun queueSize(): Int
The current number of tasks in the queue waiting to be processed by the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/","title":"MeasuredThreadPool - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#measuredthreadpool","title":"MeasuredThreadPool","text":"interface MeasuredThreadPool
A common interface that can emit metrics about a thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#inheritors","title":"Inheritors","text":"MeasuredQueuedThreadPool MeasuredThreadPoolExecutor"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/#functions","title":"Functions","text":"Name Summary activeCount [jvm]abstract fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]abstract fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]abstract fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]abstract fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/active-count/","title":"activeCount - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/activeCount
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/active-count/#activecount","title":"activeCount","text":"[jvm]\\ abstract fun activeCount(): Int
The number of active threads.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/max-pool-size/","title":"maxPoolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/maxPoolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"[jvm]\\ abstract fun maxPoolSize(): Int
The maximum size the pool can grow to.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/pool-size/","title":"poolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/poolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/pool-size/#poolsize","title":"poolSize","text":"[jvm]\\ abstract fun poolSize(): Int
The current size of the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/queue-size/","title":"queueSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPool/queueSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ abstract fun queueSize(): Int
The current number of tasks in the queue waiting to be processed by the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/","title":"MeasuredThreadPoolExecutor - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#measuredthreadpoolexecutor","title":"MeasuredThreadPoolExecutor","text":"[jvm]\\ class MeasuredThreadPoolExecutor(threadPool: ThreadPoolExecutor) : MeasuredThreadPool
A MeasuredThreadPool for a ThreadPoolExecutor
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#constructors","title":"Constructors","text":"MeasuredThreadPoolExecutor [jvm]constructor(threadPool: ThreadPoolExecutor)"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/#functions","title":"Functions","text":"Name Summary activeCount [jvm]open override fun activeCount(): IntThe number of active threads. maxPoolSize [jvm]open override fun maxPoolSize(): IntThe maximum size the pool can grow to. poolSize [jvm]open override fun poolSize(): IntThe current size of the thread pool. queueSize [jvm]open override fun queueSize(): IntThe current number of tasks in the queue waiting to be processed by the thread pool."},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/-measured-thread-pool-executor/","title":"MeasuredThreadPoolExecutor - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/MeasuredThreadPoolExecutor
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/-measured-thread-pool-executor/#measuredthreadpoolexecutor","title":"MeasuredThreadPoolExecutor","text":"[jvm]\\ constructor(threadPool: ThreadPoolExecutor)
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/active-count/","title":"activeCount - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/activeCount
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/active-count/#activecount","title":"activeCount","text":"[jvm]\\ open override fun activeCount(): Int
The number of active threads.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/max-pool-size/","title":"maxPoolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/maxPoolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/max-pool-size/#maxpoolsize","title":"maxPoolSize","text":"[jvm]\\ open override fun maxPoolSize(): Int
The maximum size the pool can grow to.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/pool-size/","title":"poolSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/poolSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/pool-size/#poolsize","title":"poolSize","text":"[jvm]\\ open override fun poolSize(): Int
The current size of the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/queue-size/","title":"queueSize - Misk","text":"//misk/misk.web.jetty/MeasuredThreadPoolExecutor/queueSize
"},{"location":"0.x/misk/misk/misk.web.jetty/-measured-thread-pool-executor/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ open override fun queueSize(): Int
The current number of tasks in the queue waiting to be processed by the thread pool.
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/","title":"ThreadPoolQueueMetrics - Misk","text":"//misk/misk.web.jetty/ThreadPoolQueueMetrics
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/#threadpoolqueuemetrics","title":"ThreadPoolQueueMetrics","text":"[jvm]\\ @Singleton
class ThreadPoolQueueMetrics
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/#functions","title":"Functions","text":"Name Summary recordQueueLatency [jvm]fun recordQueueLatency(latency: Duration)"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/record-queue-latency/","title":"recordQueueLatency - Misk","text":"//misk/misk.web.jetty/ThreadPoolQueueMetrics/recordQueueLatency
"},{"location":"0.x/misk/misk/misk.web.jetty/-thread-pool-queue-metrics/record-queue-latency/#recordqueuelatency","title":"recordQueueLatency","text":"[jvm]\\ fun recordQueueLatency(latency: Duration)
"},{"location":"0.x/misk/misk/misk.web.marshal/","title":"Package-level declarations - Misk","text":"//misk/misk.web.marshal
"},{"location":"0.x/misk/misk/misk.web.marshal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.marshal/#types","title":"Types","text":"Name Summary GenericMarshallers [jvm]object GenericMarshallersHandles generic marshalling, for cases where the action doesn\u2019t explicitly specify return content GenericUnmarshallers [jvm]object GenericUnmarshallersHandles generic unmarshalling, for cases where the action can accept anything JsonMarshaller [jvm]class JsonMarshaller<T>(val adapter: JsonAdapter<T>) : Marshaller<T> JsonUnmarshaller [jvm]class JsonUnmarshaller(val adapter: JsonAdapter<Any>) : Unmarshaller Marshaller [jvm]interface Marshaller<in T>Marshalls typed kotlin objects into a ResponseBody MultipartUnmarshaller [jvm]object MultipartUnmarshaller : Unmarshaller PlainTextMarshaller [jvm]object PlainTextMarshaller : Marshaller<Any> PlainTextUnmarshaller [jvm]object PlainTextUnmarshaller ProtobufMarshaller [jvm]class ProtobufMarshaller<T>(val adapter: ProtoAdapter<T>) : Marshaller<T> ProtobufUnmarshaller [jvm]class ProtobufUnmarshaller(val adapter: ProtoAdapter<Any>) : Unmarshaller Unmarshaller [jvm]interface UnmarshallerUnmarshalls a typed object from an incoming source"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/","title":"GenericMarshallers - Misk","text":"//misk/misk.web.marshal/GenericMarshallers
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#genericmarshallers","title":"GenericMarshallers","text":"[jvm]\\ object GenericMarshallers
Handles generic marshalling, for cases where the action doesn\u2019t explicitly specify return content
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#types","title":"Types","text":"Name Summary FromByteString [jvm]class FromByteString(contentType: MediaType?) : Marshaller<ByteString> ToNothing [jvm]class ToNothing(contentType: MediaType?) : Marshaller<Nothing> ToUnit [jvm]class ToUnit(contentType: MediaType?) : Marshaller<Unit>"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/#functions","title":"Functions","text":"Name Summary canHandle [jvm]fun canHandle(type: Type): Booleanfun canHandle(type: KType): Boolean from [jvm]fun from(contentType: MediaType?, returnType: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/can-handle/","title":"canHandle - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/canHandle
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/can-handle/#canhandle","title":"canHandle","text":"[jvm]\\ fun canHandle(type: KType): Boolean
fun canHandle(type: Type): Boolean
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/from/","title":"from - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/from
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/from/#from","title":"from","text":"[jvm]\\ fun from(contentType: MediaType?, returnType: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/","title":"FromByteString - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#frombytestring","title":"FromByteString","text":"[jvm]\\ class FromByteString(contentType: MediaType?) : Marshaller<ByteString>
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#constructors","title":"Constructors","text":"FromByteString [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: ByteString): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/-from-byte-string/","title":"FromByteString - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString/FromByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/-from-byte-string/#frombytestring","title":"FromByteString","text":"[jvm]\\ constructor(contentType: MediaType?)
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/FromByteString/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: ByteString): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-from-byte-string/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/","title":"ToNothing - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#tonothing","title":"ToNothing","text":"[jvm]\\ class ToNothing(contentType: MediaType?) : Marshaller<Nothing>
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#constructors","title":"Constructors","text":"ToNothing [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: Nothing): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/-to-nothing/","title":"ToNothing - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing/ToNothing
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/-to-nothing/#tonothing","title":"ToNothing","text":"[jvm]\\ constructor(contentType: MediaType?)
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToNothing/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: Nothing): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-nothing/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/","title":"ToUnit - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#tounit","title":"ToUnit","text":"[jvm]\\ class ToUnit(contentType: MediaType?) : Marshaller<Unit>
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#constructors","title":"Constructors","text":"ToUnit [jvm]constructor(contentType: MediaType?)"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType? responseBody [jvm]open override fun responseBody(o: Unit): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/-to-unit/","title":"ToUnit - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit/ToUnit
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/-to-unit/#tounit","title":"ToUnit","text":"[jvm]\\ constructor(contentType: MediaType?)
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/GenericMarshallers/ToUnit/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: Unit): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-marshallers/-to-unit/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/","title":"GenericUnmarshallers - Misk","text":"//misk/misk.web.marshal/GenericUnmarshallers
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/#genericunmarshallers","title":"GenericUnmarshallers","text":"[jvm]\\ object GenericUnmarshallers
Handles generic unmarshalling, for cases where the action can accept anything
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/#functions","title":"Functions","text":"Name Summary canHandle [jvm]fun canHandle(type: Type): Booleanfun canHandle(type: KType): Boolean into [jvm]fun into(parameter: KParameter): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/can-handle/","title":"canHandle - Misk","text":"//misk/misk.web.marshal/GenericUnmarshallers/canHandle
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/can-handle/#canhandle","title":"canHandle","text":"[jvm]\\ fun canHandle(type: KType): Boolean
fun canHandle(type: Type): Boolean
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/into/","title":"into - Misk","text":"//misk/misk.web.marshal/GenericUnmarshallers/into
"},{"location":"0.x/misk/misk/misk.web.marshal/-generic-unmarshallers/into/#into","title":"into","text":"[jvm]\\ fun into(parameter: KParameter): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/","title":"JsonMarshaller - Misk","text":"//misk/misk.web.marshal/JsonMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#jsonmarshaller","title":"JsonMarshaller","text":"[jvm]\\ class JsonMarshaller<T>(val adapter: JsonAdapter<T>) : Marshaller<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#constructors","title":"Constructors","text":"JsonMarshaller [jvm]constructor(adapter: JsonAdapter<T>)"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: JsonAdapter<T>"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-json-marshaller/","title":"JsonMarshaller - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/JsonMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-json-marshaller/#jsonmarshaller","title":"JsonMarshaller","text":"[jvm]\\ constructor(adapter: JsonAdapter<T>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: JsonAdapter<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: T): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : Marshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/moshi/","title":"moshi - Misk","text":"//misk/misk.web.marshal/JsonMarshaller/Factory/moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-marshaller/-factory/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/","title":"JsonUnmarshaller - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#jsonunmarshaller","title":"JsonUnmarshaller","text":"[jvm]\\ class JsonUnmarshaller(val adapter: JsonAdapter<Any>) : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#constructors","title":"Constructors","text":"JsonUnmarshaller [jvm]constructor(adapter: JsonAdapter<Any>)"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: JsonAdapter<Any>"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-json-unmarshaller/","title":"JsonUnmarshaller - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/JsonUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-json-unmarshaller/#jsonunmarshaller","title":"JsonUnmarshaller","text":"[jvm]\\ constructor(adapter: JsonAdapter<Any>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: JsonAdapter<Any>
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/moshi/","title":"moshi - Misk","text":"//misk/misk.web.marshal/JsonUnmarshaller/Factory/moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-json-unmarshaller/-factory/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/","title":"Marshaller - Misk","text":"//misk/misk.web.marshal/Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#marshaller","title":"Marshaller","text":"interface Marshaller<in T>
Marshalls typed kotlin objects into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#inheritors","title":"Inheritors","text":"FromByteString ToNothing ToUnit JsonMarshaller PlainTextMarshaller ProtobufMarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]abstract fun contentType(): MediaType? responseBody [jvm]abstract fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/Marshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ abstract fun contentType(): MediaType?
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/Marshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ abstract fun responseBody(o: T): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/","title":"Companion - Misk","text":"//misk/misk.web.marshal/Marshaller/Companion
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/#functions","title":"Functions","text":"Name Summary actualResponseType [jvm]fun actualResponseType(type: KType): Type"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/actual-response-type/","title":"actualResponseType - Misk","text":"//misk/misk.web.marshal/Marshaller/Companion/actualResponseType
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-companion/actual-response-type/#actualresponsetype","title":"actualResponseType","text":"[jvm]\\ fun actualResponseType(type: KType): Type
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/Marshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/#factory","title":"Factory","text":"interface Factory
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<Marshaller.Factory>().to<MyFactory>()\n//misk/misk.web.marshal/Marshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/","title":"MultipartUnmarshaller - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#multipartunmarshaller","title":"MultipartUnmarshaller","text":"[jvm]\\ object MultipartUnmarshaller : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): MultipartReader"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): MultipartReader
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: Moshi"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/moshi/","title":"moshi - Misk","text":"//misk/misk.web.marshal/MultipartUnmarshaller/Factory/moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-multipart-unmarshaller/-factory/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/","title":"PlainTextMarshaller - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#plaintextmarshaller","title":"PlainTextMarshaller","text":"[jvm]\\ object PlainTextMarshaller : Marshaller<Any>
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: Any): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: Any): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor : Marshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/PlainTextMarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/","title":"PlainTextUnmarshaller - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/#plaintextunmarshaller","title":"PlainTextUnmarshaller","text":"[jvm]\\ object PlainTextUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor : Unmarshaller.Factory ToByteString [jvm]object ToByteString : Unmarshaller ToString [jvm]object ToString : Unmarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory@Injectconstructor : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/","title":"ToByteString - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/#tobytestring","title":"ToByteString","text":"[jvm]\\ object ToByteString : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): ByteString"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToByteString/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-byte-string/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): ByteString
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/","title":"ToString - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToString
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/#tostring","title":"ToString","text":"[jvm]\\ object ToString : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): String"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/PlainTextUnmarshaller/ToString/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-plain-text-unmarshaller/-to-string/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): String
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/","title":"ProtobufMarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#protobufmarshaller","title":"ProtobufMarshaller","text":"[jvm]\\ class ProtobufMarshaller<T>(val adapter: ProtoAdapter<T>) : Marshaller<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#constructors","title":"Constructors","text":"ProtobufMarshaller [jvm]constructor(adapter: ProtoAdapter<T>)"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Marshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: ProtoAdapter<T>"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/#functions","title":"Functions","text":"Name Summary contentType [jvm]open override fun contentType(): MediaType responseBody [jvm]open override fun responseBody(o: T): ResponseBody"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-protobuf-marshaller/","title":"ProtobufMarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/ProtobufMarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-protobuf-marshaller/#protobufmarshaller","title":"ProtobufMarshaller","text":"[jvm]\\ constructor(adapter: ProtoAdapter<T>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: ProtoAdapter<T>
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/","title":"contentType - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/contentType
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/#contenttype","title":"contentType","text":"[jvm]\\ open override fun contentType(): MediaType
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/content-type/#return","title":"Return","text":"the media type of the marshalled content, if known to the Marshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/","title":"responseBody - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/responseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ open override fun responseBody(o: T): ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/response-body/#return","title":"Return","text":"The object marshalled into a ResponseBody
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor : Marshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/ProtobufMarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-marshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Marshaller<Any>?
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/","title":"ProtobufUnmarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#protobufunmarshaller","title":"ProtobufUnmarshaller","text":"[jvm]\\ class ProtobufUnmarshaller(val adapter: ProtoAdapter<Any>) : Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#constructors","title":"Constructors","text":"ProtobufUnmarshaller [jvm]constructor(adapter: ProtoAdapter<Any>)"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor : Unmarshaller.Factory"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#properties","title":"Properties","text":"Name Summary adapter [jvm]val adapter: ProtoAdapter<Any>"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-protobuf-unmarshaller/","title":"ProtobufUnmarshaller - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/ProtobufUnmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-protobuf-unmarshaller/#protobufunmarshaller","title":"ProtobufUnmarshaller","text":"[jvm]\\ constructor(adapter: ProtoAdapter<Any>)
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/adapter/","title":"adapter - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/adapter
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/adapter/#adapter","title":"adapter","text":"[jvm]\\ val adapter: ProtoAdapter<Any>
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ open override fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor : Unmarshaller.Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(mediaType: MediaType, type: KType): Unmarshaller?"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/Factory/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/create/","title":"create - Misk","text":"//misk/misk.web.marshal/ProtobufUnmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-protobuf-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/","title":"Unmarshaller - Misk","text":"//misk/misk.web.marshal/Unmarshaller
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#unmarshaller","title":"Unmarshaller","text":"interface Unmarshaller
Unmarshalls a typed object from an incoming source
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#inheritors","title":"Inheritors","text":"JsonUnmarshaller MultipartUnmarshaller ToString ToByteString ProtobufUnmarshaller"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/#functions","title":"Functions","text":"Name Summary unmarshal [jvm]abstract fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/unmarshal/","title":"unmarshal - Misk","text":"//misk/misk.web.marshal/Unmarshaller/unmarshal
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/unmarshal/#unmarshal","title":"unmarshal","text":"[jvm]\\ abstract fun unmarshal(requestHeaders: Headers, source: BufferedSource): Any?
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/","title":"Factory - Misk","text":"//misk/misk.web.marshal/Unmarshaller/Factory
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/#factory","title":"Factory","text":"interface Factory
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<Unmarshaller.Factory>().to<MyFactory>()\n//misk/misk.web.marshal/Unmarshaller/Factory/create
"},{"location":"0.x/misk/misk/misk.web.marshal/-unmarshaller/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(mediaType: MediaType, type: KType): Unmarshaller?
"},{"location":"0.x/misk/misk/misk.web.mdc/","title":"Package-level declarations - Misk","text":"//misk/misk.web.mdc
"},{"location":"0.x/misk/misk/misk.web.mdc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.mdc/#types","title":"Types","text":"Name Summary LogContextProvider [jvm]interface LogContextProvider"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/","title":"LogContextProvider - Misk","text":"//misk/misk.web.mdc/LogContextProvider
"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/#logcontextprovider","title":"LogContextProvider","text":"[jvm]\\ interface LogContextProvider
"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(request: HttpServletRequest): String?"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/get/","title":"get - Misk","text":"//misk/misk.web.mdc/LogContextProvider/get
"},{"location":"0.x/misk/misk/misk.web.mdc/-log-context-provider/get/#get","title":"get","text":"[jvm]\\ abstract fun get(request: HttpServletRequest): String?
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/","title":"Package-level declarations - Misk","text":"//misk/misk.web.metadata.guice
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.metadata.guice/#types","title":"Types","text":"Name Summary GuiceMetadata [jvm]data class GuiceMetadata(val guice: GuiceMetadataProvider.Metadata) : Metadata GuiceMetadataProvider [jvm]class GuiceMetadataProvider@Injectconstructor : MetadataProvider<GuiceMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/","title":"GuiceMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#guicemetadata","title":"GuiceMetadata","text":"[jvm]\\ data class GuiceMetadata(val guice: GuiceMetadataProvider.Metadata) : Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#constructors","title":"Constructors","text":"GuiceMetadata [jvm]constructor(guice: GuiceMetadataProvider.Metadata)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String guice [jvm]val guice: GuiceMetadataProvider.Metadata metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/-guice-metadata/","title":"GuiceMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadata/GuiceMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/-guice-metadata/#guicemetadata","title":"GuiceMetadata","text":"[jvm]\\ constructor(guice: GuiceMetadataProvider.Metadata)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/guice/","title":"guice - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadata/guice
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata/guice/#guice","title":"guice","text":"[jvm]\\ val guice: GuiceMetadataProvider.Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/","title":"GuiceMetadataProvider - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#guicemetadataprovider","title":"GuiceMetadataProvider","text":"[jvm]\\ class GuiceMetadataProvider@Injectconstructor : MetadataProvider<GuiceMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#constructors","title":"Constructors","text":"GuiceMetadataProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#types","title":"Types","text":"Name Summary BindingMetadata [jvm]data class BindingMetadata(val type: String, val source: String, val scope: String?, val provider: String, val annotation: String?) Metadata [jvm]data class Metadata(val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#properties","title":"Properties","text":"Name Summary allBindings [jvm]val allBindings: MutableMap<Key<>, Binding<>> id [jvm]open override val id: String injector [jvm]@Injectlateinit var injector: Injector"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): GuiceMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-guice-metadata-provider/","title":"GuiceMetadataProvider - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/GuiceMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-guice-metadata-provider/#guicemetadataprovider","title":"GuiceMetadataProvider","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/all-bindings/","title":"allBindings - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/allBindings
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/all-bindings/#allbindings","title":"allBindings","text":"[jvm]\\ val allBindings: MutableMap<Key<>, Binding<>>
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/get/","title":"get - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/get
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): GuiceMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/id/","title":"id - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/id
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/id/#id","title":"id","text":"[jvm]\\ open override val id: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/injector/","title":"injector - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/injector
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/injector/#injector","title":"injector","text":"[jvm]\\
@Inject
lateinit var injector: Injector
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/","title":"BindingMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#bindingmetadata","title":"BindingMetadata","text":"[jvm]\\ data class BindingMetadata(val type: String, val source: String, val scope: String?, val provider: String, val annotation: String?)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#constructors","title":"Constructors","text":"BindingMetadata [jvm]constructor(type: String, source: String, scope: String?, provider: String, annotation: String?)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#properties","title":"Properties","text":"Name Summary annotation [jvm]val annotation: String? provider [jvm]val provider: String scope [jvm]val scope: String? source [jvm]val source: String type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/-binding-metadata/","title":"BindingMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/BindingMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/-binding-metadata/#bindingmetadata","title":"BindingMetadata","text":"[jvm]\\ constructor(type: String, source: String, scope: String?, provider: String, annotation: String?)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/annotation/","title":"annotation - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/annotation
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/provider/","title":"provider - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/provider
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/provider/#provider","title":"provider","text":"[jvm]\\ val provider: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/scope/","title":"scope - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/scope
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/scope/#scope","title":"scope","text":"[jvm]\\ val scope: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/source/","title":"source - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/source
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/source/#source","title":"source","text":"[jvm]\\ val source: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/to-string/","title":"toString - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/toString
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type/","title":"type - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/BindingMetadata/type
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-binding-metadata/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/","title":"Metadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#metadata","title":"Metadata","text":"[jvm]\\ data class Metadata(val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#constructors","title":"Constructors","text":"Metadata [jvm]constructor(bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/#properties","title":"Properties","text":"Name Summary bindingMetadata [jvm]val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/-metadata/","title":"Metadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata/Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/-metadata/#metadata","title":"Metadata","text":"[jvm]\\ constructor(bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/binding-metadata/","title":"bindingMetadata - Misk","text":"//misk/misk.web.metadata.guice/GuiceMetadataProvider/Metadata/bindingMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.guice/-guice-metadata-provider/-metadata/binding-metadata/#bindingmetadata","title":"bindingMetadata","text":"[jvm]\\ val bindingMetadata: Set<GuiceMetadataProvider.BindingMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/","title":"Package-level declarations - Misk","text":"//misk/misk.web.metadata.webaction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.metadata.webaction/#types","title":"Types","text":"Name Summary WebActionMetadata [jvm]data class WebActionMetadata(val name: String, val function: String, val packageName: String?, val description: String?, val functionAnnotations: List<String>, val requestMediaTypes: List<String>, val responseMediaType: String?, val parameterTypes: List<String>, val parameters: List<WebActionMetadata.ParameterMetaData>, val requestType: String?, val returnType: String, val responseType: String, val types: Map<String, MiskWebFormBuilder.Type>, val responseTypes: Map<String, MiskWebFormBuilder.Type>, val returnTypes: Map<String, MiskWebFormBuilder.Type>, val pathPattern: String, val applicationInterceptors: List<String>, val networkInterceptors: List<String>, val httpMethod: String, val allowedServices: Set<String>, val allowedCapabilities: Set<String>)Metadata front end model for Web Action Misk-Web Tab WebActionMetadataAction [jvm]@Singletonclass WebActionMetadataAction@Injectconstructor : WebAction WebActionsMetadata [jvm]data class WebActionsMetadata(val webActions: List<WebActionMetadata>) : Metadata WebActionsMetadataProvider [jvm]@Singletonclass WebActionsMetadataProvider : MetadataProvider<WebActionsMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/","title":"WebActionMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#webactionmetadata","title":"WebActionMetadata","text":"[jvm]\\ data class WebActionMetadata(val name: String, val function: String, val packageName: String?, val description: String?, val functionAnnotations: List<String>, val requestMediaTypes: List<String>, val responseMediaType: String?, val parameterTypes: List<String>, val parameters: List<WebActionMetadata.ParameterMetaData>, val requestType: String?, val returnType: String, val responseType: String, val types: Map<String, MiskWebFormBuilder.Type>, val responseTypes: Map<String, MiskWebFormBuilder.Type>, val returnTypes: Map<String, MiskWebFormBuilder.Type>, val pathPattern: String, val applicationInterceptors: List<String>, val networkInterceptors: List<String>, val httpMethod: String, val allowedServices: Set<String>, val allowedCapabilities: Set<String>)
Metadata front end model for Web Action Misk-Web Tab
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#constructors","title":"Constructors","text":"WebActionMetadata [jvm]constructor(name: String, function: KFunction<*>, functionAnnotations: List<Annotation>, description: String?, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameterTypes: List<KType>, parameters: List<KParameter>, requestType: KType?, returnType: KType, responseType: KType?, pathPattern: PathPattern, applicationInterceptors: List<ApplicationInterceptor>, networkInterceptors: List<NetworkInterceptor>, dispatchMechanism: DispatchMechanism, allowedServices: Set<String>, allowedCapabilities: Set<String>)constructor(name: String, function: String, packageName: String?, description: String?, functionAnnotations: List<String>, requestMediaTypes: List<String>, responseMediaType: String?, parameterTypes: List<String>, parameters: List<WebActionMetadata.ParameterMetaData>, requestType: String?, returnType: String, responseType: String, types: Map<String, MiskWebFormBuilder.Type>, responseTypes: Map<String, MiskWebFormBuilder.Type>, returnTypes: Map<String, MiskWebFormBuilder.Type>, pathPattern: String, applicationInterceptors: List<String>, networkInterceptors: List<String>, httpMethod: String, allowedServices: Set<String>, allowedCapabilities: Set<String>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#types","title":"Types","text":"Name Summary ParameterMetaData [jvm]data class ParameterMetaData(val name: String?, val annotations: List<String>, val type: String)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/#properties","title":"Properties","text":"Name Summary allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String> applicationInterceptors [jvm]val applicationInterceptors: List<String> description [jvm]val description: String? function [jvm]val function: String functionAnnotations [jvm]val functionAnnotations: List<String> httpMethod [jvm]val httpMethod: String name [jvm]val name: String networkInterceptors [jvm]val networkInterceptors: List<String> packageName [jvm]val packageName: String? parameters [jvm]val parameters: List<WebActionMetadata.ParameterMetaData> parameterTypes [jvm]val parameterTypes: List<String> pathPattern [jvm]val pathPattern: String requestMediaTypes [jvm]val requestMediaTypes: List<String> requestType [jvm]val requestType: String? responseMediaType [jvm]val responseMediaType: String? responseType [jvm]val responseType: String responseTypes [jvm]val responseTypes: Map<String, MiskWebFormBuilder.Type> returnType [jvm]val returnType: String returnTypes [jvm]val returnTypes: Map<String, MiskWebFormBuilder.Type> types [jvm]val types: Map<String, MiskWebFormBuilder.Type>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-web-action-metadata/","title":"WebActionMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/WebActionMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-web-action-metadata/#webactionmetadata","title":"WebActionMetadata","text":"[jvm]\\ constructor(name: String, function: KFunction<*>, functionAnnotations: List<Annotation>, description: String?, acceptedMediaRanges: List<MediaRange>, responseContentType: MediaType?, parameterTypes: List<KType>, parameters: List<KParameter>, requestType: KType?, returnType: KType, responseType: KType?, pathPattern: PathPattern, applicationInterceptors: List<ApplicationInterceptor>, networkInterceptors: List<NetworkInterceptor>, dispatchMechanism: DispatchMechanism, allowedServices: Set<String>, allowedCapabilities: Set<String>)
constructor(name: String, function: String, packageName: String?, description: String?, functionAnnotations: List<String>, requestMediaTypes: List<String>, responseMediaType: String?, parameterTypes: List<String>, parameters: List<WebActionMetadata.ParameterMetaData>, requestType: String?, returnType: String, responseType: String, types: Map<String, MiskWebFormBuilder.Type>, responseTypes: Map<String, MiskWebFormBuilder.Type>, returnTypes: Map<String, MiskWebFormBuilder.Type>, pathPattern: String, applicationInterceptors: List<String>, networkInterceptors: List<String>, httpMethod: String, allowedServices: Set<String>, allowedCapabilities: Set<String>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/allowedCapabilities
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"[jvm]\\ val allowedCapabilities: Set<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-services/","title":"allowedServices - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/allowedServices
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/allowed-services/#allowedservices","title":"allowedServices","text":"[jvm]\\ val allowedServices: Set<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/application-interceptors/","title":"applicationInterceptors - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/applicationInterceptors
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/application-interceptors/#applicationinterceptors","title":"applicationInterceptors","text":"[jvm]\\ val applicationInterceptors: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/description/","title":"description - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/description
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/description/#description","title":"description","text":"[jvm]\\ val description: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function-annotations/","title":"functionAnnotations - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/functionAnnotations
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function-annotations/#functionannotations","title":"functionAnnotations","text":"[jvm]\\ val functionAnnotations: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function/","title":"function - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/function
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/function/#function","title":"function","text":"[jvm]\\ val function: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/http-method/","title":"httpMethod - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/httpMethod
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/http-method/#httpmethod","title":"httpMethod","text":"[jvm]\\ val httpMethod: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/name/","title":"name - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/name
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/network-interceptors/","title":"networkInterceptors - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/networkInterceptors
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/network-interceptors/#networkinterceptors","title":"networkInterceptors","text":"[jvm]\\ val networkInterceptors: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/package-name/","title":"packageName - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/packageName
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/package-name/#packagename","title":"packageName","text":"[jvm]\\ val packageName: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameter-types/","title":"parameterTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/parameterTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameter-types/#parametertypes","title":"parameterTypes","text":"[jvm]\\ val parameterTypes: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameters/","title":"parameters - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/parameters
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/parameters/#parameters","title":"parameters","text":"[jvm]\\ val parameters: List<WebActionMetadata.ParameterMetaData>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/path-pattern/","title":"pathPattern - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/pathPattern
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-media-types/","title":"requestMediaTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/requestMediaTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-media-types/#requestmediatypes","title":"requestMediaTypes","text":"[jvm]\\ val requestMediaTypes: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-type/","title":"requestType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/requestType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/request-type/#requesttype","title":"requestType","text":"[jvm]\\ val requestType: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-media-type/","title":"responseMediaType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/responseMediaType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-media-type/#responsemediatype","title":"responseMediaType","text":"[jvm]\\ val responseMediaType: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-type/","title":"responseType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/responseType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-type/#responsetype","title":"responseType","text":"[jvm]\\ val responseType: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-types/","title":"responseTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/responseTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/response-types/#responsetypes","title":"responseTypes","text":"[jvm]\\ val responseTypes: Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-type/","title":"returnType - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/returnType
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-type/#returntype","title":"returnType","text":"[jvm]\\ val returnType: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-types/","title":"returnTypes - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/returnTypes
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/return-types/#returntypes","title":"returnTypes","text":"[jvm]\\ val returnTypes: Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/types/","title":"types - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/types
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/types/#types","title":"types","text":"[jvm]\\ val types: Map<String, MiskWebFormBuilder.Type>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/","title":"ParameterMetaData - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#parametermetadata","title":"ParameterMetaData","text":"[jvm]\\ data class ParameterMetaData(val name: String?, val annotations: List<String>, val type: String)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#constructors","title":"Constructors","text":"ParameterMetaData [jvm]constructor(name: String?, annotations: List<String>, type: String)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/#properties","title":"Properties","text":"Name Summary annotations [jvm]val annotations: List<String> name [jvm]val name: String? type [jvm]val type: String"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/-parameter-meta-data/","title":"ParameterMetaData - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/ParameterMetaData
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/-parameter-meta-data/#parametermetadata","title":"ParameterMetaData","text":"[jvm]\\ constructor(name: String?, annotations: List<String>, type: String)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/annotations/","title":"annotations - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/annotations
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/annotations/#annotations","title":"annotations","text":"[jvm]\\ val annotations: List<String>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/name/","title":"name - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/name
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/name/#name","title":"name","text":"[jvm]\\ val name: String?
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/type/","title":"type - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadata/ParameterMetaData/type
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata/-parameter-meta-data/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/","title":"WebActionMetadataAction - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#webactionmetadataaction","title":"WebActionMetadataAction","text":"[jvm]\\ @Singleton
class WebActionMetadataAction@Injectconstructor : WebAction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#constructors","title":"Constructors","text":"WebActionMetadataAction [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#types","title":"Types","text":"Name Summary Response [jvm]data class Response(val webActionMetadata: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/#functions","title":"Functions","text":"Name Summary asChain [jvm]fun WebAction.asChain(function: KFunction<*>, args: List<Any?>, interceptors: List<ApplicationInterceptor>, httpCall: HttpCall): Chain getAll [jvm]fun getAll(): WebActionMetadataAction.Response"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-web-action-metadata-action/","title":"WebActionMetadataAction - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/WebActionMetadataAction
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-web-action-metadata-action/#webactionmetadataaction","title":"WebActionMetadataAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/get-all/","title":"getAll - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/getAll
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(): WebActionMetadataAction.Response
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/","title":"Response - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val webActionMetadata: List<WebActionMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(webActionMetadata: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/#properties","title":"Properties","text":"Name Summary webActionMetadata [jvm]val webActionMetadata: List<WebActionMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response/Response
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(webActionMetadata: List<WebActionMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/web-action-metadata/","title":"webActionMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionMetadataAction/Response/webActionMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-action-metadata-action/-response/web-action-metadata/#webactionmetadata","title":"webActionMetadata","text":"[jvm]\\ val webActionMetadata: List<WebActionMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/","title":"WebActionsMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#webactionsmetadata","title":"WebActionsMetadata","text":"[jvm]\\ data class WebActionsMetadata(val webActions: List<WebActionMetadata>) : Metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#constructors","title":"Constructors","text":"WebActionsMetadata [jvm]constructor(webActions: List<WebActionMetadata>)"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: String metadata [jvm]val metadata: Any prettyPrint [jvm]val prettyPrint: String webActions [jvm]val webActions: List<WebActionMetadata>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<> descriptionBlock [jvm]open override fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/-web-actions-metadata/","title":"WebActionsMetadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata/WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/-web-actions-metadata/#webactionsmetadata","title":"WebActionsMetadata","text":"[jvm]\\ constructor(webActions: List<WebActionMetadata>)
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/description-block/","title":"descriptionBlock - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata/descriptionBlock
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/description-block/#descriptionblock","title":"descriptionBlock","text":"[jvm]\\ open override fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/web-actions/","title":"webActions - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadata/webActions
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata/web-actions/#webactions","title":"webActions","text":"[jvm]\\ val webActions: List<WebActionMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/","title":"WebActionsMetadataProvider - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#webactionsmetadataprovider","title":"WebActionsMetadataProvider","text":"[jvm]\\ @Singleton
class WebActionsMetadataProvider : MetadataProvider<WebActionsMetadata>
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#constructors","title":"Constructors","text":"WebActionsMetadataProvider [jvm]constructor()"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: String metadata [jvm]val metadata: WebActionsMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): WebActionsMetadata"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/-web-actions-metadata-provider/","title":"WebActionsMetadataProvider - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/WebActionsMetadataProvider
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/-web-actions-metadata-provider/#webactionsmetadataprovider","title":"WebActionsMetadataProvider","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/get/","title":"get - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/get
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/id/","title":"id - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/id
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/id/#id","title":"id","text":"[jvm]\\ open override val id: String
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/metadata/","title":"metadata - Misk","text":"//misk/misk.web.metadata.webaction/WebActionsMetadataProvider/metadata
"},{"location":"0.x/misk/misk/misk.web.metadata.webaction/-web-actions-metadata-provider/metadata/#metadata","title":"metadata","text":"[jvm]\\ val metadata: WebActionsMetadata
"},{"location":"0.x/misk/misk/misk.web.proxy/","title":"Package-level declarations - Misk","text":"//misk/misk.web.proxy
"},{"location":"0.x/misk/misk/misk.web.proxy/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.proxy/#types","title":"Types","text":"Name Summary OptionalBinder [jvm]@Singletonclass OptionalBinder@Injectconstructorhttps://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor WebProxyAction [jvm]@Singletonclass WebProxyAction@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder) : WebActionWebProxyAction WebProxyEntry [jvm]data class WebProxyEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", val web_proxy_url: HttpUrl) : ValidWebEntryMaps URLs requested against this server to URLs of servers to delegate to"},{"location":"0.x/misk/misk/misk.web.proxy/#functions","title":"Functions","text":"Name Summary WebProxyEntry [jvm]fun WebProxyEntry(url_path_prefix: String = \"/\", web_proxy_url: String): WebProxyEntry"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"//misk/misk.web.proxy/WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"[jvm]\\ fun WebProxyEntry(url_path_prefix: String = \"/\", web_proxy_url: String): WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk/misk.web.proxy/OptionalBinder
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\ @Singleton
class OptionalBinder@Injectconstructor
https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#constructors","title":"Constructors","text":"OptionalBinder [jvm]@Injectconstructor()"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/#properties","title":"Properties","text":"Name Summary proxyClient [jvm]@Inject(optional = true)@Named(value = \"web_proxy_action\")var proxyClient: OkHttpClient"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk/misk.web.proxy/OptionalBinder/OptionalBinder
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/proxy-client/","title":"proxyClient - Misk","text":"//misk/misk.web.proxy/OptionalBinder/proxyClient
"},{"location":"0.x/misk/misk/misk.web.proxy/-optional-binder/proxy-client/#proxyclient","title":"proxyClient","text":"[jvm]\\
@Inject(optional = true)
@Named(value = \"web_proxy_action\")
var proxyClient: OkHttpClient
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/","title":"WebProxyAction - Misk","text":"//misk/misk.web.proxy/WebProxyAction
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/#webproxyaction","title":"WebProxyAction","text":"[jvm]\\ @Singleton
class WebProxyAction@Injectconstructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder) : WebAction
WebProxyAction
Guidelines
/_admin/config/, /_admin/config/subtab/ Request: /_admin/config/subtab/app.js will resolve to the /_admin/config/subtab/ entryExpected Functionality
//misk/misk.web.proxy/WebProxyAction/WebProxyAction
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/-web-proxy-action/#webproxyaction","title":"WebProxyAction","text":"[jvm]\\
@Inject
constructor(optionalBinder: OptionalBinder, clientHttpCall: ActionScoped<HttpCall>, staticResourceAction: StaticResourceAction, resourceEntryFinder: ResourceEntryFinder)
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/action/","title":"action - Misk","text":"//misk/misk.web.proxy/WebProxyAction/action
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-action/action/#action","title":"action","text":"[jvm]\\ fun action(): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/","title":"WebProxyEntry - Misk","text":"//misk/misk.web.proxy/WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"[jvm]\\ data class WebProxyEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", val web_proxy_url: HttpUrl) : ValidWebEntry
Maps URLs requested against this server to URLs of servers to delegate to
url_path_prefix: /_admin/ web_proxy_url: http://localhost:3000/
An incoming request then for /_admin/config.js would route to http://localhost:3000/_admin/config.js.
This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<WebProxyEntry>().toInstance(WebProxyEntry(...))\n//misk/misk.web.proxy/WebProxyEntry/WebProxyEntry
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/-web-proxy-entry/#webproxyentry","title":"WebProxyEntry","text":"[jvm]\\
@JvmOverloads
constructor(url_path_prefix: String = \"/\", web_proxy_url: HttpUrl)
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk/misk.web.proxy/WebProxyEntry/url_path_prefix
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/web_proxy_url/","title":"web_proxy_url - Misk","text":"//misk/misk.web.proxy/WebProxyEntry/web_proxy_url
"},{"location":"0.x/misk/misk/misk.web.proxy/-web-proxy-entry/web_proxy_url/#web_proxy_url","title":"web_proxy_url","text":"[jvm]\\ val web_proxy_url: HttpUrl
"},{"location":"0.x/misk/misk/misk.web.resources/","title":"Package-level declarations - Misk","text":"//misk/misk.web.resources
"},{"location":"0.x/misk/misk/misk.web.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk/misk/misk.web.resources/#types","title":"Types","text":"Name Summary ResourceEntryFinder [jvm]class ResourceEntryFinder@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>) StaticResourceAction [jvm]@Singletonclass StaticResourceAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder) : WebActionStaticResourceAction StaticResourceEntry [jvm]data class StaticResourceEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", resourcePath: String) : ValidWebEntryThis data class is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/","title":"ResourceEntryFinder - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#resourceentryfinder","title":"ResourceEntryFinder","text":"[jvm]\\ class ResourceEntryFinder@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#constructors","title":"Constructors","text":"ResourceEntryFinder [jvm]@Injectconstructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/#functions","title":"Functions","text":"Name Summary staticResource [jvm]fun staticResource(url: HttpUrl): ValidWebEntry? webProxy [jvm]fun webProxy(url: HttpUrl): ValidWebEntry?"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/-resource-entry-finder/","title":"ResourceEntryFinder - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder/ResourceEntryFinder
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/-resource-entry-finder/#resourceentryfinder","title":"ResourceEntryFinder","text":"[jvm]\\
@Inject
constructor(webProxyEntries: List<WebProxyEntry>, staticResourceEntries: List<StaticResourceEntry>)
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/","title":"staticResource - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder/staticResource
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/#staticresource","title":"staticResource","text":"[jvm]\\ fun staticResource(url: HttpUrl): ValidWebEntry?
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/static-resource/#return","title":"Return","text":"entry whose url_path_prefix most closely matches given url; longest match wins
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/","title":"webProxy - Misk","text":"//misk/misk.web.resources/ResourceEntryFinder/webProxy
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/#webproxy","title":"webProxy","text":"[jvm]\\ fun webProxy(url: HttpUrl): ValidWebEntry?
"},{"location":"0.x/misk/misk/misk.web.resources/-resource-entry-finder/web-proxy/#return","title":"Return","text":"entry whose url_path_prefix most closely matches given url; longest match wins
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/","title":"StaticResourceAction - Misk","text":"//misk/misk.web.resources/StaticResourceAction
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/#staticresourceaction","title":"StaticResourceAction","text":"[jvm]\\ @Singleton
class StaticResourceAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder) : WebAction
StaticResourceAction
This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<StaticResourceEntry>()\n .toInstance(\n StaticResourceEntry(\n url_path_prefix = \"/static/\",\n resourcePath = \"classpath:/web/static/\"\n )\n )\ninstall(WebActionModule.createWithPrefix<StaticResourceAction>(url_path_prefix = \"/static/\"))\n//misk/misk.web.resources/StaticResourceAction/StaticResourceAction
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/-static-resource-action/#staticresourceaction","title":"StaticResourceAction","text":"[jvm]\\
@Inject
constructor(clientHttpCall: ActionScoped<HttpCall>, resourceLoader: ResourceLoader, resourceEntryFinder: ResourceEntryFinder)
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/action/","title":"action - Misk","text":"//misk/misk.web.resources/StaticResourceAction/action
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/action/#action","title":"action","text":"[jvm]\\ fun action(): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/get-response/","title":"getResponse - Misk","text":"//misk/misk.web.resources/StaticResourceAction/getResponse
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-action/get-response/#getresponse","title":"getResponse","text":"[jvm]\\ fun getResponse(httpCall: HttpCall): Response<ResponseBody>
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/","title":"StaticResourceEntry - Misk","text":"//misk/misk.web.resources/StaticResourceEntry
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/#staticresourceentry","title":"StaticResourceEntry","text":"[jvm]\\ data class StaticResourceEntry@JvmOverloadsconstructor(val url_path_prefix: String = \"/\", resourcePath: String) : ValidWebEntry
This data class is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<StaticResourceEntry>().toInstance(StaticResourceEntry(...))\n//misk/misk.web.resources/StaticResourceEntry/StaticResourceEntry
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/-static-resource-entry/#staticresourceentry","title":"StaticResourceEntry","text":"[jvm]\\
@JvmOverloads
constructor(url_path_prefix: String = \"/\", resourcePath: String)
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/resource-path/","title":"resourcePath - Misk","text":"//misk/misk.web.resources/StaticResourceEntry/resourcePath
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/resource-path/#resourcepath","title":"resourcePath","text":"[jvm]\\ fun resourcePath(urlPath: String): String
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk/misk.web.resources/StaticResourceEntry/url_path_prefix
"},{"location":"0.x/misk/misk/misk.web.resources/-static-resource-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-action-scopes/","title":"misk-action-scopes - Misk","text":"//misk-action-scopes
"},{"location":"0.x/misk-action-scopes/#misk-action-scopes","title":"misk-action-scopes","text":""},{"location":"0.x/misk-action-scopes/#packages","title":"Packages","text":"Name misk.concurrent misk.scope misk.scope.executor"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk-action-scopes/misk.concurrent
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/#types","title":"Types","text":"Name Summary WrappingListeningExecutorService [jvm]abstract class WrappingListeningExecutorService : ForwardingListeningExecutorServiceListeningExecutorService which wraps all calls"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"abstract class WrappingListeningExecutorService : ForwardingListeningExecutorService
ListeningExecutorService which wraps all calls
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#inheritors","title":"Inheritors","text":"ActionScopedExecutorService"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#constructors","title":"Constructors","text":"WrappingListeningExecutorService [jvm]constructor()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/","title":"WrappingListeningExecutorService - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/WrappingListeningExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/-wrapping-listening-executor-service/#wrappinglisteningexecutorservice","title":"WrappingListeningExecutorService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/execute/","title":"execute - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/execute
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/execute/#execute","title":"execute","text":"[jvm]\\ open override fun execute(runnable: Runnable)
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-all/","title":"invokeAll - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/invokeAll
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-all/#invokeall","title":"invokeAll","text":"[jvm]\\ open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>
open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>>
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-any/","title":"invokeAny - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/invokeAny
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/invoke-any/#invokeany","title":"invokeAny","text":"[jvm]\\ open override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Any
open override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/submit/","title":"submit - Misk","text":"//misk-action-scopes/misk.concurrent/WrappingListeningExecutorService/submit
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.concurrent/-wrapping-listening-executor-service/submit/#submit","title":"submit","text":"[jvm]\\ open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>
open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T>
open override fun submit(runnable: Runnable): ListenableFuture<*>
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/","title":"Package-level declarations - Misk","text":"//misk-action-scopes/misk.scope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/#types","title":"Types","text":"Name Summary ActionScope [jvm]@Singletonclass ActionScope : AutoCloseable ActionScopedProviderModule [jvm]abstract class ActionScopedProviderModule : KAbstractModuleModule used by components and applications to provide ActionScoped context objects SeedDataTransformer [jvm]interface SeedDataTransformerWhile executing, actions have ActionScoped values that can be injected by anything running within the action."},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/","title":"ActionScope - Misk","text":"//misk-action-scopes/misk.scope/ActionScope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#actionscope","title":"ActionScope","text":"[jvm]\\ @Singleton
class ActionScope : AutoCloseable
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Instance [jvm]class Instance : AutoCloseable"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/#functions","title":"Functions","text":"Name Summary asContextElement [jvm]fun asContextElement(): CoroutineContext.ElementConverts the action scope into a CoroutineContext.Element to maintain the given ActionScope context for coroutines regardless of the actual thread they run on. close [jvm]open override fun close() create [jvm]fun create(seedData: Map<Key<*>, Any?>): ActionScope.InstanceCreates a new scope on the current thread with the provided seed data get [jvm]fun <T> get(key: Key<T>): TReturns the action scoped value for the given key inScope [jvm]fun inScope(): BooleanReturns true if currently in the scope propagate [jvm]fun <T> propagate(c: Callable<T>): Callable<T>Wraps a Callable that will be called on another thread, propagating the current scoped data onto that thread[jvm]fun <T> propagate(f: () -> T): () -> TWraps a function or lambda that will be called on another thread, propagating the current scoped data onto that thread[jvm]fun <T> propagate(f: KFunction<T>): KFunction<T>Wraps a KFunction that will be called on another thread, propagating the current scoped data onto that thread runBlocking [jvm]fun <T> runBlocking(block: suspend CoroutineScope.() -> T): Tfun <T> runBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> T): TWraps a kotlinx.coroutines.runBlocking to propagate the current action scope. snapshotActionScopeInstance [jvm]fun snapshotActionScopeInstance(): ActionScope.Instance"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/as-context-element/","title":"asContextElement - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/asContextElement
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/as-context-element/#ascontextelement","title":"asContextElement","text":"[jvm]\\ fun asContextElement(): CoroutineContext.Element
Converts the action scope into a CoroutineContext.Element to maintain the given ActionScope context for coroutines regardless of the actual thread they run on.
Example usage:
scope.enter(seedData).use {\n runBlocking(scope.asContextElement()) {\n async(Dispatchers.IO) {\n tester.fooValue()\n }.await()\n }\n}\n//misk-action-scopes/misk.scope/ActionScope/close
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/close/#close","title":"close","text":"[jvm]\\ open override fun close()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/create/","title":"create - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/create
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/create/#create","title":"create","text":"[jvm]\\ fun create(seedData: Map<Key<*>, Any?>): ActionScope.Instance
Creates a new scope on the current thread with the provided seed data
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/get/","title":"get - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/get
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/get/#get","title":"get","text":"[jvm]\\ fun <T> get(key: Key<T>): T
Returns the action scoped value for the given key
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/in-scope/","title":"inScope - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/inScope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/in-scope/#inscope","title":"inScope","text":"[jvm]\\ fun inScope(): Boolean
Returns true if currently in the scope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/propagate/","title":"propagate - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/propagate
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/propagate/#propagate","title":"propagate","text":"[jvm]\\ fun <T> propagate(c: Callable<T>): Callable<T>
Wraps a Callable that will be called on another thread, propagating the current scoped data onto that thread
[jvm]\\ fun <T> propagate(f: KFunction<T>): KFunction<T>
Wraps a KFunction that will be called on another thread, propagating the current scoped data onto that thread
[jvm]\\ fun <T> propagate(f: () -> T): () -> T
Wraps a function or lambda that will be called on another thread, propagating the current scoped data onto that thread
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/run-blocking/","title":"runBlocking - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/runBlocking
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/run-blocking/#runblocking","title":"runBlocking","text":"[jvm]\\ fun <T> runBlocking(block: suspend CoroutineScope.() -> T): T
fun <T> runBlocking(context: CoroutineContext, block: suspend CoroutineScope.() -> T): T
Wraps a kotlinx.coroutines.runBlocking to propagate the current action scope.
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/snapshot-action-scope-instance/","title":"snapshotActionScopeInstance - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/snapshotActionScopeInstance
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/snapshot-action-scope-instance/#snapshotactionscopeinstance","title":"snapshotActionScopeInstance","text":"[jvm]\\ fun snapshotActionScopeInstance(): ActionScope.Instance
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-companion/","title":"Companion - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/","title":"Instance - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Instance
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/#instance","title":"Instance","text":"[jvm]\\ class Instance : AutoCloseable
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/#functions","title":"Functions","text":"Name Summary close [jvm]open override fun close() enter [jvm]fun enter() inScope [jvm]fun <T> inScope(block: () -> T): T"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/enter/","title":"enter - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Instance/enter
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/enter/#enter","title":"enter","text":"[jvm]\\ fun enter()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/in-scope/","title":"inScope - Misk","text":"//misk-action-scopes/misk.scope/ActionScope/Instance/inScope
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scope/-instance/in-scope/#inscope","title":"inScope","text":"[jvm]\\ fun <T> inScope(block: () -> T): T
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/","title":"ActionScopedProviderModule - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#actionscopedprovidermodule","title":"ActionScopedProviderModule","text":"[jvm]\\ abstract class ActionScopedProviderModule : KAbstractModule
Module used by components and applications to provide ActionScoped context objects
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#constructors","title":"Constructors","text":"ActionScopedProviderModule [jvm]constructor()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/#functions","title":"Functions","text":"Name Summary bindConstant [jvm]@JvmOverloadsfun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation? = null)@JvmOverloadsfun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation? = null)Binds a provider that returns a constant value on every invocation. bindProvider [jvm]fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)@JvmOverloadsfun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)@JvmOverloadsfun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)Binds an annotation qualified ActionScoped along with its provider bindSeedData [jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>)fun <T : Any> bindSeedData(kclass: KClass<T>)Binds an ActionScoped which only pulls from data seeded at the scope entry[jvm]fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>)Binds an annotation qualified ActionScoped which only pulls from data seeded at the scope entry configure [jvm]override fun configure(builder: Binder) configureProviders [jvm]abstract fun configureProviders()"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-action-scoped-provider-module/","title":"ActionScopedProviderModule - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/ActionScopedProviderModule
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-action-scoped-provider-module/#actionscopedprovidermodule","title":"ActionScopedProviderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-constant/","title":"bindConstant - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindConstant
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-constant/#bindconstant","title":"bindConstant","text":"[jvm]\\
@JvmOverloads
fun <T : Any> bindConstant(kclass: KClass<T>, providedValue: T, annotatedBy: Annotation? = null)
@JvmOverloads
fun <T : Any> bindConstant(type: TypeLiteral<T>, providedValue: T, annotatedBy: Annotation? = null)
Binds a provider that returns a constant value on every invocation.
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-provider/","title":"bindProvider - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindProvider
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-provider/#bindprovider","title":"bindProvider","text":"[jvm]\\
@JvmOverloads
fun <T : Any> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)
@JvmOverloads
fun <T> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Annotation? = null)
fun <T : Any, A : Annotation> bindProvider(kclass: KClass<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)
fun <T, A : Annotation> bindProvider(type: TypeLiteral<T>, providerType: KClass<out ActionScopedProvider<T>>, annotatedBy: Class<A>)
Binds an annotation qualified ActionScoped along with its provider
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-seed-data/","title":"bindSeedData - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/bindSeedData
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/bind-seed-data/#bindseeddata","title":"bindSeedData","text":"[jvm]\\ fun <T : Any> bindSeedData(kclass: KClass<T>)
fun <T : Any> bindSeedData(type: TypeLiteral<T>)
Binds an ActionScoped which only pulls from data seeded at the scope entry
[jvm]\\ fun <T : Any> bindSeedData(kclass: KClass<T>, a: Annotation)
fun <T : Any> bindSeedData(type: TypeLiteral<T>, a: Annotation)
fun <T : Any, A : Annotation> bindSeedData(kclass: KClass<T>, a: KClass<A>)
Binds an annotation qualified ActionScoped which only pulls from data seeded at the scope entry
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/configure-providers/","title":"configureProviders - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/configureProviders
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/configure-providers/#configureproviders","title":"configureProviders","text":"[jvm]\\ abstract fun configureProviders()
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-companion/","title":"Companion - Misk","text":"//misk-action-scopes/misk.scope/ActionScopedProviderModule/Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-action-scoped-provider-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/","title":"SeedDataTransformer - Misk","text":"//misk-action-scopes/misk.scope/SeedDataTransformer
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/#seeddatatransformer","title":"SeedDataTransformer","text":"[jvm]\\ interface SeedDataTransformer
While executing, actions have ActionScoped values that can be injected by anything running within the action.
For example, these values are seeded by default for web actions:
HttpCallHttpServletRequestThese types are the initial keys in the seedData map; they map to the corresponding instances. Implementations of this interface may modify this map.
To add new seed data keys, you must also subclass ActionScopedProviderModule and call ActionScopedProviderModule.bindSeedData. This makes the seed data type injectable by Guice.
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/#functions","title":"Functions","text":"Name Summary transform [jvm]abstract fun transform(seedData: Map<Key<>, Any?>): Map<Key<>, Any?>"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/transform/","title":"transform - Misk","text":"//misk-action-scopes/misk.scope/SeedDataTransformer/transform
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope/-seed-data-transformer/transform/#transform","title":"transform","text":"[jvm]\\ abstract fun transform(seedData: Map<Key<>, Any?>): Map<Key<>, Any?>
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/","title":"Package-level declarations - Misk","text":"//misk-action-scopes/misk.scope.executor
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/#types","title":"Types","text":"Name Summary ActionScopedExecutorService [jvm]class ActionScopedExecutorService(target: ExecutorService, scope: ActionScope) : WrappingListeningExecutorServiceWraps a ListeningExecutorService to propagate the current action scope to any tasks submitted by the current thread"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/","title":"ActionScopedExecutorService - Misk","text":"//misk-action-scopes/misk.scope.executor/ActionScopedExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#actionscopedexecutorservice","title":"ActionScopedExecutorService","text":"[jvm]\\ class ActionScopedExecutorService(target: ExecutorService, scope: ActionScope) : WrappingListeningExecutorService
Wraps a ListeningExecutorService to propagate the current action scope to any tasks submitted by the current thread
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#constructors","title":"Constructors","text":"ActionScopedExecutorService [jvm]constructor(target: ExecutorService, scope: ActionScope)"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]@CheckReturnValueopen override fun awaitTermination(timeout: Long, unit: TimeUnit): Booleanopen fun awaitTermination(timeout: Duration): Boolean execute [jvm]open override fun execute(runnable: Runnable) invokeAll [jvm]open fun <T> invokeAll(tasks: MutableCollection<out Callable<T>>, timeout: Duration): MutableList<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>): List<Future<T>>open override fun <T> invokeAll(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): List<Future<T>> invokeAny [jvm]open fun <T> invokeAny(tasks: MutableCollection<out Callable<T>>, timeout: Duration): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>): T & Anyopen override fun <T> invokeAny(callables: Collection<Callable<T>>, timeout: Long, timeUnit: TimeUnit): T & Any isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean shutdown [jvm]open override fun shutdown() shutdownNow [jvm]@CanIgnoreReturnValueopen override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(runnable: Runnable): ListenableFuture<*>open override fun <T> submit(callable: Callable<T>): ListenableFuture<T>open override fun <T> submit(runnable: Runnable, result: T): ListenableFuture<T> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/-action-scoped-executor-service/","title":"ActionScopedExecutorService - Misk","text":"//misk-action-scopes/misk.scope.executor/ActionScopedExecutorService/ActionScopedExecutorService
"},{"location":"0.x/misk-action-scopes/misk-action-scopes/misk.scope.executor/-action-scoped-executor-service/-action-scoped-executor-service/#actionscopedexecutorservice","title":"ActionScopedExecutorService","text":"[jvm]\\ constructor(target: ExecutorService, scope: ActionScope)
"},{"location":"0.x/misk-actions/","title":"misk-actions - Misk","text":"//misk-actions
"},{"location":"0.x/misk-actions/#misk-actions","title":"misk-actions","text":""},{"location":"0.x/misk-actions/#packages","title":"Packages","text":"Name misk misk.exceptions misk.security.authz misk.web misk.web.actions misk.web.dashboard misk.web.interceptors"},{"location":"0.x/misk-actions/misk-actions/misk/","title":"Package-level declarations - Misk","text":"//misk-actions/misk
"},{"location":"0.x/misk-actions/misk-actions/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk/#types","title":"Types","text":"Name Summary MiskCaller [jvm]data class MiskCaller@JvmOverloadsconstructor(val service: String? = null, val user: String? = null, val capabilities: Set<String> = setOf())Information about the authenticated caller of a given action"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/","title":"MiskCaller - Misk","text":"//misk-actions/misk/MiskCaller
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#miskcaller","title":"MiskCaller","text":"[jvm]\\ data class MiskCaller@JvmOverloadsconstructor(val service: String? = null, val user: String? = null, val capabilities: Set<String> = setOf())
Information about the authenticated caller of a given action
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#constructors","title":"Constructors","text":"MiskCaller [jvm]@JvmOverloadsconstructor(service: String? = null, user: String? = null, capabilities: Set<String> = setOf())"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#properties","title":"Properties","text":"Name Summary capabilities [jvm]val capabilities: Set<String>Set of capabilities given to a human user, typically provided by the SSO infrastructure principal [jvm]val principal: StringThe identity of the calling principal, regardless of whether they are a service or a user service [jvm]val service: String? = nullPresent if the caller is an authenticated peer service user [jvm]val user: String? = nullPresent if the caller is a human user, typically from an SSO proxy"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/#functions","title":"Functions","text":"Name Summary hasCapability [jvm]fun hasCapability(allowedCapabilities: Set<String>): BooleanCheck whether the caller has one of allowedCapabilities. isService [jvm]fun isService(allowedServices: Set<String>): BooleanCheck whether this is a service-to-service call from one of allowedServices. toString [jvm]open override fun toString(): StringWe don\u2019t like to log usernames."},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/-misk-caller/","title":"MiskCaller - Misk","text":"//misk-actions/misk/MiskCaller/MiskCaller
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/-misk-caller/#miskcaller","title":"MiskCaller","text":"[jvm]\\
@JvmOverloads
constructor(service: String? = null, user: String? = null, capabilities: Set<String> = setOf())
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/capabilities/","title":"capabilities - Misk","text":"//misk-actions/misk/MiskCaller/capabilities
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Set<String>
Set of capabilities given to a human user, typically provided by the SSO infrastructure
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/has-capability/","title":"hasCapability - Misk","text":"//misk-actions/misk/MiskCaller/hasCapability
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/has-capability/#hascapability","title":"hasCapability","text":"[jvm]\\ fun hasCapability(allowedCapabilities: Set<String>): Boolean
Check whether the caller has one of allowedCapabilities.
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/is-service/","title":"isService - Misk","text":"//misk-actions/misk/MiskCaller/isService
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/is-service/#isservice","title":"isService","text":"[jvm]\\ fun isService(allowedServices: Set<String>): Boolean
Check whether this is a service-to-service call from one of allowedServices.
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/principal/","title":"principal - Misk","text":"//misk-actions/misk/MiskCaller/principal
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/principal/#principal","title":"principal","text":"[jvm]\\ val principal: String
The identity of the calling principal, regardless of whether they are a service or a user
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/service/","title":"service - Misk","text":"//misk-actions/misk/MiskCaller/service
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/service/#service","title":"service","text":"[jvm]\\ val service: String? = null
Present if the caller is an authenticated peer service
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/to-string/","title":"toString - Misk","text":"//misk-actions/misk/MiskCaller/toString
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
We don\u2019t like to log usernames.
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/user/","title":"user - Misk","text":"//misk-actions/misk/MiskCaller/user
"},{"location":"0.x/misk-actions/misk-actions/misk/-misk-caller/user/#user","title":"user","text":"[jvm]\\ val user: String? = null
Present if the caller is a human user, typically from an SSO proxy
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.exceptions
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#types","title":"Types","text":"Name Summary BadGatewayException [jvm]open class BadGatewayException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a server is acting as a gateway and gets invalid response from upstream. The message is not exposed to the caller. BadRequestException [jvm]open class BadRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for bad client requests ClientClosedRequestException [jvm]open class ClientClosedRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. ConflictException [jvm]open class ConflictException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a request causes a conflict GatewayTimeoutException [jvm]open class GatewayTimeoutException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a server is acting as a gateway and cannot get a response in time. The message is not exposed to the caller. NotFoundException [jvm]open class NotFoundException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when resources are not found PayloadTooLargeException [jvm]open class PayloadTooLargeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException ResourceUnavailableException [jvm]open class ResourceUnavailableException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when a resource is unavailable. The message is not exposed to the caller. TooManyRequestsException [jvm]open class TooManyRequestsException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. UnauthenticatedException [jvm]open class UnauthenticatedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when authentication fails UnauthorizedException [jvm]open class UnauthorizedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionBase exception for when authenticated credentials lack access to a resource UnprocessableEntityException [jvm]open class UnprocessableEntityException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionExceptionThis exception is custom to Misk. UnsupportedMediaTypeException [jvm]open class UnsupportedMediaTypeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException WebActionException [jvm]open class WebActionException(val code: Int, val responseBody: String, message: String, cause: Throwable? = null, val grpcStatus: GrpcStatus? = null, val details: List<AnyMessage> = listOf()) : RuntimeExceptionEven though all kotlin exceptions are runtime exceptions. To ensure java inter-op all exception need to extend from RuntimeException."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/#functions","title":"Functions","text":"Name Summary requireRequest [jvm]inline fun requireRequest(check: Boolean, lazyMessage: () -> String)Similar to kotlin.require, but throws BadRequestException if the check fails requireRequestNotNull [jvm]inline fun <T : Any> requireRequestNotNull(value: T?, lazyMessage: () -> String): TSimilar to kotlin.requireNotNull, but throws BadRequestException if the check fails"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request-not-null/","title":"requireRequestNotNull - Misk","text":"//misk-actions/misk.exceptions/requireRequestNotNull
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request-not-null/#requirerequestnotnull","title":"requireRequestNotNull","text":"[jvm]\\ inline fun <T : Any> requireRequestNotNull(value: T?, lazyMessage: () -> String): T
Similar to kotlin.requireNotNull, but throws BadRequestException if the check fails
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request/","title":"requireRequest - Misk","text":"//misk-actions/misk.exceptions/requireRequest
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/require-request/#requirerequest","title":"requireRequest","text":"[jvm]\\ inline fun requireRequest(check: Boolean, lazyMessage: () -> String)
Similar to kotlin.require, but throws BadRequestException if the check fails
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/","title":"BadGatewayException - Misk","text":"//misk-actions/misk.exceptions/BadGatewayException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#badgatewayexception","title":"BadGatewayException","text":"[jvm]\\ open class BadGatewayException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a server is acting as a gateway and gets invalid response from upstream. The message is not exposed to the caller.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#constructors","title":"Constructors","text":"BadGatewayException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/-bad-gateway-exception/","title":"BadGatewayException - Misk","text":"//misk-actions/misk.exceptions/BadGatewayException/BadGatewayException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-gateway-exception/-bad-gateway-exception/#badgatewayexception","title":"BadGatewayException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/","title":"BadRequestException - Misk","text":"//misk-actions/misk.exceptions/BadRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#badrequestexception","title":"BadRequestException","text":"[jvm]\\ open class BadRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for bad client requests
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#constructors","title":"Constructors","text":"BadRequestException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/-bad-request-exception/","title":"BadRequestException - Misk","text":"//misk-actions/misk.exceptions/BadRequestException/BadRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-bad-request-exception/-bad-request-exception/#badrequestexception","title":"BadRequestException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/","title":"ClientClosedRequestException - Misk","text":"//misk-actions/misk.exceptions/ClientClosedRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#clientclosedrequestexception","title":"ClientClosedRequestException","text":"[jvm]\\ open class ClientClosedRequestException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
This exception is custom to Misk.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#constructors","title":"Constructors","text":"ClientClosedRequestException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/-client-closed-request-exception/","title":"ClientClosedRequestException - Misk","text":"//misk-actions/misk.exceptions/ClientClosedRequestException/ClientClosedRequestException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-client-closed-request-exception/-client-closed-request-exception/#clientclosedrequestexception","title":"ClientClosedRequestException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/","title":"ConflictException - Misk","text":"//misk-actions/misk.exceptions/ConflictException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#conflictexception","title":"ConflictException","text":"[jvm]\\ open class ConflictException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a request causes a conflict
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#constructors","title":"Constructors","text":"ConflictException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/-conflict-exception/","title":"ConflictException - Misk","text":"//misk-actions/misk.exceptions/ConflictException/ConflictException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-conflict-exception/-conflict-exception/#conflictexception","title":"ConflictException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/","title":"GatewayTimeoutException - Misk","text":"//misk-actions/misk.exceptions/GatewayTimeoutException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#gatewaytimeoutexception","title":"GatewayTimeoutException","text":"[jvm]\\ open class GatewayTimeoutException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a server is acting as a gateway and cannot get a response in time. The message is not exposed to the caller.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#constructors","title":"Constructors","text":"GatewayTimeoutException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/-gateway-timeout-exception/","title":"GatewayTimeoutException - Misk","text":"//misk-actions/misk.exceptions/GatewayTimeoutException/GatewayTimeoutException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-gateway-timeout-exception/-gateway-timeout-exception/#gatewaytimeoutexception","title":"GatewayTimeoutException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/","title":"NotFoundException - Misk","text":"//misk-actions/misk.exceptions/NotFoundException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#notfoundexception","title":"NotFoundException","text":"[jvm]\\ open class NotFoundException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when resources are not found
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#constructors","title":"Constructors","text":"NotFoundException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/-not-found-exception/","title":"NotFoundException - Misk","text":"//misk-actions/misk.exceptions/NotFoundException/NotFoundException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-not-found-exception/-not-found-exception/#notfoundexception","title":"NotFoundException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/","title":"PayloadTooLargeException - Misk","text":"//misk-actions/misk.exceptions/PayloadTooLargeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#payloadtoolargeexception","title":"PayloadTooLargeException","text":"[jvm]\\ open class PayloadTooLargeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#constructors","title":"Constructors","text":"PayloadTooLargeException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/-payload-too-large-exception/","title":"PayloadTooLargeException - Misk","text":"//misk-actions/misk.exceptions/PayloadTooLargeException/PayloadTooLargeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-payload-too-large-exception/-payload-too-large-exception/#payloadtoolargeexception","title":"PayloadTooLargeException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/","title":"ResourceUnavailableException - Misk","text":"//misk-actions/misk.exceptions/ResourceUnavailableException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#resourceunavailableexception","title":"ResourceUnavailableException","text":"[jvm]\\ open class ResourceUnavailableException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when a resource is unavailable. The message is not exposed to the caller.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#constructors","title":"Constructors","text":"ResourceUnavailableException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/-resource-unavailable-exception/","title":"ResourceUnavailableException - Misk","text":"//misk-actions/misk.exceptions/ResourceUnavailableException/ResourceUnavailableException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-resource-unavailable-exception/-resource-unavailable-exception/#resourceunavailableexception","title":"ResourceUnavailableException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/","title":"TooManyRequestsException - Misk","text":"//misk-actions/misk.exceptions/TooManyRequestsException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#toomanyrequestsexception","title":"TooManyRequestsException","text":"[jvm]\\ open class TooManyRequestsException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
This exception is custom to Misk.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#constructors","title":"Constructors","text":"TooManyRequestsException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/-too-many-requests-exception/","title":"TooManyRequestsException - Misk","text":"//misk-actions/misk.exceptions/TooManyRequestsException/TooManyRequestsException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-too-many-requests-exception/-too-many-requests-exception/#toomanyrequestsexception","title":"TooManyRequestsException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/","title":"UnauthenticatedException - Misk","text":"//misk-actions/misk.exceptions/UnauthenticatedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#unauthenticatedexception","title":"UnauthenticatedException","text":"[jvm]\\ open class UnauthenticatedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when authentication fails
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#constructors","title":"Constructors","text":"UnauthenticatedException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/-unauthenticated-exception/","title":"UnauthenticatedException - Misk","text":"//misk-actions/misk.exceptions/UnauthenticatedException/UnauthenticatedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthenticated-exception/-unauthenticated-exception/#unauthenticatedexception","title":"UnauthenticatedException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/","title":"UnauthorizedException - Misk","text":"//misk-actions/misk.exceptions/UnauthorizedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#unauthorizedexception","title":"UnauthorizedException","text":"[jvm]\\ open class UnauthorizedException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
Base exception for when authenticated credentials lack access to a resource
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#constructors","title":"Constructors","text":"UnauthorizedException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/-unauthorized-exception/","title":"UnauthorizedException - Misk","text":"//misk-actions/misk.exceptions/UnauthorizedException/UnauthorizedException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unauthorized-exception/-unauthorized-exception/#unauthorizedexception","title":"UnauthorizedException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/","title":"UnprocessableEntityException - Misk","text":"//misk-actions/misk.exceptions/UnprocessableEntityException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#unprocessableentityexception","title":"UnprocessableEntityException","text":"[jvm]\\ open class UnprocessableEntityException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
This exception is custom to Misk.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#constructors","title":"Constructors","text":"UnprocessableEntityException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/-unprocessable-entity-exception/","title":"UnprocessableEntityException - Misk","text":"//misk-actions/misk.exceptions/UnprocessableEntityException/UnprocessableEntityException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unprocessable-entity-exception/-unprocessable-entity-exception/#unprocessableentityexception","title":"UnprocessableEntityException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/","title":"UnsupportedMediaTypeException - Misk","text":"//misk-actions/misk.exceptions/UnsupportedMediaTypeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#unsupportedmediatypeexception","title":"UnsupportedMediaTypeException","text":"[jvm]\\ open class UnsupportedMediaTypeException@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null) : WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#constructors","title":"Constructors","text":"UnsupportedMediaTypeException [jvm]@JvmOverloadsconstructor(message: String = \"\", cause: Throwable? = null)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/-unsupported-media-type-exception/","title":"UnsupportedMediaTypeException - Misk","text":"//misk-actions/misk.exceptions/UnsupportedMediaTypeException/UnsupportedMediaTypeException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-unsupported-media-type-exception/-unsupported-media-type-exception/#unsupportedmediatypeexception","title":"UnsupportedMediaTypeException","text":"[jvm]\\
@JvmOverloads
constructor(message: String = \"\", cause: Throwable? = null)
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/","title":"WebActionException - Misk","text":"//misk-actions/misk.exceptions/WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#webactionexception","title":"WebActionException","text":"open class WebActionException(val code: Int, val responseBody: String, message: String, cause: Throwable? = null, val grpcStatus: GrpcStatus? = null, val details: List<AnyMessage> = listOf()) : RuntimeException
Even though all kotlin exceptions are runtime exceptions. To ensure java inter-op all exception need to extend from RuntimeException.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#inheritors","title":"Inheritors","text":"NotFoundException UnauthenticatedException UnauthorizedException ResourceUnavailableException BadRequestException ConflictException UnprocessableEntityException TooManyRequestsException ClientClosedRequestException BadGatewayException GatewayTimeoutException PayloadTooLargeException UnsupportedMediaTypeException"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#constructors","title":"Constructors","text":"WebActionException [jvm]constructor(code: Int, message: String, cause: Throwable? = null)constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null)constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null, grpcStatus: GrpcStatus? = null, details: List<AnyMessage> = listOf())"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? code [jvm]val code: IntThe HTTP status code. Should be 400..599. details [jvm]val details: List<AnyMessage>Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses. grpcStatus [jvm]val grpcStatus: GrpcStatus? = nullThe gPRC status code. If unset, it will be inferred from code. isClientError [jvm]val isClientError: Boolean isServerError [jvm]val isServerError: Boolean message [jvm]open val message: String? responseBody [jvm]val responseBody: StringThis is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body."},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/-web-action-exception/","title":"WebActionException - Misk","text":"//misk-actions/misk.exceptions/WebActionException/WebActionException
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/-web-action-exception/#webactionexception","title":"WebActionException","text":"[jvm]\\ constructor(code: Int, message: String, cause: Throwable? = null)
constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null)
constructor(code: Int, responseBody: String, message: String, cause: Throwable? = null, grpcStatus: GrpcStatus? = null, details: List<AnyMessage> = listOf())
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/code/","title":"code - Misk","text":"//misk-actions/misk.exceptions/WebActionException/code
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/code/#code","title":"code","text":"[jvm]\\ val code: Int
The HTTP status code. Should be 400..599.
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/details/","title":"details - Misk","text":"//misk-actions/misk.exceptions/WebActionException/details
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/details/#details","title":"details","text":"[jvm]\\ val details: List<AnyMessage>
Details are used to enrich gRPC errors with additional proto-encoded messages. error_details.proto is a well-known collection of details, but clients can define their own. This field is ignored for REST responses.
Reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/grpc-status/","title":"grpcStatus - Misk","text":"//misk-actions/misk.exceptions/WebActionException/grpcStatus
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/grpc-status/#grpcstatus","title":"grpcStatus","text":"[jvm]\\ val grpcStatus: GrpcStatus? = null
The gPRC status code. If unset, it will be inferred from code.
Reference: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-client-error/","title":"isClientError - Misk","text":"//misk-actions/misk.exceptions/WebActionException/isClientError
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-client-error/#isclienterror","title":"isClientError","text":"[jvm]\\ val isClientError: Boolean
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-server-error/","title":"isServerError - Misk","text":"//misk-actions/misk.exceptions/WebActionException/isServerError
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/is-server-error/#isservererror","title":"isServerError","text":"[jvm]\\ val isServerError: Boolean
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/response-body/","title":"responseBody - Misk","text":"//misk-actions/misk.exceptions/WebActionException/responseBody
"},{"location":"0.x/misk-actions/misk-actions/misk.exceptions/-web-action-exception/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ val responseBody: String
This is returned to the caller as is. Be mindful not to leak internal implementation details and possible vulnerabilities in the response body.
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.security.authz
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/#types","title":"Types","text":"Name Summary Authenticated [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Authenticated(val services: Array<String> = [], val capabilities: Array<String> = [], val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)Annotation indicating that a given action requires an authenticated caller - either a human in a specific capability, or one of a set of services Unauthenticated [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class UnauthenticatedAnnotation indicating that a given action supports unauthenticated access"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/","title":"Authenticated - Misk","text":"//misk-actions/misk.security.authz/Authenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/#authenticated","title":"Authenticated","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Authenticated(val services: Array<String> = [], val capabilities: Array<String> = [], val allowAnyService: Boolean = false, val allowAnyUser: Boolean = false)
Annotation indicating that a given action requires an authenticated caller - either a human in a specific capability, or one of a set of services
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/#properties","title":"Properties","text":"Name Summary allowAnyService [jvm]val allowAnyService: Boolean = falseAllow any service to be authenticated. allowAnyUser [jvm]val allowAnyUser: Boolean = falseAllow any user to be authenticated. capabilities [jvm]val capabilities: Array<String>Calling users must have at least one of these capabilities to be authenticated services [jvm]val services: Array<String>Calling services must be listed here to be authenticated"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-service/","title":"allowAnyService - Misk","text":"//misk-actions/misk.security.authz/Authenticated/allowAnyService
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-service/#allowanyservice","title":"allowAnyService","text":"[jvm]\\ val allowAnyService: Boolean = false
Allow any service to be authenticated.
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-user/","title":"allowAnyUser - Misk","text":"//misk-actions/misk.security.authz/Authenticated/allowAnyUser
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/allow-any-user/#allowanyuser","title":"allowAnyUser","text":"[jvm]\\ val allowAnyUser: Boolean = false
Allow any user to be authenticated.
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/capabilities/","title":"capabilities - Misk","text":"//misk-actions/misk.security.authz/Authenticated/capabilities
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Array<String>
Calling users must have at least one of these capabilities to be authenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/services/","title":"services - Misk","text":"//misk-actions/misk.security.authz/Authenticated/services
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-authenticated/services/#services","title":"services","text":"[jvm]\\ val services: Array<String>
Calling services must be listed here to be authenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-unauthenticated/","title":"Unauthenticated - Misk","text":"//misk-actions/misk.security.authz/Unauthenticated
"},{"location":"0.x/misk-actions/misk-actions/misk.security.authz/-unauthenticated/#unauthenticated","title":"Unauthenticated","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Unauthenticated
Annotation indicating that a given action supports unauthenticated access
"},{"location":"0.x/misk-actions/misk-actions/misk.web/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web
"},{"location":"0.x/misk-actions/misk-actions/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web/#types","title":"Types","text":"Name Summary AvailableWhenDegraded [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AvailableWhenDegradedWhen the service is overloaded Misk will intervene and reject calls by returning \"HTTP 503 Service Unavailable\". We call this load shedding and it works similarly to flow control in TCP. ConnectWebSocket [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class ConnectWebSocket(val pathPattern: String) Delete [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Delete(val pathPattern: String) Description [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Description(val text: String) FormField [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class FormField(val name: String) FormValue [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class FormValue Get [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Get(val pathPattern: String) Grpc [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Grpc(val pathPattern: String) Patch [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Patch(val pathPattern: String) PathParam [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class PathParam(val value: String = \"\") Post [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Post(val pathPattern: String) Put [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class Put(val pathPattern: String) QueryParam [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class QueryParam(val value: String = \"\") RequestBody [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class RequestBody RequestContentType [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class RequestContentType(val value: String) RequestHeaders [jvm]@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])annotation class RequestHeaders Response [jvm]data class Response<out T>@JvmOverloadsconstructor(val body: T, val headers: Headers = headersOf(), val statusCode: Int = 200, val trailers: () -> Headers? = { null })An HTTP response body, headers, and status code. ResponseBody [jvm]interface ResponseBody ResponseContentType [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class ResponseContentType(val value: String)Indicates what response content types the action can produce. WebActionModule [jvm]class WebActionModule<A : WebAction> : KAbstractModule"},{"location":"0.x/misk-actions/misk-actions/misk.web/-available-when-degraded/","title":"AvailableWhenDegraded - Misk","text":"//misk-actions/misk.web/AvailableWhenDegraded
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-available-when-degraded/#availablewhendegraded","title":"AvailableWhenDegraded","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class AvailableWhenDegraded
When the service is overloaded Misk will intervene and reject calls by returning \"HTTP 503 Service Unavailable\". We call this load shedding and it works similarly to flow control in TCP.
We must not shed calls to status endpoints like health checks as doing so may create cascading failures: overloaded instances that do not respond to health checks will be killed, and this further overloads the remaining peers.
Only put this on endpoints that must never be rejected. Such endpoints must not do RPCs, database queries or other I/O because unexpected latency there can take down the entire service.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/","title":"ConnectWebSocket - Misk","text":"//misk-actions/misk.web/ConnectWebSocket
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/#connectwebsocket","title":"ConnectWebSocket","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class ConnectWebSocket(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/ConnectWebSocket/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-connect-web-socket/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/","title":"Delete - Misk","text":"//misk-actions/misk.web/Delete
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/#delete","title":"Delete","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Delete(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Delete/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-delete/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/","title":"Description - Misk","text":"//misk-actions/misk.web/Description
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/#description","title":"Description","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Description(val text: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/#properties","title":"Properties","text":"Name Summary text [jvm]val text: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/text/","title":"text - Misk","text":"//misk-actions/misk.web/Description/text
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-description/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/","title":"FormField - Misk","text":"//misk-actions/misk.web/FormField
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/#formfield","title":"FormField","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class FormField(val name: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/name/","title":"name - Misk","text":"//misk-actions/misk.web/FormField/name
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-field/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-value/","title":"FormValue - Misk","text":"//misk-actions/misk.web/FormValue
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-form-value/#formvalue","title":"FormValue","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class FormValue
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/","title":"Get - Misk","text":"//misk-actions/misk.web/Get
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/#get","title":"Get","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Get(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Get/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-get/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/","title":"Grpc - Misk","text":"//misk-actions/misk.web/Grpc
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/#grpc","title":"Grpc","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Grpc(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Grpc/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-grpc/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/","title":"Patch - Misk","text":"//misk-actions/misk.web/Patch
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/#patch","title":"Patch","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Patch(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Patch/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-patch/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/","title":"PathParam - Misk","text":"//misk-actions/misk.web/PathParam
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/#pathparam","title":"PathParam","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class PathParam(val value: String = \"\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/value/","title":"value - Misk","text":"//misk-actions/misk.web/PathParam/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-path-param/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/","title":"Post - Misk","text":"//misk-actions/misk.web/Post
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/#post","title":"Post","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Post(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Post/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-post/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/","title":"Put - Misk","text":"//misk-actions/misk.web/Put
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/#put","title":"Put","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class Put(val pathPattern: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/#properties","title":"Properties","text":"Name Summary pathPattern [jvm]val pathPattern: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/path-pattern/","title":"pathPattern - Misk","text":"//misk-actions/misk.web/Put/pathPattern
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-put/path-pattern/#pathpattern","title":"pathPattern","text":"[jvm]\\ val pathPattern: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/","title":"QueryParam - Misk","text":"//misk-actions/misk.web/QueryParam
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/#queryparam","title":"QueryParam","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class QueryParam(val value: String = \"\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/value/","title":"value - Misk","text":"//misk-actions/misk.web/QueryParam/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-query-param/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-body/","title":"RequestBody - Misk","text":"//misk-actions/misk.web/RequestBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-body/#requestbody","title":"RequestBody","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class RequestBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/","title":"RequestContentType - Misk","text":"//misk-actions/misk.web/RequestContentType
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/#requestcontenttype","title":"RequestContentType","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class RequestContentType(val value: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/#properties","title":"Properties","text":"Name Summary value [jvm]val value: Array<out String>"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/value/","title":"value - Misk","text":"//misk-actions/misk.web/RequestContentType/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-content-type/value/#value","title":"value","text":"[jvm]\\ val value: Array<out String>
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-headers/","title":"RequestHeaders - Misk","text":"//misk-actions/misk.web/RequestHeaders
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-request-headers/#requestheaders","title":"RequestHeaders","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])
annotation class RequestHeaders
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/","title":"Response - Misk","text":"//misk-actions/misk.web/Response
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#response","title":"Response","text":"[jvm]\\ data class Response<out T>@JvmOverloadsconstructor(val body: T, val headers: Headers = headersOf(), val statusCode: Int = 200, val trailers: () -> Headers? = { null })
An HTTP response body, headers, and status code.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#constructors","title":"Constructors","text":"Response [jvm]@JvmOverloadsconstructor(body: T, headers: Headers = headersOf(), statusCode: Int = 200, trailers: () -> Headers? = { null })"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#properties","title":"Properties","text":"Name Summary body [jvm]val body: T headers [jvm]val headers: Headers statusCode [jvm]val statusCode: Int = 200 trailers [jvm]val trailers: () -> Headers?"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/-response/","title":"Response - Misk","text":"//misk-actions/misk.web/Response/Response
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/-response/#response","title":"Response","text":"[jvm]\\
@JvmOverloads
constructor(body: T, headers: Headers = headersOf(), statusCode: Int = 200, trailers: () -> Headers? = { null })
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/body/","title":"body - Misk","text":"//misk-actions/misk.web/Response/body
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/body/#body","title":"body","text":"[jvm]\\ val body: T
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/headers/","title":"headers - Misk","text":"//misk-actions/misk.web/Response/headers
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/headers/#headers","title":"headers","text":"[jvm]\\ val headers: Headers
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/status-code/","title":"statusCode - Misk","text":"//misk-actions/misk.web/Response/statusCode
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/status-code/#statuscode","title":"statusCode","text":"[jvm]\\ val statusCode: Int = 200
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/to-string/","title":"toString - Misk","text":"//misk-actions/misk.web/Response/toString
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/trailers/","title":"trailers - Misk","text":"//misk-actions/misk.web/Response/trailers
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response/trailers/#trailers","title":"trailers","text":"[jvm]\\ val trailers: () -> Headers?
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/","title":"ResponseBody - Misk","text":"//misk-actions/misk.web/ResponseBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/#responsebody","title":"ResponseBody","text":"[jvm]\\ interface ResponseBody
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/#functions","title":"Functions","text":"Name Summary writeTo [jvm]abstract fun writeTo(sink: BufferedSink)"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/write-to/","title":"writeTo - Misk","text":"//misk-actions/misk.web/ResponseBody/writeTo
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-body/write-to/#writeto","title":"writeTo","text":"[jvm]\\ abstract fun writeTo(sink: BufferedSink)
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/","title":"ResponseContentType - Misk","text":"//misk-actions/misk.web/ResponseContentType
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/#responsecontenttype","title":"ResponseContentType","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class ResponseContentType(val value: String)
Indicates what response content types the action can produce.
Clients can specify what content type they prefer by setting the Accept header. If the action supports multiple content types but no Accept header is specified, the first content type is used.
//misk-actions/misk.web/ResponseContentType/value
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-response-content-type/value/#value","title":"value","text":"[jvm]\\ val value: Array<out String>
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/","title":"WebActionModule - Misk","text":"//misk-actions/misk.web/WebActionModule
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#webactionmodule","title":"WebActionModule","text":"[jvm]\\ class WebActionModule<A : WebAction> : KAbstractModule
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: KClass<A> url_path_prefix [jvm]val url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/action-class/","title":"actionClass - Misk","text":"//misk-actions/misk.web/WebActionModule/actionClass
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/action-class/#actionclass","title":"actionClass","text":"[jvm]\\ val actionClass: KClass<A>
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-actions/misk.web/WebActionModule/url_path_prefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/","title":"Companion - Misk","text":"//misk-actions/misk.web/WebActionModule/Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <A : WebAction> create(): WebActionModule<A>@JvmStaticfun <A : WebAction> create(actionClass: Class<A>): WebActionModule<A>[jvm]fun <A : WebAction> create(actionClass: KClass<A>): WebActionModule<A>Registers a web action. createWithPrefix [jvm]inline fun <A : WebAction> createWithPrefix(url_path_prefix: String): WebActionModule<A>@JvmStaticfun <A : WebAction> createWithPrefix(actionClass: Class<A>, url_path_prefix: String): WebActionModule<A>[jvm]fun <A : WebAction> createWithPrefix(actionClass: KClass<A>, url_path_prefix: String): WebActionModule<A>Registers a web action with a path prefix."},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/","title":"createWithPrefix - Misk","text":"//misk-actions/misk.web/WebActionModule/Companion/createWithPrefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/#createwithprefix","title":"createWithPrefix","text":"[jvm]\\ inline fun <A : WebAction> createWithPrefix(url_path_prefix: String): WebActionModule<A>
@JvmStatic
fun <A : WebAction> createWithPrefix(actionClass: Class<A>, url_path_prefix: String): WebActionModule<A>
[jvm]\\ fun <A : WebAction> createWithPrefix(actionClass: KClass<A>, url_path_prefix: String): WebActionModule<A>
Registers a web action with a path prefix.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create-with-prefix/#parameters","title":"Parameters","text":"jvm
actionClass : The web action to register. url_path_prefix : Defaults to \"/\". If not empty, must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/","title":"create - Misk","text":"//misk-actions/misk.web/WebActionModule/Companion/create
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <A : WebAction> create(): WebActionModule<A>
@JvmStatic
fun <A : WebAction> create(actionClass: Class<A>): WebActionModule<A>
[jvm]\\ fun <A : WebAction> create(actionClass: KClass<A>): WebActionModule<A>
Registers a web action.
"},{"location":"0.x/misk-actions/misk-actions/misk.web/-web-action-module/-companion/create/#parameters","title":"Parameters","text":"jvm
actionClass : The web action to register."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web.actions
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/#types","title":"Types","text":"Name Summary WebAction [jvm]interface WebAction WebActionEntry [jvm]data class WebActionEntry(val actionClass: KClass<out WebAction>, val url_path_prefix: String) : ValidWebEntryWebActionEntry WebSocket [jvm]interface WebSocketA non-blocking interface to a web socket. WebSocketListener [jvm]open class WebSocketListener"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action/","title":"WebAction - Misk","text":"//misk-actions/misk.web.actions/WebAction
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action/#webaction","title":"WebAction","text":"[jvm]\\ interface WebAction
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/","title":"WebActionEntry - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#webactionentry","title":"WebActionEntry","text":"data class WebActionEntry(val actionClass: KClass<out WebAction>, val url_path_prefix: String) : ValidWebEntry
WebActionEntry
A registration of a web action with optional configuration to customize.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#parameters","title":"Parameters","text":"jvm
actionClass : WebAction to multibind to WebServlet url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#constructors","title":"Constructors","text":"WebActionEntry [jvm]constructor(actionClass: KClass<out WebAction>, url_path_prefix: String)"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/#properties","title":"Properties","text":"Name Summary actionClass [jvm]val actionClass: KClass<out WebAction> url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/","title":"WebActionEntry - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry/WebActionEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/#webactionentry","title":"WebActionEntry","text":"[jvm]\\ constructor(actionClass: KClass<out WebAction>, url_path_prefix: String)
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/-web-action-entry/#parameters","title":"Parameters","text":"jvm
actionClass : WebAction to multibind to WebServlet url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/","title":"actionClass - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry/actionClass
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/#actionclass","title":"actionClass","text":"[jvm]\\ val actionClass: KClass<out WebAction>
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/action-class/#parameters","title":"Parameters","text":"jvm
actionClass : WebAction to multibind to WebServlet"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-actions/misk.web.actions/WebActionEntry/url_path_prefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-action-entry/url_path_prefix/#parameters","title":"Parameters","text":"jvm
url_path_prefix : Must match pattern requirements:- must begin with \"/\" - any number of non-whitespace characters (including additional path segments or \"/\") - must terminate with a non-\"/\" because rest of path will start with \"/\""},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/","title":"WebSocket - Misk","text":"//misk-actions/misk.web.actions/WebSocket
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/#websocket","title":"WebSocket","text":"[jvm]\\ interface WebSocket
A non-blocking interface to a web socket.
Web Socket LifecycleUpon normal operation each web socket progresses through a sequence of states:
Web sockets may fail due to HTTP upgrade problems, connectivity problems, or if either peer chooses to short-circuit the graceful shutdown process:
Note that the state progression is independent for each peer. Arriving at a gracefully-closed state indicates that a peer has sent all of its outgoing messages and received all of its incoming messages. But it does not guarantee that the other peer will successfully receive all of its incoming messages.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/#functions","title":"Functions","text":"Name Summary cancel [jvm]abstract fun cancel()Immediately and violently release resources held by this web socket, discarding any enqueued messages. This does nothing if the web socket has already been closed or canceled. close [jvm]abstract fun close(code: Int, reason: String?): BooleanAttempts to initiate a graceful shutdown of this web socket. Any already-enqueued messages will be transmitted before the close message is sent but subsequent calls to {@link #send} will return false and their messages will not be enqueued. queueSize [jvm]abstract fun queueSize(): LongReturns the size in bytes of all messages enqueued to be transmitted to the server. This doesn\u2019t include framing overhead. It also doesn\u2019t include any bytes buffered by the operating system or network intermediaries. This method returns 0 if no messages are waiting in the queue. If may return a nonzero value after the web socket has been canceled; this indicates that enqueued messages were not transmitted. send [jvm]abstract fun send(text: String): BooleanAttempts to enqueue {@code bytes} to be sent as a the data of a binary (type {@code 0x2}) message.[jvm]abstract fun send(bytes: ByteString): BooleanAttempts to enqueue {@code text} to be UTF-8 encoded and sent as a the data of a text (type {@code 0x1}) message."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/cancel/","title":"cancel - Misk","text":"//misk-actions/misk.web.actions/WebSocket/cancel
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/cancel/#cancel","title":"cancel","text":"[jvm]\\ abstract fun cancel()
Immediately and violently release resources held by this web socket, discarding any enqueued messages. This does nothing if the web socket has already been closed or canceled.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/close/","title":"close - Misk","text":"//misk-actions/misk.web.actions/WebSocket/close
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/close/#close","title":"close","text":"[jvm]\\ abstract fun close(code: Int, reason: String?): Boolean
Attempts to initiate a graceful shutdown of this web socket. Any already-enqueued messages will be transmitted before the close message is sent but subsequent calls to {@link #send} will return false and their messages will not be enqueued.
This returns true if a graceful shutdown was initiated by this call. It returns false and if a graceful shutdown was already underway or if the web socket is already closed or canceled. #### Parameters jvm | | | |---|---| | code | Status code as defined by Section 7.4 of RFC 6455. | | reason | Reason for shutting down or {@code null}. |"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/queue-size/","title":"queueSize - Misk","text":"
//misk-actions/misk.web.actions/WebSocket/queueSize
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ abstract fun queueSize(): Long
Returns the size in bytes of all messages enqueued to be transmitted to the server. This doesn\u2019t include framing overhead. It also doesn\u2019t include any bytes buffered by the operating system or network intermediaries. This method returns 0 if no messages are waiting in the queue. If may return a nonzero value after the web socket has been canceled; this indicates that enqueued messages were not transmitted.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/send/","title":"send - Misk","text":"//misk-actions/misk.web.actions/WebSocket/send
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket/send/#send","title":"send","text":"[jvm]\\ abstract fun send(bytes: ByteString): Boolean
Attempts to enqueue {@code text} to be UTF-8 encoded and sent as a the data of a text (type {@code 0x1}) message.
This method returns true if the message was enqueued. Messages that would overflow the outgoing message buffer will be rejected and trigger a {@linkplain #close graceful shutdown} of this web socket. This method returns false in that case, and in any other case where this web socket is closing, closed, or canceled.
This method returns immediately. [jvm]\\ abstract fun [send](send.md)(text: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) Attempts to enqueue {@code bytes} to be sent as a the data of a binary (type {@code 0x2}) message.
This method returns true if the message was enqueued. Messages that would overflow the outgoing message buffer will be rejected and trigger a {@linkplain #close graceful shutdown} of this web socket. This method returns false in that case, and in any other case where this web socket is closing, closed, or canceled.
This method returns immediately."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/","title":"WebSocketListener - Misk","text":"
//misk-actions/misk.web.actions/WebSocketListener
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/#websocketlistener","title":"WebSocketListener","text":"[jvm]\\ open class WebSocketListener
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/#constructors","title":"Constructors","text":"WebSocketListener [jvm]constructor()"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/#functions","title":"Functions","text":"Name Summary onClosed [jvm]open fun onClosed(webSocket: WebSocket, code: Int, reason: String?)Invoked when both peers have indicated that no more messages will be transmitted and the connection has been successfully released. No further calls to this listener will be made. onClosing [jvm]open fun onClosing(webSocket: WebSocket, code: Int, reason: String?)Invoked when the remote peer has indicated that no more incoming messages will be transmitted. onFailure [jvm]open fun onFailure(webSocket: WebSocket, t: Throwable)Invoked when a web socket has been closed due to an error reading from or writing to the network. Both outgoing and incoming messages may have been lost. No further calls to this listener will be made. onMessage [jvm]open fun onMessage(webSocket: WebSocket, text: String)Invoked when a text (type {@code 0x1}) message has been received.[jvm]open fun onMessage(webSocket: WebSocket, bytes: ByteString)Invoked when a binary (type {@code 0x2}) message has been received."},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/-web-socket-listener/","title":"WebSocketListener - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/WebSocketListener
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/-web-socket-listener/#websocketlistener","title":"WebSocketListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closed/","title":"onClosed - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onClosed
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closed/#onclosed","title":"onClosed","text":"[jvm]\\ open fun onClosed(webSocket: WebSocket, code: Int, reason: String?)
Invoked when both peers have indicated that no more messages will be transmitted and the connection has been successfully released. No further calls to this listener will be made.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closing/","title":"onClosing - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onClosing
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-closing/#onclosing","title":"onClosing","text":"[jvm]\\ open fun onClosing(webSocket: WebSocket, code: Int, reason: String?)
Invoked when the remote peer has indicated that no more incoming messages will be transmitted.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-failure/","title":"onFailure - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onFailure
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-failure/#onfailure","title":"onFailure","text":"[jvm]\\ open fun onFailure(webSocket: WebSocket, t: Throwable)
Invoked when a web socket has been closed due to an error reading from or writing to the network. Both outgoing and incoming messages may have been lost. No further calls to this listener will be made.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-message/","title":"onMessage - Misk","text":"//misk-actions/misk.web.actions/WebSocketListener/onMessage
"},{"location":"0.x/misk-actions/misk-actions/misk.web.actions/-web-socket-listener/on-message/#onmessage","title":"onMessage","text":"[jvm]\\ open fun onMessage(webSocket: WebSocket, text: String)
Invoked when a text (type {@code 0x1}) message has been received.
[jvm]\\ open fun onMessage(webSocket: WebSocket, bytes: ByteString)
Invoked when a binary (type {@code 0x2}) message has been received.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web.dashboard
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/#types","title":"Types","text":"Name Summary ValidWebEntry [jvm]open class ValidWebEntry@JvmOverloadsconstructor(val valid_slug: String = \"\", val valid_url_path_prefix: String = \"/\")"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/","title":"ValidWebEntry - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#validwebentry","title":"ValidWebEntry","text":"open class ValidWebEntry@JvmOverloadsconstructor(val valid_slug: String = \"\", val valid_url_path_prefix: String = \"/\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#inheritors","title":"Inheritors","text":"WebActionEntry"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#constructors","title":"Constructors","text":"ValidWebEntry [jvm]@JvmOverloadsconstructor(valid_slug: String = \"\", valid_url_path_prefix: String = \"/\")"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/#properties","title":"Properties","text":"Name Summary valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-valid-web-entry/","title":"ValidWebEntry - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/ValidWebEntry
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-valid-web-entry/#validwebentry","title":"ValidWebEntry","text":"[jvm]\\
@JvmOverloads
constructor(valid_slug: String = \"\", valid_url_path_prefix: String = \"/\")
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_slug/","title":"valid_slug - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/valid_slug
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_slug/#valid_slug","title":"valid_slug","text":"[jvm]\\ val valid_slug: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_url_path_prefix/","title":"valid_url_path_prefix - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/valid_url_path_prefix
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/valid_url_path_prefix/#valid_url_path_prefix","title":"valid_url_path_prefix","text":"[jvm]\\ val valid_url_path_prefix: String
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/","title":"Companion - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/#functions","title":"Functions","text":"Name Summary slugify [jvm]inline fun <A : Annotation> slugify(): Stringfun slugify(annotation: KClass<out Annotation>): StringGenerate a valid slug from an Annotation class.[jvm]fun String.slugify(): StringGenerate a valid slug from a String."},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/slugify/","title":"slugify - Misk","text":"//misk-actions/misk.web.dashboard/ValidWebEntry/Companion/slugify
"},{"location":"0.x/misk-actions/misk-actions/misk.web.dashboard/-valid-web-entry/-companion/slugify/#slugify","title":"slugify","text":"[jvm]\\ fun slugify(annotation: KClass<out Annotation>): String
inline fun <A : Annotation> slugify(): String
Generate a valid slug from an Annotation class.
[jvm]\\ fun String.slugify(): String
Generate a valid slug from a String.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/","title":"Package-level declarations - Misk","text":"//misk-actions/misk.web.interceptors
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/#types","title":"Types","text":"Name Summary LogRequestResponse [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class LogRequestResponse(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: Array<String> = [], val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)Annotation indicating that request and response information should be logged. RequestLoggingMode [jvm]enum RequestLoggingMode : Enum<RequestLoggingMode>"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/","title":"LogRequestResponse - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/#logrequestresponse","title":"LogRequestResponse","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class LogRequestResponse(val ratePerSecond: Long = 10, val errorRatePerSecond: Long = 0, val bodySampling: Double = 0.0, val errorBodySampling: Double = 0.0, val excludedEnvironments: Array<String> = [], val requestLoggingMode: RequestLoggingMode = RequestLoggingMode.ALL)
Annotation indicating that request and response information should be logged.
Rate limiting is used to sample the number of requests logged. The value specified is the log events per sec allotted per action.
By default we set rate limiting for successes to 10 log events per second, enough to show things are happening without sending too many logs. By default rate limiting is off for errors, as we would want to surface such logs for investigation.
If you would like to turn off rate limiting and emit all logs, set ratePerSecond and/or errorRatePerSecond to 0.
If you would like to turn off logging for all non-error requests, set requestLoggingMode to ERROR_ONLY. otherwise, all requests will be logged (excluding those otherwise rate limited, etc).
Percentage sampling is used to sample request and response bodies, with 0.0 for none and 1.0 for all. Valid values are in the range 0.0, 1.0.
You can exclude logging in particular environments by using the all-lowercase names of the environments. See the wisp-deployment module for details of supported environment names.
If arguments and responses may include sensitive information, it is expected that the toString() methods of these objects will redact it.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/#properties","title":"Properties","text":"Name Summary bodySampling [jvm]val bodySampling: Double = 0.0By default do not log request and response bodies errorBodySampling [jvm]val errorBodySampling: Double = 0.0 errorRatePerSecond [jvm]val errorRatePerSecond: Long = 0By default, rate limiting is off for error logs excludedEnvironments [jvm]val excludedEnvironments: Array<String>which deploy environments will not have request/response logging enabled ratePerSecond [jvm]val ratePerSecond: Long = 10 requestLoggingMode [jvm]val requestLoggingMode: RequestLoggingModeBy default log non-error responses"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/body-sampling/","title":"bodySampling - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/bodySampling
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/body-sampling/#bodysampling","title":"bodySampling","text":"[jvm]\\ val bodySampling: Double = 0.0
By default do not log request and response bodies
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-body-sampling/","title":"errorBodySampling - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/errorBodySampling
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-body-sampling/#errorbodysampling","title":"errorBodySampling","text":"[jvm]\\ val errorBodySampling: Double = 0.0
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-rate-per-second/","title":"errorRatePerSecond - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/errorRatePerSecond
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/error-rate-per-second/#errorratepersecond","title":"errorRatePerSecond","text":"[jvm]\\ val errorRatePerSecond: Long = 0
By default, rate limiting is off for error logs
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/excluded-environments/","title":"excludedEnvironments - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/excludedEnvironments
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/excluded-environments/#excludedenvironments","title":"excludedEnvironments","text":"[jvm]\\ val excludedEnvironments: Array<String>
which deploy environments will not have request/response logging enabled
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/rate-per-second/","title":"ratePerSecond - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/ratePerSecond
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/rate-per-second/#ratepersecond","title":"ratePerSecond","text":"[jvm]\\ val ratePerSecond: Long = 10
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/request-logging-mode/","title":"requestLoggingMode - Misk","text":"//misk-actions/misk.web.interceptors/LogRequestResponse/requestLoggingMode
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-log-request-response/request-logging-mode/#requestloggingmode","title":"requestLoggingMode","text":"[jvm]\\ val requestLoggingMode: RequestLoggingMode
By default log non-error responses
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/","title":"RequestLoggingMode - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#requestloggingmode","title":"RequestLoggingMode","text":"[jvm]\\ enum RequestLoggingMode : Enum<RequestLoggingMode>
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#entries","title":"Entries","text":"ALL [jvm]ALLLog all requests and responses, rate limiting, etc still apply. ERROR_ONLY [jvm]ERROR_ONLYLog only error requests and responses, rate limiting, etc still apply."},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<RequestLoggingMode>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): RequestLoggingModeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<RequestLoggingMode>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/entries/","title":"entries - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/entries
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<RequestLoggingMode>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/value-of/","title":"valueOf - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/valueOf
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): RequestLoggingMode
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/values/","title":"values - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/values
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<RequestLoggingMode>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-a-l-l/","title":"ALL - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/ALL
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-a-l-l/#all","title":"ALL","text":"[jvm]\\ ALL
Log all requests and responses, rate limiting, etc still apply.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-a-l-l/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-e-r-r-o-r_-o-n-l-y/","title":"ERROR_ONLY - Misk","text":"//misk-actions/misk.web.interceptors/RequestLoggingMode/ERROR_ONLY
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-e-r-r-o-r_-o-n-l-y/#error_only","title":"ERROR_ONLY","text":"[jvm]\\ ERROR_ONLY
Log only error requests and responses, rate limiting, etc still apply.
"},{"location":"0.x/misk-actions/misk-actions/misk.web.interceptors/-request-logging-mode/-e-r-r-o-r_-o-n-l-y/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/","title":"misk-admin - Misk","text":"//misk-admin
"},{"location":"0.x/misk-admin/#misk-admin","title":"misk-admin","text":""},{"location":"0.x/misk-admin/#packages","title":"Packages","text":"Name misk.web.dashboard misk.web.metadata misk.web.metadata.all misk.web.metadata.config misk.web.metadata.database misk.web.metadata.guice misk.web.metadata.webaction misk.web.v2"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/","title":"Index","text":"//misk-admin/misk.web.dashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/#types","title":"Types","text":"Name Summary AdminDashboard [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])annotation class AdminDashboardDashboard Annotation used for all tabs bound in the Misk Admin Dashboard AdminDashboardModule [jvm]class AdminDashboardModule@JvmOverloadsconstructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE) : KAbstractModuleInstalls default Admin Dashboard that runs at multibound DashboardHomeUrl AdminDashboardTestingModule [jvm]class AdminDashboardTestingModule : KAbstractModule BaseDashboardModule [jvm]class BaseDashboardModule(isDevelopment: Boolean) : KAbstractModuleInstalls base functionality for the Admin Dashboard including: DashboardHomeUrl [jvm]data class DashboardHomeUrl@JvmOverloadsconstructor(val dashboard_slug: String, val url: String, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : ValidWebEntryUrl to link to for the home button in the dashboard navbar 1 DashboardHomeUrl should be bound per dashboard DashboardModule [jvm]class DashboardModule@JvmOverloadsconstructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf()) : KAbstractModuleHandles installation of Misk Dashboard components (admin dashboard or custom\u2026). DashboardTab [jvm]data class DashboardTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val menuLabel: String, val menuCategory: String = \"\", val menuUrl: String = url_path_prefix, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : WebTabA WebTab with additional fields to bind to a specific Dashboard that has a tabs menu DashboardTabLoader [jvm]sealed class DashboardTabLoader DashboardTabLoaderEntry [jvm]data class DashboardTabLoaderEntry(val urlPathPrefix: String, val loader: DashboardTabLoader) DashboardTabProvider [jvm]class DashboardTabProvider@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val menuLabel: (appName: String, deployment: Deployment) -> String, val menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, val menuCategory: String = \"Admin\", val dashboard_slug: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>) : ValidWebEntry, Provider<DashboardTab> Sets the tab\u2019s authentication capabilities/services by the multibound AccessAnnotationEntry MiskWebColor [jvm]enum MiskWebColor : Enum<MiskWebColor> Matches the Misk-Web Color enum in @misk/core/src/utilities/css.ts MiskWebTabIndexAction [jvm]@Singletonclass MiskWebTabIndexAction@Injectconstructor(dashboardTabs: List<DashboardTab>) : WebActionKotlin backed tab loader, equivalent to /_tab/slug/index.html WebTab [jvm]open class WebTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf()) : ValidWebEntry WebTabResourceModule [jvm]class WebTabResourceModule@JvmOverloadsconstructor(isDevelopment: Boolean = false, val slug: String, val web_proxy_url: String? = null, val url_path_prefix: String = \"/_tab/\", val resourcePath: String = \"classpath:/web/_tab/\") : KAbstractModuleDeclare how to serve the resources for a WebTab (JS, HTML, CSS\u2026)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/#functions","title":"Functions","text":"Name Summary DashboardHomeUrl [jvm]inline fun <DA : Annotation> DashboardHomeUrl(urlPathPrefix: String): DashboardHomeUrl DashboardTabProvider [jvm]inline fun <DA : Annotation, AA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\"): DashboardTabProviderBinds a DashboardTab for Dashboard DA with access annotation AA[jvm]inline fun <DA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\", capabilities: Set<String> = setOf(), services: Set<String> = setOf()): DashboardTabProviderBinds a DashboardTab for Dashboard DA with optional access capabilities and services HtmlLayout [jvm]fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)Default setup of HTML for a page including head and install of CSS/JS dependencies."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/","title":"DashboardHomeUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#dashboardhomeurl","title":"DashboardHomeUrl","text":"[jvm]\\ inline fun <DA : Annotation> DashboardHomeUrl(urlPathPrefix: String): DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/","title":"DashboardTabProvider - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#dashboardtabprovider","title":"DashboardTabProvider","text":"[jvm]\\ inline fun <DA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\", capabilities: Set<String> = setOf(), services: Set<String> = setOf()): DashboardTabProvider
Binds a DashboardTab for Dashboard DA with optional access capabilities and services
[jvm]\\ inline fun <DA : Annotation, AA : Annotation> DashboardTabProvider(slug: String, url_path_prefix: String, name: String, menuUrl: String = url_path_prefix, category: String = \"Admin\"): DashboardTabProvider
Binds a DashboardTab for Dashboard DA with access annotation AA
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-html-layout/","title":"html layout","text":"//misk-admin/misk.web.dashboard/HtmlLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-html-layout/#htmllayout","title":"HtmlLayout","text":"[jvm]\\ fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)
Default setup of HTML for a page including head and install of CSS/JS dependencies.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard/","title":"AdminDashboard - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard/#admindashboard","title":"AdminDashboard","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION])
annotation class AdminDashboard
Dashboard Annotation used for all tabs bound in the Misk Admin Dashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/","title":"AdminDashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/#admindashboardmodule","title":"AdminDashboardModule","text":"[jvm]\\ class AdminDashboardModule@JvmOverloadsconstructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE) : KAbstractModule
Installs default Admin Dashboard that runs at multibound DashboardHomeUrl
Each Misk included tab in dashboard is installed with the respective:
To add tabs to the Misk Admin Dashboard, bind the DashboardTab with the Dashboard Annotation AdminDashboard. Tabs are then included in the admin dashboard menu grouping according to the DashboardTab.category field and sorting by DashboardTab.name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/#constructors","title":"Constructors","text":"AdminDashboardModule [jvm]@JvmOverloadsconstructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/-admin-dashboard-module/","title":"AdminDashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardModule/AdminDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-module/-admin-dashboard-module/#admindashboardmodule","title":"AdminDashboardModule","text":"[jvm]\\
@JvmOverloads
constructor(isDevelopment: Boolean, configTabMode: ConfigMetadataAction.ConfigTabMode = ConfigMetadataAction.ConfigTabMode.SAFE)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/","title":"AdminDashboardTestingModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardTestingModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/#admindashboardtestingmodule","title":"AdminDashboardTestingModule","text":"[jvm]\\ class AdminDashboardTestingModule : KAbstractModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/#constructors","title":"Constructors","text":"AdminDashboardTestingModule [jvm]constructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/-admin-dashboard-testing-module/","title":"AdminDashboardTestingModule - Misk","text":"//misk-admin/misk.web.dashboard/AdminDashboardTestingModule/AdminDashboardTestingModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-admin-dashboard-testing-module/-admin-dashboard-testing-module/#admindashboardtestingmodule","title":"AdminDashboardTestingModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-base-dashboard-module/","title":"BaseDashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/BaseDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-base-dashboard-module/#basedashboardmodule","title":"BaseDashboardModule","text":"[jvm]\\ class BaseDashboardModule(isDevelopment: Boolean) : KAbstractModule
Installs base functionality for the Admin Dashboard including:
admin-dashboard tab which loads all other tabs and provides navbar, menu links, auth@misk packages used by Misk-Web tabs from window to provide faster tab loads//misk-admin/misk.web.dashboard/BaseDashboardModule/BaseDashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-base-dashboard-module/-base-dashboard-module/#basedashboardmodule","title":"BaseDashboardModule","text":"[jvm]\\ constructor(isDevelopment: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/","title":"DashboardHomeUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#dashboardhomeurl","title":"DashboardHomeUrl","text":"[jvm]\\ data class DashboardHomeUrl@JvmOverloadsconstructor(val dashboard_slug: String, val url: String, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : ValidWebEntry
Url to link to for the home button in the dashboard navbar 1 DashboardHomeUrl should be bound per dashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#constructors","title":"Constructors","text":"DashboardHomeUrl [jvm]@JvmOverloadsconstructor(dashboard_slug: String, url: String, dashboardAnnotationKClass: KClass<out Annotation>? = null)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/#properties","title":"Properties","text":"Name Summary dashboard_slug [jvm]val dashboard_slug: String dashboardAnnotationKClass [jvm]val dashboardAnnotationKClass: KClass<out Annotation>? = null url [jvm]val url: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/-dashboard-home-url/","title":"DashboardHomeUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/DashboardHomeUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/-dashboard-home-url/#dashboardhomeurl","title":"DashboardHomeUrl","text":"[jvm]\\
@JvmOverloads
constructor(dashboard_slug: String, url: String, dashboardAnnotationKClass: KClass<out Annotation>? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard-annotation-k-class/","title":"dashboardAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/dashboardAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard-annotation-k-class/#dashboardannotationkclass","title":"dashboardAnnotationKClass","text":"[jvm]\\ val dashboardAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/url/","title":"url - Misk","text":"//misk-admin/misk.web.dashboard/DashboardHomeUrl/url
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-home-url/url/#url","title":"url","text":"[jvm]\\ val url: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/","title":"DashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#dashboardmodule","title":"DashboardModule","text":"[jvm]\\ class DashboardModule@JvmOverloadsconstructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf()) : KAbstractModule
Handles installation of Misk Dashboard components (admin dashboard or custom\u2026).
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#constructors","title":"Constructors","text":"DashboardModule [jvm]@JvmOverloadsconstructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf())"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-dashboard-module/","title":"DashboardModule - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-dashboard-module/#dashboardmodule","title":"DashboardModule","text":"[jvm]\\
@JvmOverloads
constructor(dashboardTabProvider: DashboardTabProvider? = null, dashboardTabLoader: DashboardTabLoader? = null, webTabResourceModule: WebTabResourceModule? = null, indexAccessBlocks: List<DashboardIndexAccessBlock> = listOf(), indexBlocks: List<DashboardIndexBlock> = listOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/#functions","title":"Functions","text":"Name Summary addIndexAccessBlocks [jvm]fun addIndexAccessBlocks(vararg blocks: DashboardIndexAccessBlock): DashboardModuleAdd access blocks to dashboard index. addIndexBlocks [jvm]fun addIndexBlocks(vararg blocks: DashboardIndexBlock): DashboardModuleAdd access blocks to dashboard index. createHotwireTab [jvm]inline fun <DA : Annotation, AA : Annotation> createHotwireTab(slug: String, urlPathPrefix: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule createIFrameTab [jvm]inline fun <DA : Annotation, AA : Annotation> createIFrameTab(slug: String, urlPathPrefix: String, resourcePathPrefix: String = \"/_tab/\", iframePath: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule createMenuLink [jvm]inline fun <DA : Annotation, AA : Annotation> createMenuLink(noinline label: (appName: String, deployment: Deployment) -> String, noinline url: (appName: String, deployment: Deployment) -> String, category: String = \"\"): DashboardModuleinline fun <DA : Annotation, AA : Annotation> createMenuLink(label: String, url: String, category: String = \"\"): DashboardModuleCreate menu link with label for url under menu category for a dashboard DA with access AA. createMiskWebDashboard [jvm]inline fun <DA : Annotation, AA : Annotation> createMiskWebDashboard(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModuleInstalls a Misk-Web app for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory. createMiskWebTab [jvm]inline fun <DA : Annotation, AA : Annotation> createMiskWebTab(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", iframePath: String = \"/\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModuleInstalls a Misk-Web tab for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-access-blocks/","title":"addIndexAccessBlocks - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/addIndexAccessBlocks
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-access-blocks/#addindexaccessblocks","title":"addIndexAccessBlocks","text":"[jvm]\\ fun addIndexAccessBlocks(vararg blocks: DashboardIndexAccessBlock): DashboardModule
Add access blocks to dashboard index.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-blocks/","title":"addIndexBlocks - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/addIndexBlocks
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/add-index-blocks/#addindexblocks","title":"addIndexBlocks","text":"[jvm]\\ fun addIndexBlocks(vararg blocks: DashboardIndexBlock): DashboardModule
Add access blocks to dashboard index.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-hotwire-tab/","title":"createHotwireTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createHotwireTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-hotwire-tab/#createhotwiretab","title":"createHotwireTab","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createHotwireTab(slug: String, urlPathPrefix: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-hotwire-tab/#parameters","title":"Parameters","text":"jvm
slug : unique slug to identify the tab namespace, it must match the tab\u2019s corresponding DashboardTab multibinding urlPathPrefix : path prefix which when used in a user\u2019s navigation URL will route to this tab. menuLabel : tab name which appears in the dashboard menu, usually titlecase menuCategory : menu category which the tab appears under"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-i-frame-tab/","title":"createIFrameTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createIFrameTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-i-frame-tab/#createiframetab","title":"createIFrameTab","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createIFrameTab(slug: String, urlPathPrefix: String, resourcePathPrefix: String = \"/_tab/\", iframePath: String, menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-i-frame-tab/#parameters","title":"Parameters","text":"jvm
slug : unique slug to identify the tab namespace, it must match the tab\u2019s corresponding DashboardTab multibinding urlPathPrefix : path prefix which when used in a user\u2019s navigation URL will route to this tab. resourcePathPrefix : path prefix used for background network requests to get resources (HTML, CSS\u2026) for the tab from a resource provider (classpath, filesystem, web proxy\u2026). iframePath : complete path including file and extension if necessary which is set as the iframe src attribute in the generated HTML. name : tab name which appears in the dashboard menu, usually titlecase category : menu category which the tab appears under"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-menu-link/","title":"createMenuLink - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createMenuLink
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-menu-link/#createmenulink","title":"createMenuLink","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createMenuLink(label: String, url: String, category: String = \"\"): DashboardModule
inline fun <DA : Annotation, AA : Annotation> createMenuLink(noinline label: (appName: String, deployment: Deployment) -> String, noinline url: (appName: String, deployment: Deployment) -> String, category: String = \"\"): DashboardModule
Create menu link with label for url under menu category for a dashboard DA with access AA.
If category is empty, it will appear at the top of the menu list.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-dashboard/","title":"createMiskWebDashboard - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createMiskWebDashboard
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-dashboard/#createmiskwebdashboard","title":"createMiskWebDashboard","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createMiskWebDashboard(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
Installs a Misk-Web app for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-tab/","title":"createMiskWebTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardModule/Companion/createMiskWebTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-module/-companion/create-misk-web-tab/#createmiskwebtab","title":"createMiskWebTab","text":"[jvm]\\ inline fun <DA : Annotation, AA : Annotation> createMiskWebTab(isDevelopment: Boolean, slug: String, urlPathPrefix: String, developmentWebProxyUrl: String, resourcePathPrefix: String = \"/_tab/\", classpathResourcePathPrefix: String = \"classpath:/web\", iframePath: String = \"/\", menuLabel: String, menuUrl: String = urlPathPrefix, menuCategory: String = \"Admin\"): DashboardModule
Installs a Misk-Web tab for a dashboard DA with access AA. The tab is identified by a unique slug and is routed to by match on urlPathPrefix. In local development \u2013 when isDevelopment is true, the developmentWebProxyUrl is used to resolve requests to resourcePathPrefix. In real environments, the classpathResourcePathPrefix is used to resolve resource requests to files in classpath. The tab is included in the dashboard navbar menu with menuLabel and in the menu group menuCategory.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/","title":"DashboardTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#dashboardtab","title":"DashboardTab","text":"[jvm]\\ data class DashboardTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val menuLabel: String, val menuCategory: String = \"\", val menuUrl: String = url_path_prefix, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>? = null) : WebTab
A WebTab with additional fields to bind to a specific Dashboard that has a tabs menu
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#constructors","title":"Constructors","text":"DashboardTab [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, dashboard_slug: String, menuLabel: String, menuCategory: String = \"\", menuUrl: String = url_path_prefix, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>? = null)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#properties","title":"Properties","text":"Name Summary accessAnnotationKClass [jvm]val accessAnnotationKClass: KClass<out Annotation>? = null capabilities [jvm]open override val capabilities: Set<String>Set to show the tab only for authenticated capabilities, else shows always dashboard_slug [jvm]val dashboard_slug: StringA slug that identifies which dashboard the tab is installed to, generated from a slugified Dashboard Annotation class simple name dashboardAnnotationKClass [jvm]val dashboardAnnotationKClass: KClass<out Annotation>? = null menuCategory [jvm]val menuCategory: StringA title case category used to group tabs in the dashboard menu menuLabel [jvm]val menuLabel: StringA title case name used in the dashboard menu for the link to the tab menuUrl [jvm]val menuUrl: StringUrl to the tab, by default url_path_prefix services [jvm]open override val services: Set<String>Set to show the tab only for authenticated services, else shows always slug [jvm]open override val slug: StringA unique slug to identify the tab namespace. Note: this slug must match the slug for the tab\u2019s corresponding WebTabResourceModule url_path_prefix [jvm]open override val url_path_prefix: StringA unique url path prefix to namespace tab URLs valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/#functions","title":"Functions","text":"Name Summary toMetadata [jvm]fun DashboardTab.toMetadata(): DashboardMetadataAction.DashboardTabMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/-dashboard-tab/","title":"DashboardTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/DashboardTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/-dashboard-tab/#dashboardtab","title":"DashboardTab","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, dashboard_slug: String, menuLabel: String, menuCategory: String = \"\", menuUrl: String = url_path_prefix, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/access-annotation-k-class/","title":"accessAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/accessAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/access-annotation-k-class/#accessannotationkclass","title":"accessAnnotationKClass","text":"[jvm]\\ val accessAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ open override val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard-annotation-k-class/","title":"dashboardAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/dashboardAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard-annotation-k-class/#dashboardannotationkclass","title":"dashboardAnnotationKClass","text":"[jvm]\\ val dashboardAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-category/","title":"menuCategory - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/menuCategory
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-category/#menucategory","title":"menuCategory","text":"[jvm]\\ val menuCategory: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-label/","title":"menuLabel - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/menuLabel
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-label/#menulabel","title":"menuLabel","text":"[jvm]\\ val menuLabel: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-url/","title":"menuUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/menuUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/menu-url/#menuurl","title":"menuUrl","text":"[jvm]\\ val menuUrl: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/services/","title":"services - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/services/#services","title":"services","text":"[jvm]\\ open override val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/slug/#slug","title":"slug","text":"[jvm]\\ open override val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTab/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ open override val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/","title":"DashboardTabLoader - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#dashboardtabloader","title":"DashboardTabLoader","text":"sealed class DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#inheritors","title":"Inheritors","text":"HotwireTab IframeTab"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#types","title":"Types","text":"Name Summary HotwireTab [jvm]data class HotwireTab(val urlPathPrefix: String) : DashboardTabLoader IframeTab [jvm]data class IframeTab(val urlPathPrefix: String, val iframePath: String) : DashboardTabLoader"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/#properties","title":"Properties","text":"Name Summary urlPathPrefix [jvm]abstract val urlPathPrefix: StringPath prefix which resolves to the tab when visited in the browser."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ abstract val urlPathPrefix: String
Path prefix which resolves to the tab when visited in the browser.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/","title":"HotwireTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/HotwireTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/#hotwiretab","title":"HotwireTab","text":"[jvm]\\ data class HotwireTab(val urlPathPrefix: String) : DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/#constructors","title":"Constructors","text":"HotwireTab [jvm]constructor(urlPathPrefix: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/#properties","title":"Properties","text":"Name Summary urlPathPrefix [jvm]open override val urlPathPrefix: StringPath prefix which resolves to the tab when visited in the browser."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/-hotwire-tab/","title":"HotwireTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/HotwireTab/HotwireTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/-hotwire-tab/#hotwiretab","title":"HotwireTab","text":"[jvm]\\ constructor(urlPathPrefix: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/HotwireTab/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-hotwire-tab/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ open override val urlPathPrefix: String
Path prefix which resolves to the tab when visited in the browser.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/","title":"IframeTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/#iframetab","title":"IframeTab","text":"[jvm]\\ data class IframeTab(val urlPathPrefix: String, val iframePath: String) : DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/#constructors","title":"Constructors","text":"IframeTab [jvm]constructor(urlPathPrefix: String, iframePath: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/#properties","title":"Properties","text":"Name Summary iframePath [jvm]val iframePath: String urlPathPrefix [jvm]open override val urlPathPrefix: StringPath prefix which resolves to the tab when visited in the browser."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/-iframe-tab/","title":"IframeTab - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab/IframeTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/-iframe-tab/#iframetab","title":"IframeTab","text":"[jvm]\\ constructor(urlPathPrefix: String, iframePath: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/iframe-path/","title":"iframePath - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab/iframePath
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/iframe-path/#iframepath","title":"iframePath","text":"[jvm]\\ val iframePath: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoader/IframeTab/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader/-iframe-tab/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ open override val urlPathPrefix: String
Path prefix which resolves to the tab when visited in the browser.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/","title":"DashboardTabLoaderEntry - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/#dashboardtabloaderentry","title":"DashboardTabLoaderEntry","text":"[jvm]\\ data class DashboardTabLoaderEntry(val urlPathPrefix: String, val loader: DashboardTabLoader)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/#constructors","title":"Constructors","text":"DashboardTabLoaderEntry [jvm]constructor(urlPathPrefix: String, loader: DashboardTabLoader)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/#properties","title":"Properties","text":"Name Summary loader [jvm]val loader: DashboardTabLoader urlPathPrefix [jvm]val urlPathPrefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/-dashboard-tab-loader-entry/","title":"DashboardTabLoaderEntry - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry/DashboardTabLoaderEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/-dashboard-tab-loader-entry/#dashboardtabloaderentry","title":"DashboardTabLoaderEntry","text":"[jvm]\\ constructor(urlPathPrefix: String, loader: DashboardTabLoader)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/loader/","title":"loader - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry/loader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/loader/#loader","title":"loader","text":"[jvm]\\ val loader: DashboardTabLoader
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/url-path-prefix/","title":"urlPathPrefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabLoaderEntry/urlPathPrefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-loader-entry/url-path-prefix/#urlpathprefix","title":"urlPathPrefix","text":"[jvm]\\ val urlPathPrefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/","title":"DashboardTabProvider - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#dashboardtabprovider","title":"DashboardTabProvider","text":"[jvm]\\ class DashboardTabProvider@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val menuLabel: (appName: String, deployment: Deployment) -> String, val menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, val menuCategory: String = \"Admin\", val dashboard_slug: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf(), val accessAnnotationKClass: KClass<out Annotation>? = null, val dashboardAnnotationKClass: KClass<out Annotation>) : ValidWebEntry, Provider<DashboardTab>
Sets the tab\u2019s authentication capabilities/services by the multibound AccessAnnotationEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#constructors","title":"Constructors","text":"DashboardTabProvider [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, menuLabel: (appName: String, deployment: Deployment) -> String, menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, menuCategory: String = \"Admin\", dashboard_slug: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#properties","title":"Properties","text":"Name Summary accessAnnotationEntries [jvm]@Injectlateinit var accessAnnotationEntries: List<AccessAnnotationEntry> accessAnnotationKClass [jvm]val accessAnnotationKClass: KClass<out Annotation>? = null appName [jvm]@Injectlateinit var appName: String capabilities [jvm]val capabilities: Set<String> dashboard_slug [jvm]val dashboard_slug: String dashboardAnnotationKClass [jvm]val dashboardAnnotationKClass: KClass<out Annotation> deployment [jvm]@Injectlateinit var deployment: Deployment menuCategory [jvm]val menuCategory: String menuLabel [jvm]val menuLabel: (appName: String, deployment: Deployment) -> String menuUrl [jvm]val menuUrl: (appName: String, deployment: Deployment) -> String services [jvm]val services: Set<String> slug [jvm]val slug: String url_path_prefix [jvm]val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DashboardTab"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/-dashboard-tab-provider/","title":"DashboardTabProvider - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/DashboardTabProvider
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/-dashboard-tab-provider/#dashboardtabprovider","title":"DashboardTabProvider","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, menuLabel: (appName: String, deployment: Deployment) -> String, menuUrl: (appName: String, deployment: Deployment) -> String = { _, _ -> url_path_prefix }, menuCategory: String = \"Admin\", dashboard_slug: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf(), accessAnnotationKClass: KClass<out Annotation>? = null, dashboardAnnotationKClass: KClass<out Annotation>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-entries/","title":"accessAnnotationEntries - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/accessAnnotationEntries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-entries/#accessannotationentries","title":"accessAnnotationEntries","text":"[jvm]\\
@Inject
lateinit var accessAnnotationEntries: List<AccessAnnotationEntry>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-k-class/","title":"accessAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/accessAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/access-annotation-k-class/#accessannotationkclass","title":"accessAnnotationKClass","text":"[jvm]\\ val accessAnnotationKClass: KClass<out Annotation>? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/app-name/","title":"appName - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/appName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/app-name/#appname","title":"appName","text":"[jvm]\\
@Inject
lateinit var appName: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard-annotation-k-class/","title":"dashboardAnnotationKClass - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/dashboardAnnotationKClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard-annotation-k-class/#dashboardannotationkclass","title":"dashboardAnnotationKClass","text":"[jvm]\\ val dashboardAnnotationKClass: KClass<out Annotation>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/deployment/","title":"deployment - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/deployment
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/deployment/#deployment","title":"deployment","text":"[jvm]\\
@Inject
lateinit var deployment: Deployment
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/get/","title":"get - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DashboardTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-category/","title":"menuCategory - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/menuCategory
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-category/#menucategory","title":"menuCategory","text":"[jvm]\\ val menuCategory: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-label/","title":"menuLabel - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/menuLabel
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-label/#menulabel","title":"menuLabel","text":"[jvm]\\ val menuLabel: (appName: String, deployment: Deployment) -> String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-url/","title":"menuUrl - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/menuUrl
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/menu-url/#menuurl","title":"menuUrl","text":"[jvm]\\ val menuUrl: (appName: String, deployment: Deployment) -> String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/services/","title":"services - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/services/#services","title":"services","text":"[jvm]\\ val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/slug/#slug","title":"slug","text":"[jvm]\\ val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/DashboardTabProvider/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-dashboard-tab-provider/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/","title":"MiskWebColor - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#miskwebcolor","title":"MiskWebColor","text":"[jvm]\\ enum MiskWebColor : Enum<MiskWebColor>
Matches the Misk-Web Color enum in @misk/core/src/utilities/css.ts
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#entries","title":"Entries","text":"RED [jvm]RED ORANGE [jvm]ORANGE YELLOW [jvm]YELLOW LIME [jvm]LIME GREEN [jvm]GREEN TEAL [jvm]TEAL BLUE [jvm]BLUE INDIGO [jvm]INDIGO PURPLE [jvm]PURPLE PLUM [jvm]PLUM ROSE [jvm]ROSE CHARCOAL [jvm]CHARCOAL TEXT [jvm]TEXT GRAY [jvm]GRAY ACCENT [jvm]ACCENT WHITE [jvm]WHITE CADET [jvm]CADET SILVER [jvm]SILVER PLATINUM [jvm]PLATINUM"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<MiskWebColor>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): MiskWebColorReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<MiskWebColor>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/entries/","title":"entries - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/entries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<MiskWebColor>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/hex-color/","title":"hexColor - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/hexColor
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/hex-color/#hexcolor","title":"hexColor","text":"[jvm]\\ val hexColor: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/value-of/","title":"valueOf - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/valueOf
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): MiskWebColor
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/values/","title":"values - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/values
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<MiskWebColor>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-a-c-c-e-n-t/","title":"ACCENT - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/ACCENT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-a-c-c-e-n-t/#accent","title":"ACCENT","text":"[jvm]\\ ACCENT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-a-c-c-e-n-t/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-b-l-u-e/","title":"BLUE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/BLUE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-b-l-u-e/#blue","title":"BLUE","text":"[jvm]\\ BLUE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-b-l-u-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-a-d-e-t/","title":"CADET - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/CADET
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-a-d-e-t/#cadet","title":"CADET","text":"[jvm]\\ CADET
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-a-d-e-t/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-h-a-r-c-o-a-l/","title":"CHARCOAL - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/CHARCOAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-h-a-r-c-o-a-l/#charcoal","title":"CHARCOAL","text":"[jvm]\\ CHARCOAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-c-h-a-r-c-o-a-l/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-a-y/","title":"GRAY - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/GRAY
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-a-y/#gray","title":"GRAY","text":"[jvm]\\ GRAY
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-a-y/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-e-e-n/","title":"GREEN - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/GREEN
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-e-e-n/#green","title":"GREEN","text":"[jvm]\\ GREEN
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-g-r-e-e-n/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-i-n-d-i-g-o/","title":"INDIGO - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/INDIGO
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-i-n-d-i-g-o/#indigo","title":"INDIGO","text":"[jvm]\\ INDIGO
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-i-n-d-i-g-o/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-l-i-m-e/","title":"LIME - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/LIME
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-l-i-m-e/#lime","title":"LIME","text":"[jvm]\\ LIME
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-l-i-m-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-o-r-a-n-g-e/","title":"ORANGE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/ORANGE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-o-r-a-n-g-e/#orange","title":"ORANGE","text":"[jvm]\\ ORANGE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-o-r-a-n-g-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-a-t-i-n-u-m/","title":"PLATINUM - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/PLATINUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-a-t-i-n-u-m/#platinum","title":"PLATINUM","text":"[jvm]\\ PLATINUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-a-t-i-n-u-m/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-u-m/","title":"PLUM - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/PLUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-u-m/#plum","title":"PLUM","text":"[jvm]\\ PLUM
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-l-u-m/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-u-r-p-l-e/","title":"PURPLE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/PURPLE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-u-r-p-l-e/#purple","title":"PURPLE","text":"[jvm]\\ PURPLE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-p-u-r-p-l-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-e-d/","title":"RED - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/RED
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-e-d/#red","title":"RED","text":"[jvm]\\ RED
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-e-d/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-o-s-e/","title":"ROSE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/ROSE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-o-s-e/#rose","title":"ROSE","text":"[jvm]\\ ROSE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-r-o-s-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-s-i-l-v-e-r/","title":"SILVER - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/SILVER
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-s-i-l-v-e-r/#silver","title":"SILVER","text":"[jvm]\\ SILVER
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-s-i-l-v-e-r/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-a-l/","title":"TEAL - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/TEAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-a-l/#teal","title":"TEAL","text":"[jvm]\\ TEAL
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-a-l/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-x-t/","title":"TEXT - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/TEXT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-x-t/#text","title":"TEXT","text":"[jvm]\\ TEXT
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-t-e-x-t/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-w-h-i-t-e/","title":"WHITE - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/WHITE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-w-h-i-t-e/#white","title":"WHITE","text":"[jvm]\\ WHITE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-w-h-i-t-e/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-y-e-l-l-o-w/","title":"YELLOW - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebColor/YELLOW
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-y-e-l-l-o-w/#yellow","title":"YELLOW","text":"[jvm]\\ YELLOW
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-color/-y-e-l-l-o-w/#properties","title":"Properties","text":"Name Summary hexColor [jvm]val hexColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/","title":"MiskWebTabIndexAction - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#miskwebtabindexaction","title":"MiskWebTabIndexAction","text":"[jvm]\\ @Singleton
class MiskWebTabIndexAction@Injectconstructor(dashboardTabs: List<DashboardTab>) : WebAction
Kotlin backed tab loader, equivalent to /_tab/slug/index.html
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#constructors","title":"Constructors","text":"MiskWebTabIndexAction [jvm]@Injectconstructor(dashboardTabs: List<DashboardTab>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(slug: String?): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-misk-web-tab-index-action/","title":"MiskWebTabIndexAction - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/MiskWebTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-misk-web-tab-index-action/#miskwebtabindexaction","title":"MiskWebTabIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardTabs: List<DashboardTab>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(slug: String?): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//misk-admin/misk.web.dashboard/MiskWebTabIndexAction/Companion/PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-misk-web-tab-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/","title":"WebTab - Misk","text":"//misk-admin/misk.web.dashboard/WebTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#webtab","title":"WebTab","text":"open class WebTab@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val capabilities: Set<String> = setOf(), val services: Set<String> = setOf()) : ValidWebEntry
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#inheritors","title":"Inheritors","text":"DashboardTab"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#constructors","title":"Constructors","text":"WebTab [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf())"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/#properties","title":"Properties","text":"Name Summary capabilities [jvm]open val capabilities: Set<String> services [jvm]open val services: Set<String> slug [jvm]open val slug: String url_path_prefix [jvm]open val url_path_prefix: String valid_slug [jvm]val valid_slug: String valid_url_path_prefix [jvm]val valid_url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/-web-tab/","title":"WebTab - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/WebTab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/-web-tab/#webtab","title":"WebTab","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, capabilities: Set<String> = setOf(), services: Set<String> = setOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ open val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/services/","title":"services - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/services/#services","title":"services","text":"[jvm]\\ open val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/slug/#slug","title":"slug","text":"[jvm]\\ open val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/WebTab/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ open val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/","title":"WebTabResourceModule - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#webtabresourcemodule","title":"WebTabResourceModule","text":"[jvm]\\ class WebTabResourceModule@JvmOverloadsconstructor(isDevelopment: Boolean = false, val slug: String, val web_proxy_url: String? = null, val url_path_prefix: String = \"/_tab/\", val resourcePath: String = \"classpath:/web/_tab/\") : KAbstractModule
Declare how to serve the resources for a WebTab (JS, HTML, CSS\u2026)
In Development environment, requests are proxied through to a local running build server. In all other environments, resource requests are served from the classpath.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#constructors","title":"Constructors","text":"WebTabResourceModule [jvm]constructor(deployment: Deployment, slug: String, web_proxy_url: String, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")@JvmOverloadsconstructor(isDevelopment: Boolean = false, slug: String, web_proxy_url: String? = null, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#properties","title":"Properties","text":"Name Summary resourcePath [jvm]val resourcePath: StringJVM path for non-Development environment static resources (includesclasspath:/ prefix) slug [jvm]val slug: StringA unique slug to identify the tab namespace, it must match the tab\u2019s corresponding DashboardTab multibinding url_path_prefix [jvm]val url_path_prefix: StringURL namespace used to determine where to route requests with that url prefix By Misk-Web convention, the prefix for tabs is /_tab/{slug}/ to prevent namespace collisions with dashboard urls such as /_admin/ or /app/ since path routing is by url prefix. web_proxy_url [jvm]val web_proxy_url: String? = nulla fully qualified url for the development build server (includes http:// prefix)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/-web-tab-resource-module/","title":"WebTabResourceModule - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/WebTabResourceModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/-web-tab-resource-module/#webtabresourcemodule","title":"WebTabResourceModule","text":"[jvm]\\ constructor(deployment: Deployment, slug: String, web_proxy_url: String, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")
@JvmOverloads
constructor(isDevelopment: Boolean = false, slug: String, web_proxy_url: String? = null, url_path_prefix: String = \"/_tab/\", resourcePath: String = \"classpath:/web/_tab/\")
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/resource-path/","title":"resourcePath - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/resourcePath
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/resource-path/#resourcepath","title":"resourcePath","text":"[jvm]\\ val resourcePath: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/slug/#slug","title":"slug","text":"[jvm]\\ val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/web_proxy_url/","title":"web_proxy_url - Misk","text":"//misk-admin/misk.web.dashboard/WebTabResourceModule/web_proxy_url
"},{"location":"0.x/misk-admin/misk-admin/misk.web.dashboard/-web-tab-resource-module/web_proxy_url/#web_proxy_url","title":"web_proxy_url","text":"[jvm]\\ val web_proxy_url: String? = null
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/#types","title":"Types","text":"Name Summary DashboardMetadataAction [jvm]@Singletonclass DashboardMetadataAction@Injectconstructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>) : WebActionServe metadata related to a Misk-Web Dashboard ServiceMetadataAction [jvm]@Singletonclass ServiceMetadataAction@Injectconstructor(optionalBinder: ServiceMetadataAction.OptionalBinder) : WebActionService Metadata used for front end dashboards including App Name and Misk.Deployment name"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/","title":"DashboardMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#dashboardmetadataaction","title":"DashboardMetadataAction","text":"[jvm]\\ @Singleton
class DashboardMetadataAction@Injectconstructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>) : WebAction
Serve metadata related to a Misk-Web Dashboard
Multiple dashboards with Misk-Web tabs can be bound by binding tabs to a different Dashboard Annotation. For example, all tabs used in the Misk Admin Dashboard are bound with the AdminDashboard annotation; tabs used in a service front end app, like Backfila, would be bound with a \"BackfilaApp\" annotation.
Dashboard related metadata is multibound with the slug that corresponds to a Dashboard Annotation. DashboardMetadataAction returns only the metadata for the requested dashboard.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#constructors","title":"Constructors","text":"DashboardMetadataAction [jvm]@Injectconstructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#types","title":"Types","text":"Name Summary DashboardMetadata [jvm]data class DashboardMetadata@JvmOverloadsconstructor(val home_url: String = \"\", val navbar_items: List<String> = listOf(), val navbar_status: String = \"\", val tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), val theme: MiskWebTheme? = null) DashboardTabMetadata [jvm]data class DashboardTabMetadata@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val name: String, val category: String = \"\", val capabilities: Set<String> = setOf(), val services: Set<String> = setOf()) Response [jvm]data class Response@JvmOverloadsconstructor(val dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(dashboard_slug: String): DashboardMetadataAction.Response getDashboardMetadata [jvm]fun getDashboardMetadata(caller: MiskCaller?, dashboardSlug: String): DashboardMetadataAction.DashboardMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata-action/","title":"DashboardMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata-action/#dashboardmetadataaction","title":"DashboardMetadataAction","text":"[jvm]\\
@Inject
constructor(allTabs: List<DashboardTab>, allNavbarItems: List<DashboardNavbarItem>, allNavbarStatus: List<DashboardNavbarStatus>, allHomeUrls: List<DashboardHomeUrl>, allThemes: List<DashboardTheme>, callerProvider: ActionScoped<MiskCaller?>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(dashboard_slug: String): DashboardMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-dashboard-metadata/","title":"getDashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/getDashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/get-dashboard-metadata/#getdashboardmetadata","title":"getDashboardMetadata","text":"[jvm]\\ fun getDashboardMetadata(caller: MiskCaller?, dashboardSlug: String): DashboardMetadataAction.DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/","title":"DashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/#dashboardmetadata","title":"DashboardMetadata","text":"[jvm]\\ data class DashboardMetadata@JvmOverloadsconstructor(val home_url: String = \"\", val navbar_items: List<String> = listOf(), val navbar_status: String = \"\", val tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), val theme: MiskWebTheme? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/#constructors","title":"Constructors","text":"DashboardMetadata [jvm]@JvmOverloadsconstructor(home_url: String = \"\", navbar_items: List<String> = listOf(), navbar_status: String = \"\", tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), theme: MiskWebTheme? = null)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/#properties","title":"Properties","text":"Name Summary home_url [jvm]val home_url: String navbar_items [jvm]val navbar_items: List<String> navbar_status [jvm]val navbar_status: String tabs [jvm]val tabs: List<DashboardMetadataAction.DashboardTabMetadata> theme [jvm]val theme: MiskWebTheme? = nullIf null, uses default theme that ships with Misk-Web"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/-dashboard-metadata/","title":"DashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/-dashboard-metadata/#dashboardmetadata","title":"DashboardMetadata","text":"[jvm]\\
@JvmOverloads
constructor(home_url: String = \"\", navbar_items: List<String> = listOf(), navbar_status: String = \"\", tabs: List<DashboardMetadataAction.DashboardTabMetadata> = listOf(), theme: MiskWebTheme? = null)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/home_url/","title":"home_url - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/home_url
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/home_url/#home_url","title":"home_url","text":"[jvm]\\ val home_url: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_items/","title":"navbar_items - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/navbar_items
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_items/#navbar_items","title":"navbar_items","text":"[jvm]\\ val navbar_items: List<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_status/","title":"navbar_status - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/navbar_status
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/navbar_status/#navbar_status","title":"navbar_status","text":"[jvm]\\ val navbar_status: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/tabs/","title":"tabs - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/tabs
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/tabs/#tabs","title":"tabs","text":"[jvm]\\ val tabs: List<DashboardMetadataAction.DashboardTabMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/theme/","title":"theme - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardMetadata/theme
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-metadata/theme/#theme","title":"theme","text":"[jvm]\\ val theme: MiskWebTheme? = null
If null, uses default theme that ships with Misk-Web
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/","title":"DashboardTabMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#dashboardtabmetadata","title":"DashboardTabMetadata","text":"[jvm]\\ data class DashboardTabMetadata@JvmOverloadsconstructor(val slug: String, val url_path_prefix: String, val dashboard_slug: String, val name: String, val category: String = \"\", val capabilities: Set<String> = setOf(), val services: Set<String> = setOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#constructors","title":"Constructors","text":"DashboardTabMetadata [jvm]@JvmOverloadsconstructor(slug: String, url_path_prefix: String, dashboard_slug: String, name: String, category: String = \"\", capabilities: Set<String> = setOf(), services: Set<String> = setOf())"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/#properties","title":"Properties","text":"Name Summary capabilities [jvm]val capabilities: Set<String> category [jvm]val category: String dashboard_slug [jvm]val dashboard_slug: String name [jvm]val name: String services [jvm]val services: Set<String> slug [jvm]val slug: String url_path_prefix [jvm]val url_path_prefix: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-dashboard-tab-metadata/","title":"DashboardTabMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/DashboardTabMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-dashboard-tab-metadata/#dashboardtabmetadata","title":"DashboardTabMetadata","text":"[jvm]\\
@JvmOverloads
constructor(slug: String, url_path_prefix: String, dashboard_slug: String, name: String, category: String = \"\", capabilities: Set<String> = setOf(), services: Set<String> = setOf())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/capabilities/","title":"capabilities - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/capabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/capabilities/#capabilities","title":"capabilities","text":"[jvm]\\ val capabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/category/","title":"category - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/category
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/category/#category","title":"category","text":"[jvm]\\ val category: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/dashboard_slug/","title":"dashboard_slug - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/dashboard_slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/dashboard_slug/#dashboard_slug","title":"dashboard_slug","text":"[jvm]\\ val dashboard_slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/services/","title":"services - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/services
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/services/#services","title":"services","text":"[jvm]\\ val services: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/slug/","title":"slug - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/slug
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/slug/#slug","title":"slug","text":"[jvm]\\ val slug: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/url_path_prefix/","title":"url_path_prefix - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/url_path_prefix
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/url_path_prefix/#url_path_prefix","title":"url_path_prefix","text":"[jvm]\\ val url_path_prefix: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/#functions","title":"Functions","text":"Name Summary toMetadata [jvm]fun DashboardTab.toMetadata(): DashboardMetadataAction.DashboardTabMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/to-metadata/","title":"toMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/DashboardTabMetadata/Companion/toMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-dashboard-tab-metadata/-companion/to-metadata/#tometadata","title":"toMetadata","text":"[jvm]\\ fun DashboardTab.toMetadata(): DashboardMetadataAction.DashboardTabMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response@JvmOverloadsconstructor(val dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]@JvmOverloadsconstructor(dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/#properties","title":"Properties","text":"Name Summary dashboardMetadata [jvm]val dashboardMetadata: DashboardMetadataAction.DashboardMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\
@JvmOverloads
constructor(dashboardMetadata: DashboardMetadataAction.DashboardMetadata = DashboardMetadata())
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/dashboard-metadata/","title":"dashboardMetadata - Misk","text":"//misk-admin/misk.web.metadata/DashboardMetadataAction/Response/dashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-dashboard-metadata-action/-response/dashboard-metadata/#dashboardmetadata","title":"dashboardMetadata","text":"[jvm]\\ val dashboardMetadata: DashboardMetadataAction.DashboardMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/","title":"ServiceMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#servicemetadataaction","title":"ServiceMetadataAction","text":"[jvm]\\ @Singleton
class ServiceMetadataAction@Injectconstructor(optionalBinder: ServiceMetadataAction.OptionalBinder) : WebAction
Service Metadata used for front end dashboards including App Name and Misk.Deployment name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#constructors","title":"Constructors","text":"ServiceMetadataAction [jvm]@Injectconstructor(optionalBinder: ServiceMetadataAction.OptionalBinder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#types","title":"Types","text":"Name Summary OptionalBinder [jvm]@Singletonclass OptionalBinder@Injectconstructor(val appName: String, deployment: Deployment)https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor Response [jvm]data class Response(val serviceMetadata: ServiceMetadataAction.ServiceMetadata) ServiceMetadata [jvm]data class ServiceMetadata(val app_name: String, val environment: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(): ServiceMetadataAction.Response"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata-action/","title":"ServiceMetadataAction - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata-action/#servicemetadataaction","title":"ServiceMetadataAction","text":"[jvm]\\
@Inject
constructor(optionalBinder: ServiceMetadataAction.OptionalBinder)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(): ServiceMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\ @Singleton
class OptionalBinder@Injectconstructor(val appName: String, deployment: Deployment)
https://github.com/google/guice/wiki/FrequentlyAskedQuestions#how-can-i-inject-optional-parameters-into-a-constructor
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/#constructors","title":"Constructors","text":"OptionalBinder [jvm]@Injectconstructor(appName: String, deployment: Deployment)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/#properties","title":"Properties","text":"Name Summary appName [jvm]val appName: String serviceMetadata [jvm]@Inject(optional = true)var serviceMetadata: ServiceMetadataAction.ServiceMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/-optional-binder/","title":"OptionalBinder - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder/OptionalBinder
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/-optional-binder/#optionalbinder","title":"OptionalBinder","text":"[jvm]\\
@Inject
constructor(appName: String, deployment: Deployment)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/app-name/","title":"appName - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder/appName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/app-name/#appname","title":"appName","text":"[jvm]\\ val appName: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/service-metadata/","title":"serviceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/OptionalBinder/serviceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-optional-binder/service-metadata/#servicemetadata","title":"serviceMetadata","text":"[jvm]\\
@Inject(optional = true)
var serviceMetadata: ServiceMetadataAction.ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val serviceMetadata: ServiceMetadataAction.ServiceMetadata)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(serviceMetadata: ServiceMetadataAction.ServiceMetadata)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/#properties","title":"Properties","text":"Name Summary serviceMetadata [jvm]val serviceMetadata: ServiceMetadataAction.ServiceMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(serviceMetadata: ServiceMetadataAction.ServiceMetadata)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/service-metadata/","title":"serviceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/Response/serviceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-response/service-metadata/#servicemetadata","title":"serviceMetadata","text":"[jvm]\\ val serviceMetadata: ServiceMetadataAction.ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/","title":"ServiceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/#servicemetadata","title":"ServiceMetadata","text":"[jvm]\\ data class ServiceMetadata(val app_name: String, val environment: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/#constructors","title":"Constructors","text":"ServiceMetadata [jvm]constructor(app_name: String, environment: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/#properties","title":"Properties","text":"Name Summary app_name [jvm]val app_name: String environment [jvm]val environment: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/-service-metadata/","title":"ServiceMetadata - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata/ServiceMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/-service-metadata/#servicemetadata","title":"ServiceMetadata","text":"[jvm]\\ constructor(app_name: String, environment: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/app_name/","title":"app_name - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata/app_name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/app_name/#app_name","title":"app_name","text":"[jvm]\\ val app_name: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/environment/","title":"environment - Misk","text":"//misk-admin/misk.web.metadata/ServiceMetadataAction/ServiceMetadata/environment
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata/-service-metadata-action/-service-metadata/environment/#environment","title":"environment","text":"[jvm]\\ val environment: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.all
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/#types","title":"Types","text":"Name Summary AllMetadataAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AllMetadataAccessBind to set access for the exposed service metadata. AllMetadataAction [jvm]@Singletonclass AllMetadataAction@Injectconstructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>) : WebAction AllMetadataModule [jvm]class AllMetadataModule : KAbstractModuleThis exposes extensive metadata about your Misk application via API and admin dashboard."},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-access/","title":"AllMetadataAccess - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAccess
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-access/#allmetadataaccess","title":"AllMetadataAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class AllMetadataAccess
Bind to set access for the exposed service metadata.
// Give internal scraping services access to all metadata for the service\nmultibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<AllMetadataAccess>(\n services = listOf(\"internal_security_scraper_service\"))\n)\n//misk-admin/misk.web.metadata.all/AllMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#allmetadataaction","title":"AllMetadataAction","text":"[jvm]\\ @Singleton
class AllMetadataAction@Injectconstructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>) : WebAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#constructors","title":"Constructors","text":"AllMetadataAction [jvm]@Injectconstructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Response [jvm]data class Response(val all: Map<String, Metadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]@JvmOverloadsfun getAll(id: String? = null): AllMetadataAction.Response"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-all-metadata-action/","title":"AllMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/AllMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-all-metadata-action/#allmetadataaction","title":"AllMetadataAction","text":"[jvm]\\
@Inject
constructor(allMetadata: Map<String, @JvmSuppressWildcardsProvider<Metadata>>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\
@JvmOverloads
fun getAll(id: String? = null): AllMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Companion/PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val all: Map<String, Metadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(all: Map<String, Metadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/#properties","title":"Properties","text":"Name Summary all [jvm]val all: Map<String, Metadata>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(all: Map<String, Metadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/all/","title":"all - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataAction/Response/all
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-action/-response/all/#all","title":"all","text":"[jvm]\\ val all: Map<String, Metadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-module/","title":"AllMetadataModule - Misk","text":"//misk-admin/misk.web.metadata.all/AllMetadataModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-module/#allmetadatamodule","title":"AllMetadataModule","text":"[jvm]\\ class AllMetadataModule : KAbstractModule
This exposes extensive metadata about your Misk application via API and admin dashboard.
To install and use, ensure you also add an AccessAnnotationEntry to grant endpoint access.
multibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<AllMetadataAccess>(\n services = listOf(\"security-service\")\n )\n)\n//misk-admin/misk.web.metadata.all/AllMetadataModule/AllMetadataModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.all/-all-metadata-module/-all-metadata-module/#allmetadatamodule","title":"AllMetadataModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.config
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/#types","title":"Types","text":"Name Summary ConfigDashboardTabModule [jvm]class ConfigDashboardTabModule@JvmOverloadsconstructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE) : KAbstractModuleInstalls Config dashboard tab which shows the raw config inputs and the merged runtime config for your Misk service. ConfigMetadataAction [jvm]@Singletonclass ConfigMetadataAction@Injectconstructor : WebAction"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/","title":"ConfigDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/#configdashboardtabmodule","title":"ConfigDashboardTabModule","text":"[jvm]\\ class ConfigDashboardTabModule@JvmOverloadsconstructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE) : KAbstractModule
Installs Config dashboard tab which shows the raw config inputs and the merged runtime config for your Misk service.
mode If you have config parameters that include secrets, you should only install this tab in SAFE mode because the Misk secrets will be visible at runtime in the admin dashboard.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/#constructors","title":"Constructors","text":"ConfigDashboardTabModule [jvm]@JvmOverloadsconstructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/-config-dashboard-tab-module/","title":"ConfigDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigDashboardTabModule/ConfigDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-dashboard-tab-module/-config-dashboard-tab-module/#configdashboardtabmodule","title":"ConfigDashboardTabModule","text":"[jvm]\\
@JvmOverloads
constructor(isDevelopment: Boolean, mode: ConfigMetadataAction.ConfigTabMode = SAFE)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/","title":"ConfigMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/#configmetadataaction","title":"ConfigMetadataAction","text":"[jvm]\\ @Singleton
class ConfigMetadataAction@Injectconstructor : WebAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/#constructors","title":"Constructors","text":"ConfigMetadataAction [jvm]@Injectconstructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/#types","title":"Types","text":"Name Summary ConfigTabMode [jvm]enum ConfigTabMode : Enum<ConfigMetadataAction.ConfigTabMode>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-metadata-action/","title":"ConfigMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-metadata-action/#configmetadataaction","title":"ConfigMetadataAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/","title":"ConfigTabMode - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#configtabmode","title":"ConfigTabMode","text":"[jvm]\\ enum ConfigTabMode : Enum<ConfigMetadataAction.ConfigTabMode>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#entries","title":"Entries","text":"SAFE [jvm]SAFEOnly show safe content which will not leak Misk secrets SHOW_REDACTED_EFFECTIVE_CONFIG [jvm]SHOW_REDACTED_EFFECTIVE_CONFIGShow redacted effective config loaded into application, risk of leak if sensitive non-Secret fields don\u2019t have @misk.config.Redact annotation manually added. UNSAFE_LEAK_MISK_SECRETS [jvm]UNSAFE_LEAK_MISK_SECRETSShows all possible resources, YAML files are not redacted"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<ConfigMetadataAction.ConfigTabMode>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): ConfigMetadataAction.ConfigTabModeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<ConfigMetadataAction.ConfigTabMode>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/entries/","title":"entries - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/entries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<ConfigMetadataAction.ConfigTabMode>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/value-of/","title":"valueOf - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/valueOf
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): ConfigMetadataAction.ConfigTabMode
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/values/","title":"values - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/values
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<ConfigMetadataAction.ConfigTabMode>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-a-f-e/","title":"SAFE - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/SAFE
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-a-f-e/#safe","title":"SAFE","text":"[jvm]\\ SAFE
Only show safe content which will not leak Misk secrets
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-a-f-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-h-o-w_-r-e-d-a-c-t-e-d_-e-f-f-e-c-t-i-v-e_-c-o-n-f-i-g/","title":"SHOW_REDACTED_EFFECTIVE_CONFIG - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/SHOW_REDACTED_EFFECTIVE_CONFIG
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-h-o-w_-r-e-d-a-c-t-e-d_-e-f-f-e-c-t-i-v-e_-c-o-n-f-i-g/#show_redacted_effective_config","title":"SHOW_REDACTED_EFFECTIVE_CONFIG","text":"[jvm]\\ SHOW_REDACTED_EFFECTIVE_CONFIG
Show redacted effective config loaded into application, risk of leak if sensitive non-Secret fields don\u2019t have @misk.config.Redact annotation manually added.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-s-h-o-w_-r-e-d-a-c-t-e-d_-e-f-f-e-c-t-i-v-e_-c-o-n-f-i-g/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-u-n-s-a-f-e_-l-e-a-k_-m-i-s-k_-s-e-c-r-e-t-s/","title":"UNSAFE_LEAK_MISK_SECRETS - Misk","text":"//misk-admin/misk.web.metadata.config/ConfigMetadataAction/ConfigTabMode/UNSAFE_LEAK_MISK_SECRETS
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-u-n-s-a-f-e_-l-e-a-k_-m-i-s-k_-s-e-c-r-e-t-s/#unsafe_leak_misk_secrets","title":"UNSAFE_LEAK_MISK_SECRETS","text":"[jvm]\\ UNSAFE_LEAK_MISK_SECRETS
Shows all possible resources, YAML files are not redacted
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.config/-config-metadata-action/-config-tab-mode/-u-n-s-a-f-e_-l-e-a-k_-m-i-s-k_-s-e-c-r-e-t-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.database
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/#types","title":"Types","text":"Name Summary DatabaseDashboardTabModule [jvm]class DatabaseDashboardTabModule(isDevelopment: Boolean) : KAbstractModuleInstalls Database dashboard tab which allows querying the database from a UI form. DatabaseQueryFunctionMetadata [jvm]interface DatabaseQueryFunctionMetadata DatabaseQueryMetadata [jvm]data class DatabaseQueryMetadata@JvmOverloadsconstructor(val queryWebActionPath: String, val allowedCapabilities: Set<String> = setOf(), val allowedServices: Set<String> = setOf(), val accessAnnotation: String?, val table: String, val entityClass: String, val entitySchema: Map<String, String>, val queryClass: String, val constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, val orders: List<DatabaseQueryMetadata.OrderMetadata>, val selects: List<DatabaseQueryMetadata.SelectMetadata>, val types: Map<String, MiskWebFormBuilder.Type>)Metadata front end model for Database Query Misk-Web Tab DatabaseQueryMetadataAction [jvm]@Singletonclass DatabaseQueryMetadataAction@Injectconstructor(val metadata: List<DatabaseQueryMetadata>) : WebActionDisplay available queries and their types NoAdminDashboardDatabaseAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class NoAdminDashboardDatabaseAccess"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/","title":"DatabaseDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/#databasedashboardtabmodule","title":"DatabaseDashboardTabModule","text":"[jvm]\\ class DatabaseDashboardTabModule(isDevelopment: Boolean) : KAbstractModule
Installs Database dashboard tab which allows querying the database from a UI form.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/#constructors","title":"Constructors","text":"DatabaseDashboardTabModule [jvm]constructor(isDevelopment: Boolean)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/-database-dashboard-tab-module/","title":"DatabaseDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseDashboardTabModule/DatabaseDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-dashboard-tab-module/-database-dashboard-tab-module/#databasedashboardtabmodule","title":"DatabaseDashboardTabModule","text":"[jvm]\\ constructor(isDevelopment: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/","title":"DatabaseQueryFunctionMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/#databasequeryfunctionmetadata","title":"DatabaseQueryFunctionMetadata","text":"interface DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/#inheritors","title":"Inheritors","text":"ConstraintMetadata OrderMetadata SelectMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/#properties","title":"Properties","text":"Name Summary name [jvm]abstract val name: StringFunction simple name parametersTypeName [jvm]abstract val parametersTypeName: StringString Type that identifies the parameters signature for the function"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryFunctionMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/name/#name","title":"name","text":"[jvm]\\ abstract val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryFunctionMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-function-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ abstract val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/","title":"DatabaseQueryMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#databasequerymetadata","title":"DatabaseQueryMetadata","text":"[jvm]\\ data class DatabaseQueryMetadata@JvmOverloadsconstructor(val queryWebActionPath: String, val allowedCapabilities: Set<String> = setOf(), val allowedServices: Set<String> = setOf(), val accessAnnotation: String?, val table: String, val entityClass: String, val entitySchema: Map<String, String>, val queryClass: String, val constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, val orders: List<DatabaseQueryMetadata.OrderMetadata>, val selects: List<DatabaseQueryMetadata.SelectMetadata>, val types: Map<String, MiskWebFormBuilder.Type>)
Metadata front end model for Database Query Misk-Web Tab
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#constructors","title":"Constructors","text":"DatabaseQueryMetadata [jvm]constructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: KClass<out Annotation>? = null, table: String, entityClass: KClass<>, entitySchema: Map<String, KType>, queryClass: KClass<>?, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)@JvmOverloadsconstructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: String?, table: String, entityClass: String, entitySchema: Map<String, String>, queryClass: String, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ConstraintMetadata [jvm]data class ConstraintMetadata(val name: String, val parametersTypeName: String, val path: String, val operator: String) : DatabaseQueryFunctionMetadata OrderMetadata [jvm]data class OrderMetadata(val name: String, val parametersTypeName: String, val path: String, val ascending: Boolean) : DatabaseQueryFunctionMetadata SelectMetadata [jvm]data class SelectMetadata(val name: String, val parametersTypeName: String, val paths: List<String>) : DatabaseQueryFunctionMetadata"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/#properties","title":"Properties","text":"Name Summary accessAnnotation [jvm]val accessAnnotation: String? allowedCapabilities [jvm]val allowedCapabilities: Set<String> allowedServices [jvm]val allowedServices: Set<String> constraints [jvm]val constraints: List<DatabaseQueryMetadata.ConstraintMetadata> entityClass [jvm]val entityClass: StringDbTable entity class entitySchema [jvm]val entitySchema: Map<String, String>Describe the DbEntity with types orders [jvm]val orders: List<DatabaseQueryMetadata.OrderMetadata> queryClass [jvm]val queryClass: StringQuery class queryWebActionPath [jvm]val queryWebActionPath: String selects [jvm]val selects: List<DatabaseQueryMetadata.SelectMetadata> table [jvm]val table: StringSQL table name types [jvm]val types: Map<String, MiskWebFormBuilder.Type>Contains all Types across all queries"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-database-query-metadata/","title":"DatabaseQueryMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/DatabaseQueryMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-database-query-metadata/#databasequerymetadata","title":"DatabaseQueryMetadata","text":"[jvm]\\ constructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: KClass<out Annotation>? = null, table: String, entityClass: KClass<>, entitySchema: Map<String, KType>, queryClass: KClass<>?, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)
@JvmOverloads
constructor(queryWebActionPath: String, allowedCapabilities: Set<String> = setOf(), allowedServices: Set<String> = setOf(), accessAnnotation: String?, table: String, entityClass: String, entitySchema: Map<String, String>, queryClass: String, constraints: List<DatabaseQueryMetadata.ConstraintMetadata>, orders: List<DatabaseQueryMetadata.OrderMetadata>, selects: List<DatabaseQueryMetadata.SelectMetadata>, types: Map<String, MiskWebFormBuilder.Type>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/access-annotation/","title":"accessAnnotation - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/accessAnnotation
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/access-annotation/#accessannotation","title":"accessAnnotation","text":"[jvm]\\ val accessAnnotation: String?
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-capabilities/","title":"allowedCapabilities - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/allowedCapabilities
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-capabilities/#allowedcapabilities","title":"allowedCapabilities","text":"[jvm]\\ val allowedCapabilities: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-services/","title":"allowedServices - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/allowedServices
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/allowed-services/#allowedservices","title":"allowedServices","text":"[jvm]\\ val allowedServices: Set<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/constraints/","title":"constraints - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/constraints
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/constraints/#constraints","title":"constraints","text":"[jvm]\\ val constraints: List<DatabaseQueryMetadata.ConstraintMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-class/","title":"entityClass - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/entityClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-class/#entityclass","title":"entityClass","text":"[jvm]\\ val entityClass: String
DbTable entity class
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-schema/","title":"entitySchema - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/entitySchema
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/entity-schema/#entityschema","title":"entitySchema","text":"[jvm]\\ val entitySchema: Map<String, String>
Describe the DbEntity with types
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/orders/","title":"orders - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/orders
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/orders/#orders","title":"orders","text":"[jvm]\\ val orders: List<DatabaseQueryMetadata.OrderMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-class/","title":"queryClass - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/queryClass
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-class/#queryclass","title":"queryClass","text":"[jvm]\\ val queryClass: String
Query class
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-web-action-path/","title":"queryWebActionPath - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/queryWebActionPath
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/query-web-action-path/#querywebactionpath","title":"queryWebActionPath","text":"[jvm]\\ val queryWebActionPath: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/selects/","title":"selects - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/selects
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/selects/#selects","title":"selects","text":"[jvm]\\ val selects: List<DatabaseQueryMetadata.SelectMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/table/","title":"table - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/table
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/table/#table","title":"table","text":"[jvm]\\ val table: String
SQL table name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/types/","title":"types - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/types
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/types/#types","title":"types","text":"[jvm]\\ val types: Map<String, MiskWebFormBuilder.Type>
Contains all Types across all queries
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/#properties","title":"Properties","text":"Name Summary DYNAMIC_QUERY_KCLASS_SUFFIX [jvm]const val DYNAMIC_QUERY_KCLASS_SUFFIX: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/-d-y-n-a-m-i-c_-q-u-e-r-y_-k-c-l-a-s-s_-s-u-f-f-i-x/","title":"DYNAMIC_QUERY_KCLASS_SUFFIX - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/Companion/DYNAMIC_QUERY_KCLASS_SUFFIX
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-companion/-d-y-n-a-m-i-c_-q-u-e-r-y_-k-c-l-a-s-s_-s-u-f-f-i-x/#dynamic_query_kclass_suffix","title":"DYNAMIC_QUERY_KCLASS_SUFFIX","text":"[jvm]\\ const val DYNAMIC_QUERY_KCLASS_SUFFIX: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/","title":"ConstraintMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/#constraintmetadata","title":"ConstraintMetadata","text":"[jvm]\\ data class ConstraintMetadata(val name: String, val parametersTypeName: String, val path: String, val operator: String) : DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/#constructors","title":"Constructors","text":"ConstraintMetadata [jvm]constructor(name: String, parametersTypeName: String, path: String, operator: String)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: StringFunction simple name operator [jvm]val operator: String parametersTypeName [jvm]open override val parametersTypeName: StringString Type that identifies the parameters signature for the function path [jvm]val path: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/-constraint-metadata/","title":"ConstraintMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/ConstraintMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/-constraint-metadata/#constraintmetadata","title":"ConstraintMetadata","text":"[jvm]\\ constructor(name: String, parametersTypeName: String, path: String, operator: String)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/name/#name","title":"name","text":"[jvm]\\ open override val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/operator/","title":"operator - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/operator
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/operator/#operator","title":"operator","text":"[jvm]\\ val operator: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ open override val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/path/","title":"path - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/ConstraintMetadata/path
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-constraint-metadata/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/","title":"OrderMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/#ordermetadata","title":"OrderMetadata","text":"[jvm]\\ data class OrderMetadata(val name: String, val parametersTypeName: String, val path: String, val ascending: Boolean) : DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/#constructors","title":"Constructors","text":"OrderMetadata [jvm]constructor(name: String, parametersTypeName: String, path: String, ascending: Boolean)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/#properties","title":"Properties","text":"Name Summary ascending [jvm]val ascending: Boolean name [jvm]open override val name: StringFunction simple name parametersTypeName [jvm]open override val parametersTypeName: StringString Type that identifies the parameters signature for the function path [jvm]val path: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/-order-metadata/","title":"OrderMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/OrderMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/-order-metadata/#ordermetadata","title":"OrderMetadata","text":"[jvm]\\ constructor(name: String, parametersTypeName: String, path: String, ascending: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/ascending/","title":"ascending - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/ascending
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/ascending/#ascending","title":"ascending","text":"[jvm]\\ val ascending: Boolean
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/name/#name","title":"name","text":"[jvm]\\ open override val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ open override val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/path/","title":"path - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/OrderMetadata/path
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-order-metadata/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/","title":"SelectMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/#selectmetadata","title":"SelectMetadata","text":"[jvm]\\ data class SelectMetadata(val name: String, val parametersTypeName: String, val paths: List<String>) : DatabaseQueryFunctionMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/#constructors","title":"Constructors","text":"SelectMetadata [jvm]constructor(name: String, parametersTypeName: String, paths: List<String>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: StringFunction simple name parametersTypeName [jvm]open override val parametersTypeName: StringString Type that identifies the parameters signature for the function paths [jvm]val paths: List<String>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/-select-metadata/","title":"SelectMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/SelectMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/-select-metadata/#selectmetadata","title":"SelectMetadata","text":"[jvm]\\ constructor(name: String, parametersTypeName: String, paths: List<String>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/name/","title":"name - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/name/#name","title":"name","text":"[jvm]\\ open override val name: String
Function simple name
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/parameters-type-name/","title":"parametersTypeName - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/parametersTypeName
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/parameters-type-name/#parameterstypename","title":"parametersTypeName","text":"[jvm]\\ open override val parametersTypeName: String
String Type that identifies the parameters signature for the function
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/paths/","title":"paths - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadata/SelectMetadata/paths
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata/-select-metadata/paths/#paths","title":"paths","text":"[jvm]\\ val paths: List<String>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/","title":"DatabaseQueryMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#databasequerymetadataaction","title":"DatabaseQueryMetadataAction","text":"[jvm]\\ @Singleton
class DatabaseQueryMetadataAction@Injectconstructor(val metadata: List<DatabaseQueryMetadata>) : WebAction
Display available queries and their types
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#constructors","title":"Constructors","text":"DatabaseQueryMetadataAction [jvm]@Injectconstructor(metadata: List<DatabaseQueryMetadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#types","title":"Types","text":"Name Summary Response [jvm]data class Response(val databaseQueryMetadata: List<DatabaseQueryMetadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#properties","title":"Properties","text":"Name Summary metadata [jvm]val metadata: List<DatabaseQueryMetadata>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/#functions","title":"Functions","text":"Name Summary getAll [jvm]fun getAll(): DatabaseQueryMetadataAction.Response"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-database-query-metadata-action/","title":"DatabaseQueryMetadataAction - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/DatabaseQueryMetadataAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-database-query-metadata-action/#databasequerymetadataaction","title":"DatabaseQueryMetadataAction","text":"[jvm]\\
@Inject
constructor(metadata: List<DatabaseQueryMetadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/get-all/","title":"getAll - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/getAll
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/get-all/#getall","title":"getAll","text":"[jvm]\\ fun getAll(): DatabaseQueryMetadataAction.Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/metadata/","title":"metadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/metadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/metadata/#metadata","title":"metadata","text":"[jvm]\\ val metadata: List<DatabaseQueryMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/#response","title":"Response","text":"[jvm]\\ data class Response(val databaseQueryMetadata: List<DatabaseQueryMetadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(databaseQueryMetadata: List<DatabaseQueryMetadata>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/#properties","title":"Properties","text":"Name Summary databaseQueryMetadata [jvm]val databaseQueryMetadata: List<DatabaseQueryMetadata>"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/-response/","title":"Response - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/Response/Response
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(databaseQueryMetadata: List<DatabaseQueryMetadata>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/database-query-metadata/","title":"databaseQueryMetadata - Misk","text":"//misk-admin/misk.web.metadata.database/DatabaseQueryMetadataAction/Response/databaseQueryMetadata
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-database-query-metadata-action/-response/database-query-metadata/#databasequerymetadata","title":"databaseQueryMetadata","text":"[jvm]\\ val databaseQueryMetadata: List<DatabaseQueryMetadata>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-no-admin-dashboard-database-access/","title":"NoAdminDashboardDatabaseAccess - Misk","text":"//misk-admin/misk.web.metadata.database/NoAdminDashboardDatabaseAccess
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.database/-no-admin-dashboard-database-access/#noadmindashboarddatabaseaccess","title":"NoAdminDashboardDatabaseAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class NoAdminDashboardDatabaseAccess
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.guice
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/#types","title":"Types","text":"Name Summary GuiceDashboardTabModule [jvm]class GuiceDashboardTabModule : KAbstractModule GuiceTabIndexAction [jvm]@Singletonclass GuiceTabIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider) : WebAction"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/","title":"GuiceDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/#guicedashboardtabmodule","title":"GuiceDashboardTabModule","text":"[jvm]\\ class GuiceDashboardTabModule : KAbstractModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/#constructors","title":"Constructors","text":"GuiceDashboardTabModule [jvm]constructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/-guice-dashboard-tab-module/","title":"GuiceDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceDashboardTabModule/GuiceDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-dashboard-tab-module/-guice-dashboard-tab-module/#guicedashboardtabmodule","title":"GuiceDashboardTabModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/","title":"GuiceTabIndexAction - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#guicetabindexaction","title":"GuiceTabIndexAction","text":"[jvm]\\ @Singleton
class GuiceTabIndexAction@Injectconstructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider) : WebAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#constructors","title":"Constructors","text":"GuiceTabIndexAction [jvm]@Injectconstructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-guice-tab-index-action/","title":"GuiceTabIndexAction - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/GuiceTabIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-guice-tab-index-action/#guicetabindexaction","title":"GuiceTabIndexAction","text":"[jvm]\\
@Inject
constructor(dashboardPageLayout: DashboardPageLayout, guiceMetadataProvider: GuiceMetadataProvider)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/#properties","title":"Properties","text":"Name Summary PATH [jvm]const val PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/-p-a-t-h/","title":"PATH - Misk","text":"//misk-admin/misk.web.metadata.guice/GuiceTabIndexAction/Companion/PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.guice/-guice-tab-index-action/-companion/-p-a-t-h/#path","title":"PATH","text":"[jvm]\\ const val PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/","title":"Package-level declarations - Misk","text":"//misk-admin/misk.web.metadata.webaction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/#types","title":"Types","text":"Name Summary WebActionsDashboardTabModule [jvm]class WebActionsDashboardTabModule(isDevelopment: Boolean) : KAbstractModuleInstalls WebActions dashboard tab which allows introspection and exercising actions from a UI form."},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/","title":"WebActionsDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.webaction/WebActionsDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/#webactionsdashboardtabmodule","title":"WebActionsDashboardTabModule","text":"[jvm]\\ class WebActionsDashboardTabModule(isDevelopment: Boolean) : KAbstractModule
Installs WebActions dashboard tab which allows introspection and exercising actions from a UI form.
This installs both versions of the WebActions tab, v1 and v2.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/#constructors","title":"Constructors","text":"WebActionsDashboardTabModule [jvm]constructor(isDevelopment: Boolean)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/-web-actions-dashboard-tab-module/","title":"WebActionsDashboardTabModule - Misk","text":"//misk-admin/misk.web.metadata.webaction/WebActionsDashboardTabModule/WebActionsDashboardTabModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.metadata.webaction/-web-actions-dashboard-tab-module/-web-actions-dashboard-tab-module/#webactionsdashboardtabmodule","title":"WebActionsDashboardTabModule","text":"[jvm]\\ constructor(isDevelopment: Boolean)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/","title":"Index","text":"//misk-admin/misk.web.v2
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/#types","title":"Types","text":"Name Summary DashboardHotwireTabAction [jvm]@Singletonclass DashboardHotwireTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebActionBuilds dashboard UI and loads Hotwire tab. DashboardIFrameTabAction [jvm]@Singletonclass DashboardIFrameTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebActionBuilds dashboard UI and loads IFrame tab. DashboardIndexAccessBlock [jvm]data class DashboardIndexAccessBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit)Bind to set custom access notice for the dashboard home page. DashboardIndexAction [jvm]@Singletonclass DashboardIndexAction@Injectconstructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment) : WebActionBuilds dashboard UI for index homepage. DashboardIndexBlock [jvm]data class DashboardIndexBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.() -> Unit)Bind to set custom content for the dashboard home page. DashboardPageLayout [jvm]class DashboardPageLayout@Injectconstructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)Builds dashboard UI for index homepage. NavbarModule [jvm]class NavbarModule : KAbstractModule"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/#functions","title":"Functions","text":"Name Summary DashboardIndexAccessBlock [jvm]inline fun <T : Annotation> DashboardIndexAccessBlock(noinline block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit): DashboardIndexAccessBlock DashboardIndexBlock [jvm]inline fun <T : Annotation> DashboardIndexBlock(noinline block: TagConsumer<*>.() -> Unit): DashboardIndexBlock HtmlLayout [jvm]fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)Default setup of HTML for a page including head and install of CSS/JS dependencies."},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/","title":"DashboardIndexAccessBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/#dashboardindexaccessblock","title":"DashboardIndexAccessBlock","text":"[jvm]\\ inline fun <T : Annotation> DashboardIndexAccessBlock(noinline block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit): DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/","title":"DashboardIndexBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/#dashboardindexblock","title":"DashboardIndexBlock","text":"[jvm]\\ inline fun <T : Annotation> DashboardIndexBlock(noinline block: TagConsumer<*>.() -> Unit): DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-html-layout/","title":"html layout","text":"//misk-admin/misk.web.v2/HtmlLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-html-layout/#htmllayout","title":"HtmlLayout","text":"[jvm]\\ fun TagConsumer<>.HtmlLayout(appRoot: String, title: String, playCdn: Boolean, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)
Default setup of HTML for a page including head and install of CSS/JS dependencies.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/","title":"DashboardHotwireTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardHotwireTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/#dashboardhotwiretabaction","title":"DashboardHotwireTabAction","text":"[jvm]\\ @Singleton
class DashboardHotwireTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebAction
Builds dashboard UI and loads Hotwire tab.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/#constructors","title":"Constructors","text":"DashboardHotwireTabAction [jvm]@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(suffix: String?): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/-dashboard-hotwire-tab-action/","title":"DashboardHotwireTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardHotwireTabAction/DashboardHotwireTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/-dashboard-hotwire-tab-action/#dashboardhotwiretabaction","title":"DashboardHotwireTabAction","text":"[jvm]\\
@Inject
constructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.v2/DashboardHotwireTabAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-hotwire-tab-action/get/#get","title":"get","text":"[jvm]\\ fun get(suffix: String?): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/","title":"DashboardIFrameTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIFrameTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/#dashboardiframetabaction","title":"DashboardIFrameTabAction","text":"[jvm]\\ @Singleton
class DashboardIFrameTabAction@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>) : WebAction
Builds dashboard UI and loads IFrame tab.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/#constructors","title":"Constructors","text":"DashboardIFrameTabAction [jvm]@Injectconstructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(suffix: String?): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/-dashboard-i-frame-tab-action/","title":"DashboardIFrameTabAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIFrameTabAction/DashboardIFrameTabAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/-dashboard-i-frame-tab-action/#dashboardiframetabaction","title":"DashboardIFrameTabAction","text":"[jvm]\\
@Inject
constructor(clientHttpCall: ActionScoped<HttpCall>, dashboardPageLayout: DashboardPageLayout, entries: List<DashboardTabLoaderEntry>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.v2/DashboardIFrameTabAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-i-frame-tab-action/get/#get","title":"get","text":"[jvm]\\ fun get(suffix: String?): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/","title":"DashboardIndexAccessBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/#dashboardindexaccessblock","title":"DashboardIndexAccessBlock","text":"[jvm]\\ data class DashboardIndexAccessBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit)
Bind to set custom access notice for the dashboard home page.
multibind<DashboardIndexAccessBlock>().toInstance(\n DashboardIndexAccessBlock<AdminDashboard>() {\n p { +\"\"\"You have access to ${authenticatedTabs.size} / ${dashboardTabs.size} tabs.\"\"\" }\n p { +\"\"\"Add the necessary permissions to your user in the company registry.\"\"\" }\n }\n)\n//misk-admin/misk.web.v2/DashboardIndexAccessBlock/DashboardIndexAccessBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/-dashboard-index-access-block/#dashboardindexaccessblock","title":"DashboardIndexAccessBlock","text":"[jvm]\\
@JvmOverloads
constructor(annotation: KClass<out Annotation>, block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/annotation/","title":"annotation - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock/annotation
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: KClass<out Annotation>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/block/","title":"block - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAccessBlock/block
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-access-block/block/#block","title":"block","text":"[jvm]\\ val block: TagConsumer<*>.(appName: String, deployment: Deployment, caller: MiskCaller?, authenticatedTabs: List<DashboardTab>, dashboardTabs: List<DashboardTab>) -> Unit
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/","title":"DashboardIndexAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#dashboardindexaction","title":"DashboardIndexAction","text":"[jvm]\\ @Singleton
class DashboardIndexAction@Injectconstructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment) : WebAction
Builds dashboard UI for index homepage.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#constructors","title":"Constructors","text":"DashboardIndexAction [jvm]@Injectconstructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/#functions","title":"Functions","text":"Name Summary get [jvm]fun get(): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-dashboard-index-action/","title":"DashboardIndexAction - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/DashboardIndexAction
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-dashboard-index-action/#dashboardindexaction","title":"DashboardIndexAction","text":"[jvm]\\
@Inject
constructor(callerProvider: ActionScoped<MiskCaller?>, dashboardPageLayout: DashboardPageLayout, allTabs: List<DashboardTab>, allDashboardIndexAccessBlocks: List<DashboardIndexAccessBlock>, allDashboardIndexBlocks: List<DashboardIndexBlock>, deployment: Deployment)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/get/","title":"get - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/get
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/get/#get","title":"get","text":"[jvm]\\ fun get(): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/#functions","title":"Functions","text":"Name Summary titlecase [jvm]fun KClass<out Annotation>.titlecase(): String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/titlecase/","title":"titlecase - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexAction/Companion/titlecase
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-action/-companion/titlecase/#titlecase","title":"titlecase","text":"[jvm]\\ fun KClass<out Annotation>.titlecase(): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/","title":"DashboardIndexBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/#dashboardindexblock","title":"DashboardIndexBlock","text":"[jvm]\\ data class DashboardIndexBlock@JvmOverloadsconstructor(val annotation: KClass<out Annotation>, val block: TagConsumer<*>.() -> Unit)
Bind to set custom content for the dashboard home page.
multibind<DashboardIndexBlock>().toInstance(\n DashboardIndexBlock(\n p { +\"\"\"This content will show up on the dashboard homepage.\"\"\" }\n )\n)\n//misk-admin/misk.web.v2/DashboardIndexBlock/DashboardIndexBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/-dashboard-index-block/#dashboardindexblock","title":"DashboardIndexBlock","text":"[jvm]\\
@JvmOverloads
constructor(annotation: KClass<out Annotation>, block: TagConsumer<*>.() -> Unit)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/annotation/","title":"annotation - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock/annotation
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/annotation/#annotation","title":"annotation","text":"[jvm]\\ val annotation: KClass<out Annotation>
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/block/","title":"block - Misk","text":"//misk-admin/misk.web.v2/DashboardIndexBlock/block
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-index-block/block/#block","title":"block","text":"[jvm]\\ val block: TagConsumer<*>.() -> Unit
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/","title":"Index","text":"//misk-admin/misk.web.v2/DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#dashboardpagelayout","title":"DashboardPageLayout","text":"[jvm]\\ class DashboardPageLayout@Injectconstructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)
Builds dashboard UI for index homepage.
Must be called within a Web Action.
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#constructors","title":"Constructors","text":"DashboardPageLayout [jvm]@Injectconstructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/#functions","title":"Functions","text":"Name Summary build [jvm]@JvmOverloadsfun build(tabBlock: TagConsumer<*>.(appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> Unit = { _, _, _ -> Unit }): String headBlock [jvm]fun headBlock(block: TagConsumer<*>.() -> Unit): DashboardPageLayout newBuilder [jvm]fun newBuilder(): DashboardPageLayout title [jvm]fun title(title: (appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> String): DashboardPageLayout"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-dashboard-page-layout/","title":"DashboardPageLayout - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-dashboard-page-layout/#dashboardpagelayout","title":"DashboardPageLayout","text":"[jvm]\\
@Inject
constructor(allHomeUrls: List<DashboardHomeUrl>, appName: String, allNavbarItem: List<DashboardNavbarItem>, allTabs: List<DashboardTab>, callerProvider: ActionScoped<MiskCaller?>, deployment: Deployment, clientHttpCall: ActionScoped<HttpCall>)
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/build/","title":"build - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/build
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/build/#build","title":"build","text":"[jvm]\\
@JvmOverloads
fun build(tabBlock: TagConsumer<*>.(appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> Unit = { _, _, _ -> Unit }): String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/head-block/","title":"headBlock - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/headBlock
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/head-block/#headblock","title":"headBlock","text":"[jvm]\\ fun headBlock(block: TagConsumer<*>.() -> Unit): DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/new-builder/","title":"newBuilder - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/newBuilder
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ fun newBuilder(): DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/title/","title":"Title","text":"//misk-admin/misk.web.v2/DashboardPageLayout/title
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/title/#title","title":"title","text":"[jvm]\\ fun title(title: (appName: String, dashboardHomeUrl: DashboardHomeUrl?, dashboardTab: DashboardTab?) -> String): DashboardPageLayout
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/","title":"Companion - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/#properties","title":"Properties","text":"Name Summary ADMIN_DASHBOARD_PATH [jvm]const val ADMIN_DASHBOARD_PATH: String"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/-a-d-m-i-n_-d-a-s-h-b-o-a-r-d_-p-a-t-h/","title":"ADMIN_DASHBOARD_PATH - Misk","text":"//misk-admin/misk.web.v2/DashboardPageLayout/Companion/ADMIN_DASHBOARD_PATH
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-dashboard-page-layout/-companion/-a-d-m-i-n_-d-a-s-h-b-o-a-r-d_-p-a-t-h/#admin_dashboard_path","title":"ADMIN_DASHBOARD_PATH","text":"[jvm]\\ const val ADMIN_DASHBOARD_PATH: String
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/","title":"NavbarModule - Misk","text":"//misk-admin/misk.web.v2/NavbarModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/#navbarmodule","title":"NavbarModule","text":"[jvm]\\ class NavbarModule : KAbstractModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/#constructors","title":"Constructors","text":"NavbarModule [jvm]constructor()"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/-navbar-module/","title":"NavbarModule - Misk","text":"//misk-admin/misk.web.v2/NavbarModule/NavbarModule
"},{"location":"0.x/misk-admin/misk-admin/misk.web.v2/-navbar-module/-navbar-module/#navbarmodule","title":"NavbarModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-api/","title":"misk-api - Misk","text":"//misk-api
"},{"location":"0.x/misk-api/#misk-api","title":"misk-api","text":""},{"location":"0.x/misk-api/#packages","title":"Packages","text":"Name misk.annotation misk.api misk.client misk.logging misk.scope misk.web misk.web.dashboard"},{"location":"0.x/misk-api/misk-api/misk.annotation/","title":"Package-level declarations - Misk","text":"//misk-api/misk.annotation
"},{"location":"0.x/misk-api/misk-api/misk.annotation/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.annotation/#types","title":"Types","text":"Name Summary ExperimentalMiskApi [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])annotation class ExperimentalMiskApiMarks declarations that are experimental and subject to change without following SemVer conventions. Both binary and source-incompatible changes are possible, including complete removal of the experimental API."},{"location":"0.x/misk-api/misk-api/misk.annotation/-experimental-misk-api/","title":"ExperimentalMiskApi - Misk","text":"//misk-api/misk.annotation/ExperimentalMiskApi
"},{"location":"0.x/misk-api/misk-api/misk.annotation/-experimental-misk-api/#experimentalmiskapi","title":"ExperimentalMiskApi","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalMiskApi
Marks declarations that are experimental and subject to change without following SemVer conventions. Both binary and source-incompatible changes are possible, including complete removal of the experimental API.
Do not use these APIs in modules that may be executed using a version of Misk different from the version the module was compiled with.
Do not use these APIs in published libraries.
Do not use these APIs if you aren\u2019t willing to track changes to them.
"},{"location":"0.x/misk-api/misk-api/misk.api/","title":"Package-level declarations - Misk","text":"//misk-api/misk.api
"},{"location":"0.x/misk-api/misk-api/misk.api/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.api/#types","title":"Types","text":"Name Summary HttpRequest [jvm]interface HttpRequestRepresents the current incoming request. Misk makes an instance of this interface available in the action scope with theHttpRequest key, for use in interceptors, other action scope providers, etc.."},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/","title":"HttpRequest - Misk","text":"//misk-api/misk.api/HttpRequest
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/#httprequest","title":"HttpRequest","text":"[jvm]\\ interface HttpRequest
Represents the current incoming request. Misk makes an instance of this interface available in the action scope with the HttpRequest key, for use in interceptors, other action scope providers, etc..
//misk-api/misk.api/HttpRequest/dispatchMechanism
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"[jvm]\\ abstract val dispatchMechanism: DispatchMechanism
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/request-headers/","title":"requestHeaders - Misk","text":"//misk-api/misk.api/HttpRequest/requestHeaders
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/request-headers/#requestheaders","title":"requestHeaders","text":"[jvm]\\ abstract var requestHeaders: Headers
HTTP request headers that may be modified via interception.
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/url/","title":"url - Misk","text":"//misk-api/misk.api/HttpRequest/url
"},{"location":"0.x/misk-api/misk-api/misk.api/-http-request/url/#url","title":"url","text":"[jvm]\\ abstract val url: HttpUrl
"},{"location":"0.x/misk-api/misk-api/misk.client/","title":"Package-level declarations - Misk","text":"//misk-api/misk.client
"},{"location":"0.x/misk-api/misk-api/misk.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.client/#types","title":"Types","text":"Name Summary ClientAction [jvm]data class ClientAction(val name: String, val function: KFunction<*>, val parameterTypes: List<KType>, val returnType: KType)Metadata about a client action ClientNetworkChain [jvm]interface ClientNetworkChain ClientNetworkInterceptor [jvm]interface ClientNetworkInterceptorIntercepts client side calls at the application level, able to view and modify the outgoing HTTP request and observe the returned HTTP response NetworkInterceptorWrapper [jvm]class NetworkInterceptorWrapper(val action: ClientAction, val interceptor: ClientNetworkInterceptor) : Interceptor"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/","title":"ClientAction - Misk","text":"//misk-api/misk.client/ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/#clientaction","title":"ClientAction","text":"[jvm]\\ data class ClientAction(val name: String, val function: KFunction<*>, val parameterTypes: List<KType>, val returnType: KType)
Metadata about a client action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/#constructors","title":"Constructors","text":"ClientAction [jvm]constructor(clientName: String, method: KFunction<>)constructor(name: String, function: KFunction<>, parameterTypes: List<KType>, returnType: KType)"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/#properties","title":"Properties","text":"Name Summary function [jvm]val function: KFunction<*>The function that was used to invoke the action name [jvm]val name: StringThe name of the action, composed of the name of the client + the name of the method parameterTypes [jvm]val parameterTypes: List<KType>The parameter types to the action returnType [jvm]val returnType: KTypeThe return type fo the action"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/-client-action/","title":"ClientAction - Misk","text":"//misk-api/misk.client/ClientAction/ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/-client-action/#clientaction","title":"ClientAction","text":"[jvm]\\ constructor(clientName: String, method: KFunction<*>)
constructor(name: String, function: KFunction<*>, parameterTypes: List<KType>, returnType: KType)
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/function/","title":"function - Misk","text":"//misk-api/misk.client/ClientAction/function
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/function/#function","title":"function","text":"[jvm]\\ val function: KFunction<*>
The function that was used to invoke the action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/name/","title":"name - Misk","text":"//misk-api/misk.client/ClientAction/name
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/name/#name","title":"name","text":"[jvm]\\ val name: String
The name of the action, composed of the name of the client + the name of the method
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/parameter-types/","title":"parameterTypes - Misk","text":"//misk-api/misk.client/ClientAction/parameterTypes
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/parameter-types/#parametertypes","title":"parameterTypes","text":"[jvm]\\ val parameterTypes: List<KType>
The parameter types to the action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/return-type/","title":"returnType - Misk","text":"//misk-api/misk.client/ClientAction/returnType
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-action/return-type/#returntype","title":"returnType","text":"[jvm]\\ val returnType: KType
The return type fo the action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/","title":"ClientNetworkChain - Misk","text":"//misk-api/misk.client/ClientNetworkChain
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/#clientnetworkchain","title":"ClientNetworkChain","text":"[jvm]\\ interface ClientNetworkChain
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/#properties","title":"Properties","text":"Name Summary action [jvm]abstract val action: ClientAction request [jvm]abstract val request: Request"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/#functions","title":"Functions","text":"Name Summary proceed [jvm]abstract fun proceed(request: Request): Response"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/action/","title":"action - Misk","text":"//misk-api/misk.client/ClientNetworkChain/action
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/action/#action","title":"action","text":"[jvm]\\ abstract val action: ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/proceed/","title":"proceed - Misk","text":"//misk-api/misk.client/ClientNetworkChain/proceed
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/proceed/#proceed","title":"proceed","text":"[jvm]\\ abstract fun proceed(request: Request): Response
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/request/","title":"request - Misk","text":"//misk-api/misk.client/ClientNetworkChain/request
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-chain/request/#request","title":"request","text":"[jvm]\\ abstract val request: Request
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/","title":"ClientNetworkInterceptor - Misk","text":"//misk-api/misk.client/ClientNetworkInterceptor
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/#clientnetworkinterceptor","title":"ClientNetworkInterceptor","text":"[jvm]\\ interface ClientNetworkInterceptor
Intercepts client side calls at the application level, able to view and modify the outgoing HTTP request and observe the returned HTTP response
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryThis interface is used with Guice multibindings. Register instances by callingmultibind() in a KAbstractModule:"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]abstract fun intercept(chain: ClientNetworkChain): Response"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/intercept/","title":"intercept - Misk","text":"//misk-api/misk.client/ClientNetworkInterceptor/intercept
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ abstract fun intercept(chain: ClientNetworkChain): Response
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/-factory/","title":"Factory - Misk","text":"//misk-api/misk.client/ClientNetworkInterceptor/Factory
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ interface Factory
This interface is used with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<ClientNetworkInterceptor.Factory>().to<MyFactory>()\n//misk-api/misk.client/ClientNetworkInterceptor/Factory/create
"},{"location":"0.x/misk-api/misk-api/misk.client/-client-network-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ abstract fun create(action: ClientAction): ClientNetworkInterceptor?
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/","title":"NetworkInterceptorWrapper - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#networkinterceptorwrapper","title":"NetworkInterceptorWrapper","text":"[jvm]\\ class NetworkInterceptorWrapper(val action: ClientAction, val interceptor: ClientNetworkInterceptor) : Interceptor
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#constructors","title":"Constructors","text":"NetworkInterceptorWrapper [jvm]constructor(action: ClientAction, interceptor: ClientNetworkInterceptor)"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#properties","title":"Properties","text":"Name Summary action [jvm]val action: ClientAction interceptor [jvm]val interceptor: ClientNetworkInterceptor"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): Response"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/-network-interceptor-wrapper/","title":"NetworkInterceptorWrapper - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/NetworkInterceptorWrapper
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/-network-interceptor-wrapper/#networkinterceptorwrapper","title":"NetworkInterceptorWrapper","text":"[jvm]\\ constructor(action: ClientAction, interceptor: ClientNetworkInterceptor)
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/action/","title":"action - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/action
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/action/#action","title":"action","text":"[jvm]\\ val action: ClientAction
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/intercept/","title":"intercept - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/intercept
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/interceptor/","title":"interceptor - Misk","text":"//misk-api/misk.client/NetworkInterceptorWrapper/interceptor
"},{"location":"0.x/misk-api/misk-api/misk.client/-network-interceptor-wrapper/interceptor/#interceptor","title":"interceptor","text":"[jvm]\\ val interceptor: ClientNetworkInterceptor
"},{"location":"0.x/misk-api/misk-api/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-api/misk.logging
"},{"location":"0.x/misk-api/misk-api/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.logging/#types","title":"Types","text":"Name Summary Mdc [jvm]interface Mdc"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/","title":"Mdc - Misk","text":"//misk-api/misk.logging/Mdc
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/#mdc","title":"Mdc","text":"[jvm]\\ interface Mdc
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/#functions","title":"Functions","text":"Name Summary clear [jvm]abstract fun clear() get [jvm]abstract fun get(key: String): String? put [jvm]abstract fun put(key: String, value: String?)"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/clear/","title":"clear - Misk","text":"//misk-api/misk.logging/Mdc/clear
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/clear/#clear","title":"clear","text":"[jvm]\\ abstract fun clear()
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/get/","title":"get - Misk","text":"//misk-api/misk.logging/Mdc/get
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/get/#get","title":"get","text":"[jvm]\\ abstract fun get(key: String): String?
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/put/","title":"put - Misk","text":"//misk-api/misk.logging/Mdc/put
"},{"location":"0.x/misk-api/misk-api/misk.logging/-mdc/put/#put","title":"put","text":"[jvm]\\ abstract fun put(key: String, value: String?)
"},{"location":"0.x/misk-api/misk-api/misk.scope/","title":"Package-level declarations - Misk","text":"//misk-api/misk.scope
"},{"location":"0.x/misk-api/misk-api/misk.scope/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.scope/#types","title":"Types","text":"Name Summary ActionScoped [jvm]interface ActionScoped<out T>Provides access to a context object specific to the current action ActionScopedProvider [jvm]interface ActionScopedProvider<out T>An ActionScopedProvider is implemented by components and application code that wants provide contextual information based on an incoming request, job data, etc."},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/","title":"ActionScoped - Misk","text":"//misk-api/misk.scope/ActionScoped
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/#actionscoped","title":"ActionScoped","text":"[jvm]\\ interface ActionScoped<out T>
Provides access to a context object specific to the current action
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(): T getIfInScope [jvm]open fun getIfInScope(): T?"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get-if-in-scope/","title":"getIfInScope - Misk","text":"//misk-api/misk.scope/ActionScoped/getIfInScope
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get-if-in-scope/#getifinscope","title":"getIfInScope","text":"[jvm]\\ open fun getIfInScope(): T?
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get/","title":"get - Misk","text":"//misk-api/misk.scope/ActionScoped/get
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/get/#get","title":"get","text":"[jvm]\\ abstract fun get(): T
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/","title":"Companion - Misk","text":"//misk-api/misk.scope/ActionScoped/Companion
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/#functions","title":"Functions","text":"Name Summary of [jvm]fun <T> of(value: T): ActionScoped<T>"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/of/","title":"of - Misk","text":"//misk-api/misk.scope/ActionScoped/Companion/of
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/of/#of","title":"of","text":"[jvm]\\ fun <T> of(value: T): ActionScoped<T>
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped/-companion/of/#return","title":"Return","text":"an ActionScoped hard-coded to a specific value, useful for tests
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/","title":"ActionScopedProvider - Misk","text":"//misk-api/misk.scope/ActionScopedProvider
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/#actionscopedprovider","title":"ActionScopedProvider","text":"[jvm]\\ interface ActionScopedProvider<out T>
An ActionScopedProvider is implemented by components and application code that wants provide contextual information based on an incoming request, job data, etc.
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(): T"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/get/","title":"get - Misk","text":"//misk-api/misk.scope/ActionScopedProvider/get
"},{"location":"0.x/misk-api/misk-api/misk.scope/-action-scoped-provider/get/#get","title":"get","text":"[jvm]\\ abstract fun get(): T
"},{"location":"0.x/misk-api/misk-api/misk.web/","title":"Package-level declarations - Misk","text":"//misk-api/misk.web
"},{"location":"0.x/misk-api/misk-api/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.web/#types","title":"Types","text":"Name Summary DispatchMechanism [jvm]enum DispatchMechanism : Enum<DispatchMechanism> Describes how an action is processed. This is like the HTTP method but has special cases for web sockets and gRPC. These protocols layer on top of HTTP methods and have different semantics."},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/","title":"DispatchMechanism - Misk","text":"//misk-api/misk.web/DispatchMechanism
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#dispatchmechanism","title":"DispatchMechanism","text":"[jvm]\\ enum DispatchMechanism : Enum<DispatchMechanism>
Describes how an action is processed. This is like the HTTP method but has special cases for web sockets and gRPC. These protocols layer on top of HTTP methods and have different semantics.
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#entries","title":"Entries","text":"GET [jvm]GET POST [jvm]POST PATCH [jvm]PATCH PUT [jvm]PUT DELETE [jvm]DELETE GRPC [jvm]GRPC WEBSOCKET [jvm]WEBSOCKET"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<DispatchMechanism>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): DispatchMechanismReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<DispatchMechanism>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/entries/","title":"entries - Misk","text":"//misk-api/misk.web/DispatchMechanism/entries
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<DispatchMechanism>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/method/","title":"method - Misk","text":"//misk-api/misk.web/DispatchMechanism/method
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/method/#method","title":"method","text":"[jvm]\\ val method: String
Returns the method used when a call entered the service.
This can be misleading: web sockets don\u2019t behave like normal GETs (they are upgraded), and GRPC calls don\u2019t behave like normal POSTS (they are duplex).
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/value-of/","title":"valueOf - Misk","text":"//misk-api/misk.web/DispatchMechanism/valueOf
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): DispatchMechanism
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/values/","title":"values - Misk","text":"//misk-api/misk.web/DispatchMechanism/values
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<DispatchMechanism>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-d-e-l-e-t-e/","title":"DELETE - Misk","text":"//misk-api/misk.web/DispatchMechanism/DELETE
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-d-e-l-e-t-e/#delete","title":"DELETE","text":"[jvm]\\ DELETE
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-d-e-l-e-t-e/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-e-t/","title":"GET - Misk","text":"//misk-api/misk.web/DispatchMechanism/GET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-e-t/#get","title":"GET","text":"[jvm]\\ GET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-e-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-r-p-c/","title":"GRPC - Misk","text":"//misk-api/misk.web/DispatchMechanism/GRPC
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-r-p-c/#grpc","title":"GRPC","text":"[jvm]\\ GRPC
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-g-r-p-c/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-a-t-c-h/","title":"PATCH - Misk","text":"//misk-api/misk.web/DispatchMechanism/PATCH
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-a-t-c-h/#patch","title":"PATCH","text":"[jvm]\\ PATCH
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-a-t-c-h/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-o-s-t/","title":"POST - Misk","text":"//misk-api/misk.web/DispatchMechanism/POST
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-o-s-t/#post","title":"POST","text":"[jvm]\\ POST
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-o-s-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-u-t/","title":"PUT - Misk","text":"//misk-api/misk.web/DispatchMechanism/PUT
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-u-t/#put","title":"PUT","text":"[jvm]\\ PUT
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-p-u-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-w-e-b-s-o-c-k-e-t/","title":"WEBSOCKET - Misk","text":"//misk-api/misk.web/DispatchMechanism/WEBSOCKET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-w-e-b-s-o-c-k-e-t/#websocket","title":"WEBSOCKET","text":"[jvm]\\ WEBSOCKET
"},{"location":"0.x/misk-api/misk-api/misk.web/-dispatch-mechanism/-w-e-b-s-o-c-k-e-t/#properties","title":"Properties","text":"Name Summary method [jvm]val method: StringReturns the method used when a call entered the service. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/","title":"Package-level declarations - Misk","text":"//misk-api/misk.web.dashboard
"},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/#types","title":"Types","text":"Name Summary AdminDashboardAccess [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])annotation class AdminDashboardAccessBind to set access for the Misk Admin Dashboard."},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/-admin-dashboard-access/","title":"AdminDashboardAccess - Misk","text":"//misk-api/misk.web.dashboard/AdminDashboardAccess
"},{"location":"0.x/misk-api/misk-api/misk.web.dashboard/-admin-dashboard-access/#admindashboardaccess","title":"AdminDashboardAccess","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class AdminDashboardAccess
Bind to set access for the Misk Admin Dashboard.
// Give engineers access to the admin dashboard for Exemplar service\nmultibind<AccessAnnotationEntry>().toInstance(\n AccessAnnotationEntry<AdminDashboardAccess>(\n capabilities = listOf(\"admin_console\"))\n)\n//misk-aws
"},{"location":"0.x/misk-aws/#misk-aws","title":"misk-aws","text":""},{"location":"0.x/misk-aws/#packages","title":"Packages","text":"Name misk.cloud.aws misk.jobqueue.sqs misk.s3"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/","title":"Package-level declarations - Misk","text":"//misk-aws/misk.cloud.aws
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/#types","title":"Types","text":"Name Summary AwsAccountId [jvm]data class AwsAccountId(val value: String)AwsAccountId is the id of the account in which the service is running AwsEnvironmentModule [jvm]class AwsEnvironmentModule : KAbstractModuleAwsEnvironmentModule pulls region and account information from installed env vars AwsRegion [jvm]data class AwsRegion(val name: String)AwsRegion is the region in which the service is running FakeAwsEnvironmentModule [jvm]class FakeAwsEnvironmentModule : KAbstractModuleFakeAwsEnvironmentModule pulls region and account information from an in memory map."},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/#functions","title":"Functions","text":"Name Summary toMiskAwsAccountId [jvm]fun AwsAccountId.toMiskAwsAccountId(): AwsAccountId toMiskAwsRegion [jvm]fun AwsRegion.toMiskAwsRegion(): AwsRegion"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-account-id/","title":"toMiskAwsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/toMiskAwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-account-id/#tomiskawsaccountid","title":"toMiskAwsAccountId","text":"[jvm]\\ fun AwsAccountId.toMiskAwsAccountId(): AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-region/","title":"toMiskAwsRegion - Misk","text":"//misk-aws/misk.cloud.aws/toMiskAwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/to-misk-aws-region/#tomiskawsregion","title":"toMiskAwsRegion","text":"[jvm]\\ fun AwsRegion.toMiskAwsRegion(): AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/","title":"AwsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ data class AwsAccountId(val value: String)
AwsAccountId is the id of the account in which the service is running
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/#constructors","title":"Constructors","text":"AwsAccountId [jvm]constructor(value: String)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/-aws-account-id/","title":"AwsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/AwsAccountId/AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ constructor(value: String)
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/value/","title":"value - Misk","text":"//misk-aws/misk.cloud.aws/AwsAccountId/value
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-account-id/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/","title":"AwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/#awsenvironmentmodule","title":"AwsEnvironmentModule","text":"[jvm]\\ class AwsEnvironmentModule : KAbstractModule
AwsEnvironmentModule pulls region and account information from installed env vars
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/#constructors","title":"Constructors","text":"AwsEnvironmentModule [jvm]constructor()"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/#functions","title":"Functions","text":"Name Summary awsAccountId [jvm]@Providesfun awsAccountId(envVarLoader: EnvVarLoader): AwsAccountId awsRegion [jvm]@Providesfun awsRegion(envVarLoader: EnvVarLoader): AwsRegion configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/-aws-environment-module/","title":"AwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule/AwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/-aws-environment-module/#awsenvironmentmodule","title":"AwsEnvironmentModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-account-id/","title":"awsAccountId - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule/awsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-account-id/#awsaccountid","title":"awsAccountId","text":"[jvm]\\
@Provides
fun awsAccountId(envVarLoader: EnvVarLoader): AwsAccountId
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-region/","title":"awsRegion - Misk","text":"//misk-aws/misk.cloud.aws/AwsEnvironmentModule/awsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-environment-module/aws-region/#awsregion","title":"awsRegion","text":"[jvm]\\
@Provides
fun awsRegion(envVarLoader: EnvVarLoader): AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/","title":"AwsRegion - Misk","text":"//misk-aws/misk.cloud.aws/AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ data class AwsRegion(val name: String)
AwsRegion is the region in which the service is running
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/#constructors","title":"Constructors","text":"AwsRegion [jvm]constructor(name: String)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/-aws-region/","title":"AwsRegion - Misk","text":"//misk-aws/misk.cloud.aws/AwsRegion/AwsRegion
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/name/","title":"name - Misk","text":"//misk-aws/misk.cloud.aws/AwsRegion/name
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-aws-region/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/","title":"FakeAwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/FakeAwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/#fakeawsenvironmentmodule","title":"FakeAwsEnvironmentModule","text":"[jvm]\\ class FakeAwsEnvironmentModule : KAbstractModule
FakeAwsEnvironmentModule pulls region and account information from an in memory map.
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/#constructors","title":"Constructors","text":"FakeAwsEnvironmentModule [jvm]constructor()"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/-fake-aws-environment-module/","title":"FakeAwsEnvironmentModule - Misk","text":"//misk-aws/misk.cloud.aws/FakeAwsEnvironmentModule/FakeAwsEnvironmentModule
"},{"location":"0.x/misk-aws/misk-aws/misk.cloud.aws/-fake-aws-environment-module/-fake-aws-environment-module/#fakeawsenvironmentmodule","title":"FakeAwsEnvironmentModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/","title":"Package-level declarations - Misk","text":"//misk-aws/misk.jobqueue.sqs
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#types","title":"Types","text":"Name Summary AwsSqsJobHandlerModule [jvm]class AwsSqsJobHandlerModule<T : JobHandler> : KAbstractModuleInstall this module to register a handler for an SQS queue, and if specified, registers its corresponding retry queue. AwsSqsJobQueueConfig [jvm]class AwsSqsJobQueueConfig@JvmOverloadsconstructor(val external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, val task_queue: RepeatedTaskQueueConfig? = null, val queue_attribute_importer_frequency_ms: Long = 1000, val sqs_sending_socket_timeout_ms: Int = 5000, val sqs_sending_connect_timeout_ms: Int = 1000, val sqs_sending_request_timeout_ms: Int = 5000, val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, val safe_shutdown: Boolean = true) : ConfigAwsSqsJobQueueConfig is the configuration for job queueing backed by Amazon\u2019s Simple Queuing Service AwsSqsJobQueueModule [jvm]open class AwsSqsJobQueueModule(config: AwsSqsJobQueueConfig) : KAbstractModuleAwsSqsJobQueueModule installs job queue support provided by SQS. AwsSqsJobReceiverPolicy [jvm]enum AwsSqsJobReceiverPolicy : Enum<AwsSqsJobReceiverPolicy> AWS SQS consumers are spun by each of a service\u2019s pods. Each pod is responsible for running some number on consumers and making sure they are within the parameters of the feature-flags used. AwsSqsQueueConfig [jvm]data class AwsSqsQueueConfig@JvmOverloadsconstructor(val region: String? = null, val account_id: String? = null, val sqs_queue_name: String? = null)An AwsSqsQueueConfig tells misk about a queue, potentially in another region and/or another account. If the queue is in another account, it will require an IAM policy enabling cross account access DeadLetterQueueProvider [jvm]interface DeadLetterQueueProviderInterface for a provider of dead-letter queue names. DefaultDeadLetterQueueProvider [jvm]@Singletonclass DefaultDeadLetterQueueProvider@Injectconstructor : DeadLetterQueueProviderDefault provider of dead-letter QueueName. Returns the name of the main queue suffixed with \"_dlq\". FlaggedBufferedSqsClient [jvm]class FlaggedBufferedSqsClient(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags) : AmazonSQSTemporary shim for buffered and unbuffered AmazonSQS implementations, for feature-flagged rollout of buffered SQS operations across cash cloud apps. SqsConsumerAllocator [jvm]@Singletonclass SqsConsumerAllocator@Injectconstructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)Uses a LeaseManager and FeatureFlags to calculate the number of sqs consumers a pods should have. This computation is based off of the AwsSqsJobReceiverPolicy specification. StaticDeadLetterQueueProvider [jvm]class StaticDeadLetterQueueProvider(queue: String) : DeadLetterQueueProviderProvider of dead-letter QueueName that always returns the same value, no matter the supplied queue."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#properties","title":"Properties","text":"Name Summary isRetryQueue [jvm]val QueueName.isRetryQueue: Boolean parentQueue [jvm]val QueueName.parentQueue: QueueName retryQueue [jvm]val QueueName.retryQueue: QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/#functions","title":"Functions","text":"Name Summary withNoPrefetching [jvm]fun QueueBufferConfig.withNoPrefetching(): QueueBufferConfigModify a QueueBufferConfig to disable all receive pre-fetching settings."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/is-retry-queue/","title":"isRetryQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/isRetryQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/is-retry-queue/#isretryqueue","title":"isRetryQueue","text":"[jvm]\\ val QueueName.isRetryQueue: Boolean
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/parent-queue/","title":"parentQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/parentQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/parent-queue/#parentqueue","title":"parentQueue","text":"[jvm]\\ val QueueName.parentQueue: QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/retry-queue/","title":"retryQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/retryQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/retry-queue/#retryqueue","title":"retryQueue","text":"[jvm]\\ val QueueName.retryQueue: QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/with-no-prefetching/","title":"withNoPrefetching - Misk","text":"//misk-aws/misk.jobqueue.sqs/withNoPrefetching
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/with-no-prefetching/#withnoprefetching","title":"withNoPrefetching","text":"[jvm]\\ fun QueueBufferConfig.withNoPrefetching(): QueueBufferConfig
Modify a QueueBufferConfig to disable all receive pre-fetching settings.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/","title":"AwsSqsJobHandlerModule - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobHandlerModule
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/#awssqsjobhandlermodule","title":"AwsSqsJobHandlerModule","text":"[jvm]\\ class AwsSqsJobHandlerModule<T : JobHandler> : KAbstractModule
Install this module to register a handler for an SQS queue, and if specified, registers its corresponding retry queue.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobHandlerModule/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsinline fun <T : JobHandler> create(queueName: QueueName, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>@JvmStatic@JvmOverloadsfun <T : JobHandler> create(queueName: QueueName, handlerClass: Class<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>[jvm]@JvmOverloadsfun <T : JobHandler> create(queueName: QueueName, handlerClass: KClass<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>Returns a module that registers a handler for an SQS queue."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/create/","title":"create - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobHandlerModule/Companion/create
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-handler-module/-companion/create/#create","title":"create","text":"[jvm]\\
@JvmOverloads
inline fun <T : JobHandler> create(queueName: QueueName, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>
@JvmStatic
@JvmOverloads
fun <T : JobHandler> create(queueName: QueueName, handlerClass: Class<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>
[jvm]\\
@JvmOverloads
fun <T : JobHandler> create(queueName: QueueName, handlerClass: KClass<T>, installRetryQueue: Boolean = true, dependsOn: List<Key<out Service>> = emptyList()): AwsSqsJobHandlerModule<T>
Returns a module that registers a handler for an SQS queue.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/","title":"AwsSqsJobQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/#awssqsjobqueueconfig","title":"AwsSqsJobQueueConfig","text":"[jvm]\\ class AwsSqsJobQueueConfig@JvmOverloadsconstructor(val external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, val task_queue: RepeatedTaskQueueConfig? = null, val queue_attribute_importer_frequency_ms: Long = 1000, val sqs_sending_socket_timeout_ms: Int = 5000, val sqs_sending_connect_timeout_ms: Int = 1000, val sqs_sending_request_timeout_ms: Int = 5000, val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, val safe_shutdown: Boolean = true) : Config
AwsSqsJobQueueConfig is the configuration for job queueing backed by Amazon\u2019s Simple Queuing Service
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/#constructors","title":"Constructors","text":"AwsSqsJobQueueConfig [jvm]@JvmOverloadsconstructor(external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, task_queue: RepeatedTaskQueueConfig? = null, queue_attribute_importer_frequency_ms: Long = 1000, sqs_sending_socket_timeout_ms: Int = 5000, sqs_sending_connect_timeout_ms: Int = 1000, sqs_sending_request_timeout_ms: Int = 5000, aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, safe_shutdown: Boolean = true)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/#properties","title":"Properties","text":"Name Summary aws_sqs_job_receiver_policy [jvm]val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy external_queues [jvm]val external_queues: Map<String, AwsSqsQueueConfig>External queues is a set of externally owned SQS queues accessed by this service, mapping an internal queue name to the (account ID, region, name) of the queue in the external account queue_attribute_importer_frequency_ms [jvm]val queue_attribute_importer_frequency_ms: Long = 1000Frequency used to import Queue Attributes in milliseconds. safe_shutdown [jvm]val safe_shutdown: Boolean = trueTemporary flag to test new shutdown behavior. This flag will eventually be removed and incorporated as the default behavior of the library. sqs_sending_connect_timeout_ms [jvm]val sqs_sending_connect_timeout_ms: Int = 1000Connect timeout to reach SQS with for sending. sqs_sending_request_timeout_ms [jvm]val sqs_sending_request_timeout_ms: Int = 5000Request timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS. sqs_sending_socket_timeout_ms [jvm]val sqs_sending_socket_timeout_ms: Int = 5000Socket timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS. task_queue [jvm]val task_queue: RepeatedTaskQueueConfig? = nullTask queue configuration, which should have anum_parallel_tasks equal or greater than the number of consumed queues. If undefined, an unbounded number of parallel tasks will be used."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/-aws-sqs-job-queue-config/","title":"AwsSqsJobQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/AwsSqsJobQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/-aws-sqs-job-queue-config/#awssqsjobqueueconfig","title":"AwsSqsJobQueueConfig","text":"[jvm]\\
@JvmOverloads
constructor(external_queues: Map<String, AwsSqsQueueConfig> = mapOf(), message_batch_size: Int = 10, task_queue: RepeatedTaskQueueConfig? = null, queue_attribute_importer_frequency_ms: Long = 1000, sqs_sending_socket_timeout_ms: Int = 5000, sqs_sending_connect_timeout_ms: Int = 1000, sqs_sending_request_timeout_ms: Int = 5000, aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy = AwsSqsJobReceiverPolicy.ONE_FLAG_ONLY, safe_shutdown: Boolean = true)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/aws_sqs_job_receiver_policy/","title":"aws_sqs_job_receiver_policy - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/aws_sqs_job_receiver_policy
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/aws_sqs_job_receiver_policy/#aws_sqs_job_receiver_policy","title":"aws_sqs_job_receiver_policy","text":"[jvm]\\ val aws_sqs_job_receiver_policy: AwsSqsJobReceiverPolicy
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/external_queues/","title":"external_queues - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/external_queues
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/external_queues/#external_queues","title":"external_queues","text":"[jvm]\\ val external_queues: Map<String, AwsSqsQueueConfig>
External queues is a set of externally owned SQS queues accessed by this service, mapping an internal queue name to the (account ID, region, name) of the queue in the external account
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/queue_attribute_importer_frequency_ms/","title":"queue_attribute_importer_frequency_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/queue_attribute_importer_frequency_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/queue_attribute_importer_frequency_ms/#queue_attribute_importer_frequency_ms","title":"queue_attribute_importer_frequency_ms","text":"[jvm]\\ val queue_attribute_importer_frequency_ms: Long = 1000
Frequency used to import Queue Attributes in milliseconds.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/safe_shutdown/","title":"safe_shutdown - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/safe_shutdown
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/safe_shutdown/#safe_shutdown","title":"safe_shutdown","text":"[jvm]\\ val safe_shutdown: Boolean = true
Temporary flag to test new shutdown behavior. This flag will eventually be removed and incorporated as the default behavior of the library.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_connect_timeout_ms/","title":"sqs_sending_connect_timeout_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/sqs_sending_connect_timeout_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_connect_timeout_ms/#sqs_sending_connect_timeout_ms","title":"sqs_sending_connect_timeout_ms","text":"[jvm]\\ val sqs_sending_connect_timeout_ms: Int = 1000
Connect timeout to reach SQS with for sending.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_request_timeout_ms/","title":"sqs_sending_request_timeout_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/sqs_sending_request_timeout_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_request_timeout_ms/#sqs_sending_request_timeout_ms","title":"sqs_sending_request_timeout_ms","text":"[jvm]\\ val sqs_sending_request_timeout_ms: Int = 5000
Request timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_socket_timeout_ms/","title":"sqs_sending_socket_timeout_ms - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/sqs_sending_socket_timeout_ms
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/sqs_sending_socket_timeout_ms/#sqs_sending_socket_timeout_ms","title":"sqs_sending_socket_timeout_ms","text":"[jvm]\\ val sqs_sending_socket_timeout_ms: Int = 5000
Socket timeout to reach SQS with for sending, not including retries. We only apply this for sending because receiving uses long-polling, which explicitly leverages a longer request time. We use the default retry strategy with SQS, which retries 3 times. As a result, your app could potentially spend 3 x this timeout talking to SQS.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/task_queue/","title":"task_queue - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueConfig/task_queue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-config/task_queue/#task_queue","title":"task_queue","text":"[jvm]\\ val task_queue: RepeatedTaskQueueConfig? = null
Task queue configuration, which should have a num_parallel_tasks equal or greater than the number of consumed queues. If undefined, an unbounded number of parallel tasks will be used.
//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#awssqsjobqueuemodule","title":"AwsSqsJobQueueModule","text":"[jvm]\\ open class AwsSqsJobQueueModule(config: AwsSqsJobQueueConfig) : KAbstractModule
AwsSqsJobQueueModule installs job queue support provided by SQS.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#constructors","title":"Constructors","text":"AwsSqsJobQueueModule [jvm]constructor(config: AwsSqsJobQueueConfig)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun <BuilderT : AwsClientBuilder<BuilderT, ClientT>, ClientT> configureClient(builder: BuilderT) consumerRepeatedTaskQueue [jvm]@Provides@Singletonfun consumerRepeatedTaskQueue(queueFactory: RepeatedTaskQueueFactory, config: AwsSqsJobQueueConfig): RepeatedTaskQueue provideSQSClient [jvm]@Provides@Singletonfun provideSQSClient(appName: String, region: AwsRegion, credentials: AWSCredentialsProvider, features: FeatureFlags): AmazonSQS provideSQSClientForReceiving [jvm]@Provides@Singletonfun provideSQSClientForReceiving(region: AwsRegion, credentials: AWSCredentialsProvider): AmazonSQS"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-aws-sqs-job-queue-module/","title":"AwsSqsJobQueueModule - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/AwsSqsJobQueueModule
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-aws-sqs-job-queue-module/#awssqsjobqueuemodule","title":"AwsSqsJobQueueModule","text":"[jvm]\\ constructor(config: AwsSqsJobQueueConfig)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/configureClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun <BuilderT : AwsClientBuilder<BuilderT, ClientT>, ClientT> configureClient(builder: BuilderT)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/consumer-repeated-task-queue/","title":"consumerRepeatedTaskQueue - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/consumerRepeatedTaskQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/consumer-repeated-task-queue/#consumerrepeatedtaskqueue","title":"consumerRepeatedTaskQueue","text":"[jvm]\\
@Provides
@Singleton
fun consumerRepeatedTaskQueue(queueFactory: RepeatedTaskQueueFactory, config: AwsSqsJobQueueConfig): RepeatedTaskQueue
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client-for-receiving/","title":"provideSQSClientForReceiving - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/provideSQSClientForReceiving
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client-for-receiving/#providesqsclientforreceiving","title":"provideSQSClientForReceiving","text":"[jvm]\\
@Provides
@Singleton
fun provideSQSClientForReceiving(region: AwsRegion, credentials: AWSCredentialsProvider): AmazonSQS
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client/","title":"provideSQSClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/provideSQSClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/provide-s-q-s-client/#providesqsclient","title":"provideSQSClient","text":"[jvm]\\
@Provides
@Singleton
fun provideSQSClient(appName: String, region: AwsRegion, credentials: AWSCredentialsProvider, features: FeatureFlags): AmazonSQS
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobQueueModule/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-queue-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/","title":"AwsSqsJobReceiverPolicy - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#awssqsjobreceiverpolicy","title":"AwsSqsJobReceiverPolicy","text":"[jvm]\\ enum AwsSqsJobReceiverPolicy : Enum<AwsSqsJobReceiverPolicy>
AWS SQS consumers are spun by each of a service\u2019s pods. Each pod is responsible for running some number on consumers and making sure they are within the parameters of the feature-flags used.
Which flags?
The AwsSqsJobReceiverPolicy gives two options for how consumers are created based on the flags.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#entries","title":"Entries","text":"ONE_FLAG_ONLY [jvm]ONE_FLAG_ONLYThis is the original policy. Naming is hard, but this policy will compute receivers as follows. First we choose one flag. If there is a configuration in POD_CONSUMERS_PER_QUEUE, choose that flag; otherwise choose the CONSUMERS_PER_QUEUE flag. BALANCED_MAX [jvm]BALANCED_MAXThis policy uses a combination of these two flags to avoid the worst of both as used in ONE_FLAG_ONLY above."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AwsSqsJobReceiverPolicy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AwsSqsJobReceiverPolicyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AwsSqsJobReceiverPolicy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/entries/","title":"entries - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/entries
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AwsSqsJobReceiverPolicy>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/value-of/","title":"valueOf - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/valueOf
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AwsSqsJobReceiverPolicy
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/values/","title":"values - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/values
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AwsSqsJobReceiverPolicy>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-b-a-l-a-n-c-e-d_-m-a-x/","title":"BALANCED_MAX - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/BALANCED_MAX
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-b-a-l-a-n-c-e-d_-m-a-x/#balanced_max","title":"BALANCED_MAX","text":"[jvm]\\ BALANCED_MAX
This policy uses a combination of these two flags to avoid the worst of both as used in ONE_FLAG_ONLY above.
The POD_CONSUMERS_PER_QUEUE is subject to DOS a service when it scales up. This is especially problematic with auto scaling.
The CONSUMERS_PER_QUEUE leads to really unbalanced nodes. Throughput suffers and it is really difficult to process high backlogs of messages since usually very few nodes have enough consumers.
With this policy, as pods come online they take as many leases as are available OR until they hit the max configured per pod limit. In the interest of not overloading the flag names this max per pod is configured with POD_MAX_JOBQUEUE_CONSUMERS
This means that the SQS consumers can scale up as the services scales up, but will hit a ceiling specified by the CONSUMERS_PER_QUEUE flag. It also means that no pod takes on all the work of processing the SQS jobs.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-b-a-l-a-n-c-e-d_-m-a-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-o-n-e_-f-l-a-g_-o-n-l-y/","title":"ONE_FLAG_ONLY - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsJobReceiverPolicy/ONE_FLAG_ONLY
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-o-n-e_-f-l-a-g_-o-n-l-y/#one_flag_only","title":"ONE_FLAG_ONLY","text":"[jvm]\\ ONE_FLAG_ONLY
This is the original policy. Naming is hard, but this policy will compute receivers as follows. First we choose one flag. If there is a configuration in POD_CONSUMERS_PER_QUEUE, choose that flag; otherwise choose the CONSUMERS_PER_QUEUE flag.
If the POD_CONSUMERS_PER_QUEUE is chosen, ALL pods will spin up the configured number of consumers. Imagine the flag is configured for 5 consumers, then 5 pods => 25 sqs consumers 10 pods => 50 sqs consumers 100 pods => 500 sqs consumers
If the CONSUMERS_PER_QUEUE is chosen then we use leases. Consider that the flag is configured with m consumers (globally) so that m leases are available. As the pods come online, they will eagerly spin up consumers until leases run out\u2026 they race! Once m leases are handed out any pods that didn\u2019t spin up a receiver will not participate in SQS consumption and those that won the race might have up to m receivers.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-job-receiver-policy/-o-n-e_-f-l-a-g_-o-n-l-y/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/","title":"AwsSqsQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/#awssqsqueueconfig","title":"AwsSqsQueueConfig","text":"[jvm]\\ data class AwsSqsQueueConfig@JvmOverloadsconstructor(val region: String? = null, val account_id: String? = null, val sqs_queue_name: String? = null)
An AwsSqsQueueConfig tells misk about a queue, potentially in another region and/or another account. If the queue is in another account, it will require an IAM policy enabling cross account access
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/#constructors","title":"Constructors","text":"AwsSqsQueueConfig [jvm]@JvmOverloadsconstructor(region: String? = null, account_id: String? = null, sqs_queue_name: String? = null)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/#properties","title":"Properties","text":"Name Summary account_id [jvm]val account_id: String? = null region [jvm]val region: String? = null sqs_queue_name [jvm]val sqs_queue_name: String? = null"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/-aws-sqs-queue-config/","title":"AwsSqsQueueConfig - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/AwsSqsQueueConfig
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/-aws-sqs-queue-config/#awssqsqueueconfig","title":"AwsSqsQueueConfig","text":"[jvm]\\
@JvmOverloads
constructor(region: String? = null, account_id: String? = null, sqs_queue_name: String? = null)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/account_id/","title":"account_id - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/account_id
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/account_id/#account_id","title":"account_id","text":"[jvm]\\ val account_id: String? = null
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/region/","title":"region - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/region
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/region/#region","title":"region","text":"[jvm]\\ val region: String? = null
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/sqs_queue_name/","title":"sqs_queue_name - Misk","text":"//misk-aws/misk.jobqueue.sqs/AwsSqsQueueConfig/sqs_queue_name
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-aws-sqs-queue-config/sqs_queue_name/#sqs_queue_name","title":"sqs_queue_name","text":"[jvm]\\ val sqs_queue_name: String? = null
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/","title":"DeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/DeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/#deadletterqueueprovider","title":"DeadLetterQueueProvider","text":"interface DeadLetterQueueProvider
Interface for a provider of dead-letter queue names.
Returns the name of the appropriate dead-letter QueueName for a given QueueName.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/#inheritors","title":"Inheritors","text":"DefaultDeadLetterQueueProvider StaticDeadLetterQueueProvider"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/#functions","title":"Functions","text":"Name Summary deadLetterQueueFor [jvm]abstract fun deadLetterQueueFor(queue: QueueName): QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/dead-letter-queue-for/","title":"deadLetterQueueFor - Misk","text":"//misk-aws/misk.jobqueue.sqs/DeadLetterQueueProvider/deadLetterQueueFor
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-dead-letter-queue-provider/dead-letter-queue-for/#deadletterqueuefor","title":"deadLetterQueueFor","text":"[jvm]\\ abstract fun deadLetterQueueFor(queue: QueueName): QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/","title":"DefaultDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/DefaultDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/#defaultdeadletterqueueprovider","title":"DefaultDeadLetterQueueProvider","text":"[jvm]\\ @Singleton
class DefaultDeadLetterQueueProvider@Injectconstructor : DeadLetterQueueProvider
Default provider of dead-letter QueueName. Returns the name of the main queue suffixed with \"_dlq\".
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/#constructors","title":"Constructors","text":"DefaultDeadLetterQueueProvider [jvm]@Injectconstructor()"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/#functions","title":"Functions","text":"Name Summary deadLetterQueueFor [jvm]open override fun deadLetterQueueFor(queue: QueueName): QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/-default-dead-letter-queue-provider/","title":"DefaultDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/DefaultDeadLetterQueueProvider/DefaultDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/-default-dead-letter-queue-provider/#defaultdeadletterqueueprovider","title":"DefaultDeadLetterQueueProvider","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/dead-letter-queue-for/","title":"deadLetterQueueFor - Misk","text":"//misk-aws/misk.jobqueue.sqs/DefaultDeadLetterQueueProvider/deadLetterQueueFor
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-default-dead-letter-queue-provider/dead-letter-queue-for/#deadletterqueuefor","title":"deadLetterQueueFor","text":"[jvm]\\ open override fun deadLetterQueueFor(queue: QueueName): QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/","title":"FlaggedBufferedSqsClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#flaggedbufferedsqsclient","title":"FlaggedBufferedSqsClient","text":"[jvm]\\ class FlaggedBufferedSqsClient(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags) : AmazonSQS
Temporary shim for buffered and unbuffered AmazonSQS implementations, for feature-flagged rollout of buffered SQS operations across cash cloud apps.
Flag allows gates functionality on a per-service basis.
Calls to sendMessage and deleteMessage will be routed to either buffered or unbuffered clients depending on the state of the feature flag for this service. All other operations are delegated to the unbufferd implementation.
Once usage of the buffered client is proven safe, this shim should be deleted and substituted with AmazonSQSBufferedAsyncClient.
Flag: https://app.launchdarkly.com/cash/production/features/jobqueue-buffered-sqs-client/targeting
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#constructors","title":"Constructors","text":"FlaggedBufferedSqsClient [jvm]constructor(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/#functions","title":"Functions","text":"Name Summary addPermission [jvm]open override fun addPermission(p0: AddPermissionRequest): AddPermissionResultopen override fun addPermission(p0: String, p1: String, p2: MutableList<String>, p3: MutableList<String>): AddPermissionResult cancelMessageMoveTask [jvm]open override fun cancelMessageMoveTask(p0: CancelMessageMoveTaskRequest): CancelMessageMoveTaskResult changeMessageVisibility [jvm]open override fun changeMessageVisibility(p0: ChangeMessageVisibilityRequest): ChangeMessageVisibilityResultopen override fun changeMessageVisibility(p0: String, p1: String, p2: Int): ChangeMessageVisibilityResult changeMessageVisibilityBatch [jvm]open override fun changeMessageVisibilityBatch(p0: ChangeMessageVisibilityBatchRequest): ChangeMessageVisibilityBatchResultopen override fun changeMessageVisibilityBatch(p0: String, p1: MutableList<ChangeMessageVisibilityBatchRequestEntry>): ChangeMessageVisibilityBatchResult createQueue [jvm]open override fun createQueue(p0: CreateQueueRequest): CreateQueueResultopen override fun createQueue(p0: String): CreateQueueResult deleteMessage [jvm]open override fun deleteMessage(deleteMessageRequest: DeleteMessageRequest): DeleteMessageResultopen override fun deleteMessage(queueUrl: String, receiptHandle: String): DeleteMessageResult deleteMessageBatch [jvm]open override fun deleteMessageBatch(p0: DeleteMessageBatchRequest): DeleteMessageBatchResultopen override fun deleteMessageBatch(p0: String, p1: MutableList<DeleteMessageBatchRequestEntry>): DeleteMessageBatchResult deleteQueue [jvm]open override fun deleteQueue(p0: DeleteQueueRequest): DeleteQueueResultopen override fun deleteQueue(p0: String): DeleteQueueResult getCachedResponseMetadata [jvm]open override fun getCachedResponseMetadata(p0: AmazonWebServiceRequest): ResponseMetadata getQueueAttributes [jvm]open override fun getQueueAttributes(p0: GetQueueAttributesRequest): GetQueueAttributesResultopen override fun getQueueAttributes(p0: String, p1: MutableList<String>): GetQueueAttributesResult getQueueUrl [jvm]open override fun getQueueUrl(p0: GetQueueUrlRequest): GetQueueUrlResultopen override fun getQueueUrl(p0: String): GetQueueUrlResult listDeadLetterSourceQueues [jvm]open override fun listDeadLetterSourceQueues(p0: ListDeadLetterSourceQueuesRequest): ListDeadLetterSourceQueuesResult listMessageMoveTasks [jvm]open override fun listMessageMoveTasks(p0: ListMessageMoveTasksRequest): ListMessageMoveTasksResult listQueues [jvm]open override fun listQueues(): ListQueuesResultopen override fun listQueues(p0: ListQueuesRequest): ListQueuesResultopen override fun listQueues(p0: String): ListQueuesResult listQueueTags [jvm]open override fun listQueueTags(p0: ListQueueTagsRequest): ListQueueTagsResultopen override fun listQueueTags(p0: String): ListQueueTagsResult purgeQueue [jvm]open override fun purgeQueue(p0: PurgeQueueRequest): PurgeQueueResult receiveMessage [jvm]open override fun receiveMessage(p0: ReceiveMessageRequest): ReceiveMessageResultopen override fun receiveMessage(p0: String): ReceiveMessageResult removePermission [jvm]open override fun removePermission(p0: RemovePermissionRequest): RemovePermissionResultopen override fun removePermission(p0: String, p1: String): RemovePermissionResult sendMessage [jvm]open override fun sendMessage(sendMessageRequest: SendMessageRequest): SendMessageResultopen override fun sendMessage(queueUrl: String, messageBody: String): SendMessageResult sendMessageBatch [jvm]open override fun sendMessageBatch(p0: SendMessageBatchRequest): SendMessageBatchResultopen override fun sendMessageBatch(p0: String, p1: MutableList<SendMessageBatchRequestEntry>): SendMessageBatchResult setQueueAttributes [jvm]open override fun setQueueAttributes(p0: SetQueueAttributesRequest): SetQueueAttributesResultopen override fun setQueueAttributes(p0: String, p1: MutableMap<String, String>): SetQueueAttributesResult shutdown [jvm]open override fun shutdown() startMessageMoveTask [jvm]open override fun startMessageMoveTask(p0: StartMessageMoveTaskRequest): StartMessageMoveTaskResult tagQueue [jvm]open override fun tagQueue(p0: TagQueueRequest): TagQueueResultopen override fun tagQueue(p0: String, p1: MutableMap<String, String>): TagQueueResult untagQueue [jvm]open override fun untagQueue(p0: UntagQueueRequest): UntagQueueResultopen override fun untagQueue(p0: String, p1: MutableList<String>): UntagQueueResult"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-flagged-buffered-sqs-client/","title":"FlaggedBufferedSqsClient - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/FlaggedBufferedSqsClient
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-flagged-buffered-sqs-client/#flaggedbufferedsqsclient","title":"FlaggedBufferedSqsClient","text":"[jvm]\\ constructor(unbufferedSqs: AmazonSQS, bufferedSqs: AmazonSQS, appName: String, featureFlags: FeatureFlags)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/delete-message/","title":"deleteMessage - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/deleteMessage
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/delete-message/#deletemessage","title":"deleteMessage","text":"[jvm]\\ open override fun deleteMessage(deleteMessageRequest: DeleteMessageRequest): DeleteMessageResult
open override fun deleteMessage(queueUrl: String, receiptHandle: String): DeleteMessageResult
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/send-message/","title":"sendMessage - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/sendMessage
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/send-message/#sendmessage","title":"sendMessage","text":"[jvm]\\ open override fun sendMessage(sendMessageRequest: SendMessageRequest): SendMessageResult
open override fun sendMessage(queueUrl: String, messageBody: String): SendMessageResult
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/shutdown/","title":"shutdown - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/shutdown
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/shutdown/#shutdown","title":"shutdown","text":"[jvm]\\ open override fun shutdown()
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/#properties","title":"Properties","text":"Name Summary FEATURE [jvm]val FEATURE: Feature"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/-f-e-a-t-u-r-e/","title":"FEATURE - Misk","text":"//misk-aws/misk.jobqueue.sqs/FlaggedBufferedSqsClient/Companion/FEATURE
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-flagged-buffered-sqs-client/-companion/-f-e-a-t-u-r-e/#feature","title":"FEATURE","text":"[jvm]\\ val FEATURE: Feature
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/","title":"SqsConsumerAllocator - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#sqsconsumerallocator","title":"SqsConsumerAllocator","text":"[jvm]\\ @Singleton
class SqsConsumerAllocator@Injectconstructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)
Uses a LeaseManager and FeatureFlags to calculate the number of sqs consumers a pods should have. This computation is based off of the AwsSqsJobReceiverPolicy specification.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#constructors","title":"Constructors","text":"SqsConsumerAllocator [jvm]@Injectconstructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/#functions","title":"Functions","text":"Name Summary computeSqsConsumersForPod [jvm]fun computeSqsConsumersForPod(queueName: QueueName, receiverPolicy: AwsSqsJobReceiverPolicy): Int"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-sqs-consumer-allocator/","title":"SqsConsumerAllocator - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/SqsConsumerAllocator
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-sqs-consumer-allocator/#sqsconsumerallocator","title":"SqsConsumerAllocator","text":"[jvm]\\
@Inject
constructor(leaseManager: LeaseManager, featureFlags: FeatureFlags)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/compute-sqs-consumers-for-pod/","title":"computeSqsConsumersForPod - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/computeSqsConsumersForPod
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/compute-sqs-consumers-for-pod/#computesqsconsumersforpod","title":"computeSqsConsumersForPod","text":"[jvm]\\ fun computeSqsConsumersForPod(queueName: QueueName, receiverPolicy: AwsSqsJobReceiverPolicy): Int
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/","title":"Companion - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/#functions","title":"Functions","text":"Name Summary leaseName [jvm]fun leaseName(queueName: QueueName, candidate: Int): String"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/lease-name/","title":"leaseName - Misk","text":"//misk-aws/misk.jobqueue.sqs/SqsConsumerAllocator/Companion/leaseName
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-sqs-consumer-allocator/-companion/lease-name/#leasename","title":"leaseName","text":"[jvm]\\ fun leaseName(queueName: QueueName, candidate: Int): String
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/","title":"StaticDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/StaticDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/#staticdeadletterqueueprovider","title":"StaticDeadLetterQueueProvider","text":"[jvm]\\ class StaticDeadLetterQueueProvider(queue: String) : DeadLetterQueueProvider
Provider of dead-letter QueueName that always returns the same value, no matter the supplied queue.
For apps with queues that share a single dead-letter queue.
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/#constructors","title":"Constructors","text":"StaticDeadLetterQueueProvider [jvm]constructor(queue: String)"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/#functions","title":"Functions","text":"Name Summary deadLetterQueueFor [jvm]open override fun deadLetterQueueFor(queue: QueueName): QueueName"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/-static-dead-letter-queue-provider/","title":"StaticDeadLetterQueueProvider - Misk","text":"//misk-aws/misk.jobqueue.sqs/StaticDeadLetterQueueProvider/StaticDeadLetterQueueProvider
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/-static-dead-letter-queue-provider/#staticdeadletterqueueprovider","title":"StaticDeadLetterQueueProvider","text":"[jvm]\\ constructor(queue: String)
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/dead-letter-queue-for/","title":"deadLetterQueueFor - Misk","text":"//misk-aws/misk.jobqueue.sqs/StaticDeadLetterQueueProvider/deadLetterQueueFor
"},{"location":"0.x/misk-aws/misk-aws/misk.jobqueue.sqs/-static-dead-letter-queue-provider/dead-letter-queue-for/#deadletterqueuefor","title":"deadLetterQueueFor","text":"[jvm]\\ open override fun deadLetterQueueFor(queue: QueueName): QueueName
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/","title":"Package-level declarations - Misk","text":"//misk-aws/misk.s3
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws/misk-aws/misk.s3/#types","title":"Types","text":"Name Summary RealS3Module [jvm]open class RealS3Module : KAbstractModule"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/","title":"RealS3Module - Misk","text":"//misk-aws/misk.s3/RealS3Module
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/#reals3module","title":"RealS3Module","text":"[jvm]\\ open class RealS3Module : KAbstractModule
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/#constructors","title":"Constructors","text":"RealS3Module [jvm]constructor()"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun configureClient(builder: AmazonS3ClientBuilder) provideS3 [jvm]@Provides@Singletonfun provideS3(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonS3"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/-real-s3-module/","title":"RealS3Module - Misk","text":"//misk-aws/misk.s3/RealS3Module/RealS3Module
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/-real-s3-module/#reals3module","title":"RealS3Module","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws/misk.s3/RealS3Module/configureClient
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun configureClient(builder: AmazonS3ClientBuilder)
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/provide-s3/","title":"provideS3 - Misk","text":"//misk-aws/misk.s3/RealS3Module/provideS3
"},{"location":"0.x/misk-aws/misk-aws/misk.s3/-real-s3-module/provide-s3/#provides3","title":"provideS3","text":"[jvm]\\
@Provides
@Singleton
fun provideS3(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonS3
"},{"location":"0.x/misk-aws-dynamodb/","title":"misk-aws-dynamodb - Misk","text":"//misk-aws-dynamodb
"},{"location":"0.x/misk-aws-dynamodb/#misk-aws-dynamodb","title":"misk-aws-dynamodb","text":""},{"location":"0.x/misk-aws-dynamodb/#packages","title":"Packages","text":"Name misk.dynamodb"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/","title":"Package-level declarations - Misk","text":"//misk-aws-dynamodb/misk.dynamodb
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/#types","title":"Types","text":"Name Summary DynamoDbService [jvm]interface DynamoDbService : ServiceService that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb. DyTimestampedEntity [jvm]interface DyTimestampedEntityInterface for a timestamped entity. DyVersionedEntity [jvm]interface DyVersionedEntityThis version field is used for optimistic locking. RealDynamoDbModule [jvm]open class RealDynamoDbModule@JvmOverloadsconstructor(clientConfig: ClientConfiguration = ClientConfiguration(), requiredTableTypes: KClass<*>) : KAbstractModuleInstall this module to have access to an AmazonDynamoDB client. This can be used to create a DynamoDbMapper for querying of a DynamoDb table. RealDynamoDbService [jvm]@Singletonclass RealDynamoDbService@Injectconstructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService RequiredDynamoDbTable [jvm]data class RequiredDynamoDbTable(val name: String)A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/","title":"DyTimestampedEntity - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyTimestampedEntity
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/#dytimestampedentity","title":"DyTimestampedEntity","text":"[jvm]\\ interface DyTimestampedEntity
Interface for a timestamped entity.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/#properties","title":"Properties","text":"Name Summary created_at [jvm]abstract var created_at: DateUse the below annotations on the implementations. This will automatically set field to be when the entity is created. This will save the Date as a Long (epoch milliseconds). updated_at [jvm]abstract var updated_at: DateUse the below annotations on the implementations. This will automatically set field every time entity is saved. This will save the Date as a Long (epoch milliseconds)."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/created_at/","title":"created_at - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyTimestampedEntity/created_at
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/created_at/#created_at","title":"created_at","text":"[jvm]\\ abstract var created_at: Date
Use the below annotations on the implementations. This will automatically set field to be when the entity is created. This will save the Date as a Long (epoch milliseconds).
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/updated_at/","title":"updated_at - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyTimestampedEntity/updated_at
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-timestamped-entity/updated_at/#updated_at","title":"updated_at","text":"[jvm]\\ abstract var updated_at: Date
Use the below annotations on the implementations. This will automatically set field every time entity is saved. This will save the Date as a Long (epoch milliseconds).
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/","title":"DyVersionedEntity - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyVersionedEntity
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/#dyversionedentity","title":"DyVersionedEntity","text":"[jvm]\\ interface DyVersionedEntity
This version field is used for optimistic locking.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/#properties","title":"Properties","text":"Name Summary version [jvm]abstract var version: LongThis version field can be used to do optimistic locking on updates. Note that the DynamoDbMapper will need to be in save mode DynamoDBMapperConfig.SaveBehavior.CLOBBER"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/version/","title":"version - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DyVersionedEntity/version
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dy-versioned-entity/version/#version","title":"version","text":"[jvm]\\ abstract var version: Long
This version field can be used to do optimistic locking on updates. Note that the DynamoDbMapper will need to be in save mode DynamoDBMapperConfig.SaveBehavior.CLOBBER
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/","title":"DynamoDbService - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/DynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/#dynamodbservice","title":"DynamoDbService","text":"interface DynamoDbService : Service
Service that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/#inheritors","title":"Inheritors","text":"RealDynamoDbService"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"open class RealDynamoDbModule@JvmOverloadsconstructor(clientConfig: ClientConfiguration = ClientConfiguration(), requiredTableTypes: KClass<*>) : KAbstractModule
Install this module to have access to an AmazonDynamoDB client. This can be used to create a DynamoDbMapper for querying of a DynamoDb table.
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#parameters","title":"Parameters","text":"jvm
requiredTableTypes a list of mapper classes annotated DynamoDBTable."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#constructors","title":"Constructors","text":"RealDynamoDbModule [jvm]@JvmOverloadsconstructor(clientConfig: ClientConfiguration = ClientConfiguration(), vararg requiredTableTypes: KClass<*>)"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun configureClient(builder: AmazonDynamoDBClientBuilder) configureStreamsClient [jvm]open fun configureStreamsClient(builder: AmazonDynamoDBStreamsClientBuilder) provideRequiredTables [jvm]@Provides@Singletonfun provideRequiredTables(): List<RequiredDynamoDbTable> providesAmazonDynamoDB [jvm]@Provides@Singletonfun providesAmazonDynamoDB(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDB providesAmazonDynamoDBStreams [jvm]@Provides@Singletonfun providesAmazonDynamoDBStreams(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDBStreams"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/RealDynamoDbModule
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"[jvm]\\
@JvmOverloads
constructor(clientConfig: ClientConfiguration = ClientConfiguration(), vararg requiredTableTypes: KClass<*>)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/#parameters","title":"Parameters","text":"jvm
requiredTableTypes a list of mapper classes annotated DynamoDBTable."},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/configureClient
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun configureClient(builder: AmazonDynamoDBClientBuilder)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-streams-client/","title":"configureStreamsClient - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/configureStreamsClient
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/configure-streams-client/#configurestreamsclient","title":"configureStreamsClient","text":"[jvm]\\ open fun configureStreamsClient(builder: AmazonDynamoDBStreamsClientBuilder)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provide-required-tables/","title":"provideRequiredTables - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/provideRequiredTables
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provide-required-tables/#providerequiredtables","title":"provideRequiredTables","text":"[jvm]\\
@Provides
@Singleton
fun provideRequiredTables(): List<RequiredDynamoDbTable>
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b-streams/","title":"providesAmazonDynamoDBStreams - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/providesAmazonDynamoDBStreams
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b-streams/#providesamazondynamodbstreams","title":"providesAmazonDynamoDBStreams","text":"[jvm]\\
@Provides
@Singleton
fun providesAmazonDynamoDBStreams(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDBStreams
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b/","title":"providesAmazonDynamoDB - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbModule/providesAmazonDynamoDB
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-module/provides-amazon-dynamo-d-b/#providesamazondynamodb","title":"providesAmazonDynamoDB","text":"[jvm]\\
@Provides
@Singleton
fun providesAmazonDynamoDB(awsRegion: AwsRegion, awsCredentialsProvider: AWSCredentialsProvider): AmazonDynamoDB
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\ @Singleton
class RealDynamoDbService@Injectconstructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/#constructors","title":"Constructors","text":"RealDynamoDbService [jvm]@Injectconstructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>)"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RealDynamoDbService/RealDynamoDbService
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\
@Inject
constructor(dynamoDb: AmazonDynamoDB, requiredTables: List<RequiredDynamoDbTable>)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ data class RequiredDynamoDbTable(val name: String)
A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up.
The table name is sometimes prefixed with the service name, like \"urlshortener.urls\".
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/#constructors","title":"Constructors","text":"RequiredDynamoDbTable [jvm]constructor(name: String)"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RequiredDynamoDbTable/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/name/","title":"name - Misk","text":"//misk-aws-dynamodb/misk.dynamodb/RequiredDynamoDbTable/name
"},{"location":"0.x/misk-aws-dynamodb/misk-aws-dynamodb/misk.dynamodb/-required-dynamo-db-table/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-aws2-dynamodb/","title":"misk-aws2-dynamodb - Misk","text":"//misk-aws2-dynamodb
"},{"location":"0.x/misk-aws2-dynamodb/#misk-aws2-dynamodb","title":"misk-aws2-dynamodb","text":""},{"location":"0.x/misk-aws2-dynamodb/#packages","title":"Packages","text":"Name misk.aws2.dynamodb"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/","title":"Package-level declarations - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/#types","title":"Types","text":"Name Summary DynamoDbService [jvm]interface DynamoDbService : ServiceService that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb. RealDynamoDbModule [jvm]open class RealDynamoDbModule@JvmOverloadsconstructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null) : KAbstractModuleInstall this module to have access to a DynamoDbClient. RealDynamoDbService [jvm]@Singletonclass RealDynamoDbService@Injectconstructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService RequiredDynamoDbTable [jvm]data class RequiredDynamoDbTable(val name: String)A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up."},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/","title":"DynamoDbService - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/DynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/#dynamodbservice","title":"DynamoDbService","text":"interface DynamoDbService : Service
Service that\u2019s running when DynamoDb is usable. Configure your service to depend on this service if it needs DynamoDb.
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/#inheritors","title":"Inheritors","text":"RealDynamoDbService"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"[jvm]\\ open class RealDynamoDbModule@JvmOverloadsconstructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null) : KAbstractModule
Install this module to have access to a DynamoDbClient.
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/#constructors","title":"Constructors","text":"RealDynamoDbModule [jvm]@JvmOverloadsconstructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null)"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureClient [jvm]open fun configureClient(builder: DynamoDbClientBuilder)open fun configureClient(builder: DynamoDbStreamsClientBuilder) provideRequiredTables [jvm]@Provides@Singletonfun provideRequiredTables(): List<RequiredDynamoDbTable> providesDynamoDbClient [jvm]@Provides@Singletonfun providesDynamoDbClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbClient providesDynamoDbStreamsClient [jvm]@Provides@Singletonfun providesDynamoDbStreamsClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbStreamsClient"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/","title":"RealDynamoDbModule - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/RealDynamoDbModule
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/-real-dynamo-db-module/#realdynamodbmodule","title":"RealDynamoDbModule","text":"[jvm]\\
@JvmOverloads
constructor(clientOverrideConfig: ClientOverrideConfiguration = ClientOverrideConfiguration.builder().build(), requiredTables: List<RequiredDynamoDbTable> = listOf(), endpointOverride: URI? = null)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/configure-client/","title":"configureClient - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/configureClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/configure-client/#configureclient","title":"configureClient","text":"[jvm]\\ open fun configureClient(builder: DynamoDbClientBuilder)
open fun configureClient(builder: DynamoDbStreamsClientBuilder)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provide-required-tables/","title":"provideRequiredTables - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/provideRequiredTables
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provide-required-tables/#providerequiredtables","title":"provideRequiredTables","text":"[jvm]\\
@Provides
@Singleton
fun provideRequiredTables(): List<RequiredDynamoDbTable>
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-client/","title":"providesDynamoDbClient - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/providesDynamoDbClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-client/#providesdynamodbclient","title":"providesDynamoDbClient","text":"[jvm]\\
@Provides
@Singleton
fun providesDynamoDbClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-streams-client/","title":"providesDynamoDbStreamsClient - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbModule/providesDynamoDbStreamsClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-module/provides-dynamo-db-streams-client/#providesdynamodbstreamsclient","title":"providesDynamoDbStreamsClient","text":"[jvm]\\
@Provides
@Singleton
fun providesDynamoDbStreamsClient(awsRegion: AwsRegion, awsCredentialsProvider: AwsCredentialsProvider): DynamoDbStreamsClient
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\ @Singleton
class RealDynamoDbService@Injectconstructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>) : AbstractIdleService, DynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/#constructors","title":"Constructors","text":"RealDynamoDbService [jvm]@Injectconstructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>)"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/","title":"RealDynamoDbService - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RealDynamoDbService/RealDynamoDbService
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-real-dynamo-db-service/-real-dynamo-db-service/#realdynamodbservice","title":"RealDynamoDbService","text":"[jvm]\\
@Inject
constructor(dynamoDb: DynamoDbClient, requiredTables: List<RequiredDynamoDbTable>)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ data class RequiredDynamoDbTable(val name: String)
A table that must be available in the DynamoDB instance. If this table doesn\u2019t exist, the service will not start up.
The table name is sometimes prefixed with the service name, like \"urlshortener.urls\".
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/#constructors","title":"Constructors","text":"RequiredDynamoDbTable [jvm]constructor(name: String)"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/","title":"RequiredDynamoDbTable - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RequiredDynamoDbTable/RequiredDynamoDbTable
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/-required-dynamo-db-table/#requireddynamodbtable","title":"RequiredDynamoDbTable","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/name/","title":"name - Misk","text":"//misk-aws2-dynamodb/misk.aws2.dynamodb/RequiredDynamoDbTable/name
"},{"location":"0.x/misk-aws2-dynamodb/misk-aws2-dynamodb/misk.aws2.dynamodb/-required-dynamo-db-table/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-clustering/","title":"misk-clustering - Misk","text":"//misk-clustering
"},{"location":"0.x/misk-clustering/#misk-clustering","title":"misk-clustering","text":""},{"location":"0.x/misk-clustering/#packages","title":"Packages","text":"Name misk.clustering misk.clustering.fake misk.clustering.fake.lease misk.clustering.kubernetes misk.clustering.lease misk.clustering.weights"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/#types","title":"Types","text":"Name Summary Cluster [jvm]interface ClusterA Cluster provides access to cluster membership for a service, allowing instances of a service to monitor the state of its peers ClusterHashRing [jvm]class ClusterHashRing@JvmOverloadsconstructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16) : ClusterResourceMapperA ClusterHashRing maps resources to cluster members based on a consistent hash ClusterResourceMapper [jvm]interface ClusterResourceMapperA ClusterResourceMapper maps string based resource IDs onto members of a cluster for the purposes of resource ownership. The default ClusterResourceMapper is a ClusterHashRing which performs a consistent hash across the cluster member, but Clusters can supply their own mappings if there is a mechanism specific to that cluster (or to supply a fake) ClusterService [jvm]interface ClusterService : ServiceMarker interface for the service that produces a Cluster. ClusterWatch [jvm]typealias ClusterWatch = (Cluster.Changes) -> UnitA ClusterWatch is a callback function triggered when cluster membership changes DefaultCluster [jvm]@Singletonclass DefaultCluster@JvmOverloadsconstructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) }) : AbstractExecutionThreadService, Cluster, ClusterServiceA DefaultCluster is the default implementation of the Cluster, which relies on an outside source such as a cluster watcher to inform it as members become ready or not ready. The DefaultCluster handles computing the actual cluster changes, and managing application watches that need to be triggered as the cluster changes. NoMembersAvailableException [jvm]class NoMembersAvailableException(val resourceId: String) : ExceptionThrown if the cluster does not have any members available."},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/","title":"Cluster - Misk","text":"//misk-clustering/misk.clustering/Cluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#cluster","title":"Cluster","text":"interface Cluster
A Cluster provides access to cluster membership for a service, allowing instances of a service to monitor the state of its peers
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#inheritors","title":"Inheritors","text":"DefaultCluster FakeCluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#types","title":"Types","text":"Name Summary Changes [jvm]data class Changes@JvmOverloadsconstructor(val snapshot: Cluster.Snapshot, val added: Set<Cluster.Member> = setOf(), val removed: Set<Cluster.Member> = setOf()) Member [jvm]data class Member(val name: String, val ipAddress: String) Snapshot [jvm]data class Snapshot@JvmOverloadsconstructor(val self: Cluster.Member, val readyMembers: Set<Cluster.Member>, val selfReady: Boolean = readyMembers.any { it.name == self.name }, val resourceMapper: ClusterResourceMapper)Snapshot is a consistent moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#properties","title":"Properties","text":"Name Summary snapshot [jvm]abstract val snapshot: Cluster.SnapshotThe current moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/#functions","title":"Functions","text":"Name Summary newResourceMapper [jvm]open fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper watch [jvm]abstract fun watch(watch: ClusterWatch)Registers interest in cluster changes"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/new-resource-mapper/","title":"newResourceMapper - Misk","text":"//misk-clustering/misk.clustering/Cluster/newResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/new-resource-mapper/#newresourcemapper","title":"newResourceMapper","text":"[jvm]\\ open fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/new-resource-mapper/#return","title":"Return","text":"A new ClusterResourceMapper for the given set of ready members
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/snapshot/","title":"snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\ abstract val snapshot: Cluster.Snapshot
The current moment-in-time view of the cluster state
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/watch/","title":"watch - Misk","text":"//misk-clustering/misk.clustering/Cluster/watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/watch/#watch","title":"watch","text":"[jvm]\\ abstract fun watch(watch: ClusterWatch)
Registers interest in cluster changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/","title":"Changes - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/#changes","title":"Changes","text":"[jvm]\\ data class Changes@JvmOverloadsconstructor(val snapshot: Cluster.Snapshot, val added: Set<Cluster.Member> = setOf(), val removed: Set<Cluster.Member> = setOf())
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/#constructors","title":"Constructors","text":"Changes [jvm]@JvmOverloadsconstructor(snapshot: Cluster.Snapshot, added: Set<Cluster.Member> = setOf(), removed: Set<Cluster.Member> = setOf())"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/#properties","title":"Properties","text":"Name Summary added [jvm]val added: Set<Cluster.Member> hasDiffs [jvm]val hasDiffs: Boolean removed [jvm]val removed: Set<Cluster.Member> snapshot [jvm]val snapshot: Cluster.Snapshot"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/-changes/","title":"Changes - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/Changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/-changes/#changes","title":"Changes","text":"[jvm]\\
@JvmOverloads
constructor(snapshot: Cluster.Snapshot, added: Set<Cluster.Member> = setOf(), removed: Set<Cluster.Member> = setOf())
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/added/","title":"added - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/added
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/added/#added","title":"added","text":"[jvm]\\ val added: Set<Cluster.Member>
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/has-diffs/","title":"hasDiffs - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/hasDiffs
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/has-diffs/#hasdiffs","title":"hasDiffs","text":"[jvm]\\ val hasDiffs: Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/removed/","title":"removed - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/removed
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/removed/#removed","title":"removed","text":"[jvm]\\ val removed: Set<Cluster.Member>
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/snapshot/","title":"snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/Changes/snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-changes/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\ val snapshot: Cluster.Snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/","title":"Member - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/#member","title":"Member","text":"[jvm]\\ data class Member(val name: String, val ipAddress: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/#constructors","title":"Constructors","text":"Member [jvm]constructor(name: String, ipAddress: String)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/#properties","title":"Properties","text":"Name Summary ipAddress [jvm]val ipAddress: String name [jvm]val name: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/-member/","title":"Member - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member/Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/-member/#member","title":"Member","text":"[jvm]\\ constructor(name: String, ipAddress: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/ip-address/","title":"ipAddress - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member/ipAddress
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/ip-address/#ipaddress","title":"ipAddress","text":"[jvm]\\ val ipAddress: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/name/","title":"name - Misk","text":"//misk-clustering/misk.clustering/Cluster/Member/name
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-member/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/","title":"Snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\ data class Snapshot@JvmOverloadsconstructor(val self: Cluster.Member, val readyMembers: Set<Cluster.Member>, val selfReady: Boolean = readyMembers.any { it.name == self.name }, val resourceMapper: ClusterResourceMapper)
Snapshot is a consistent moment-in-time view of the cluster state
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/#constructors","title":"Constructors","text":"Snapshot [jvm]@JvmOverloadsconstructor(self: Cluster.Member, readyMembers: Set<Cluster.Member>, selfReady: Boolean = readyMembers.any { it.name == self.name }, resourceMapper: ClusterResourceMapper)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/#properties","title":"Properties","text":"Name Summary readyMembers [jvm]val readyMembers: Set<Cluster.Member>All of the members of the cluster that are up and reporting as ready to handle traffic readyPeers [jvm]val readyPeers: Set<Cluster.Member>The of the ready peers; basically all of the ready cluster members except sel resourceMapper [jvm]val resourceMapper: ClusterResourceMapperA ClusterResourceMapper built from the ready members of this cluster self [jvm]val self: Cluster.MemberThe member representing this instance of the service selfReady [jvm]val selfReady: Booleantrue if the current service instance is ready as perceived by the cluster manager"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/-snapshot/","title":"Snapshot - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/Snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\
@JvmOverloads
constructor(self: Cluster.Member, readyMembers: Set<Cluster.Member>, selfReady: Boolean = readyMembers.any { it.name == self.name }, resourceMapper: ClusterResourceMapper)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-members/","title":"readyMembers - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/readyMembers
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-members/#readymembers","title":"readyMembers","text":"[jvm]\\ val readyMembers: Set<Cluster.Member>
All of the members of the cluster that are up and reporting as ready to handle traffic
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-peers/","title":"readyPeers - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/readyPeers
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/ready-peers/#readypeers","title":"readyPeers","text":"[jvm]\\ val readyPeers: Set<Cluster.Member>
The of the ready peers; basically all of the ready cluster members except sel
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/resource-mapper/","title":"resourceMapper - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/resourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/resource-mapper/#resourcemapper","title":"resourceMapper","text":"[jvm]\\ val resourceMapper: ClusterResourceMapper
A ClusterResourceMapper built from the ready members of this cluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self-ready/","title":"selfReady - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/selfReady
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self-ready/#selfready","title":"selfReady","text":"[jvm]\\ val selfReady: Boolean
true if the current service instance is ready as perceived by the cluster manager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self/","title":"self - Misk","text":"//misk-clustering/misk.clustering/Cluster/Snapshot/self
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster/-snapshot/self/#self","title":"self","text":"[jvm]\\ val self: Cluster.Member
The member representing this instance of the service
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/","title":"ClusterHashRing - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/#clusterhashring","title":"ClusterHashRing","text":"[jvm]\\ class ClusterHashRing@JvmOverloadsconstructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16) : ClusterResourceMapper
A ClusterHashRing maps resources to cluster members based on a consistent hash
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/#constructors","title":"Constructors","text":"ClusterHashRing [jvm]@JvmOverloadsconstructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/#functions","title":"Functions","text":"Name Summary equals [jvm]open operator override fun equals(other: Any?): Boolean get [jvm]open operator override fun get(resourceId: String): Cluster.Member hashCode [jvm]open override fun hashCode(): Int"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/-cluster-hash-ring/","title":"ClusterHashRing - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/ClusterHashRing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/-cluster-hash-ring/#clusterhashring","title":"ClusterHashRing","text":"[jvm]\\
@JvmOverloads
constructor(members: Collection<Cluster.Member>, hashFn: HashFunction = Hashing.murmur3_32(), vnodesCount: Int = 16)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/equals/","title":"equals - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/equals
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(resourceId: String): Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/get/#return","title":"Return","text":"The Cluster.Member that should own the given resource id
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/hash-code/","title":"hashCode - Misk","text":"//misk-clustering/misk.clustering/ClusterHashRing/hashCode
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-hash-ring/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/","title":"ClusterResourceMapper - Misk","text":"//misk-clustering/misk.clustering/ClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/#clusterresourcemapper","title":"ClusterResourceMapper","text":"interface ClusterResourceMapper
A ClusterResourceMapper maps string based resource IDs onto members of a cluster for the purposes of resource ownership. The default ClusterResourceMapper is a ClusterHashRing which performs a consistent hash across the cluster member, but Clusters can supply their own mappings if there is a mechanism specific to that cluster (or to supply a fake)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/#inheritors","title":"Inheritors","text":"ClusterHashRing ExplicitClusterResourceMapper"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/#functions","title":"Functions","text":"Name Summary get [jvm]abstract operator fun get(resourceId: String): Cluster.Member"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering/ClusterResourceMapper/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/#get","title":"get","text":"[jvm]\\ abstract operator fun get(resourceId: String): Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/#return","title":"Return","text":"The Cluster.Member that should own the given resource id
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-resource-mapper/get/#throws","title":"Throws","text":"NoMembersAvailableException if there are no members in the cluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/","title":"ClusterService - Misk","text":"//misk-clustering/misk.clustering/ClusterService
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/#clusterservice","title":"ClusterService","text":"interface ClusterService : Service
Marker interface for the service that produces a Cluster.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/#inheritors","title":"Inheritors","text":"DefaultCluster FakeCluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-watch/","title":"ClusterWatch - Misk","text":"//misk-clustering/misk.clustering/ClusterWatch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-cluster-watch/#clusterwatch","title":"ClusterWatch","text":"[jvm]\\ typealias ClusterWatch = (Cluster.Changes) -> Unit
A ClusterWatch is a callback function triggered when cluster membership changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/","title":"DefaultCluster - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#defaultcluster","title":"DefaultCluster","text":"[jvm]\\ @Singleton
class DefaultCluster@JvmOverloadsconstructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) }) : AbstractExecutionThreadService, Cluster, ClusterService
A DefaultCluster is the default implementation of the Cluster, which relies on an outside source such as a cluster watcher to inform it as members become ready or not ready. The DefaultCluster handles computing the actual cluster changes, and managing application watches that need to be triggered as the cluster changes.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#constructors","title":"Constructors","text":"DefaultCluster [jvm]@JvmOverloadsconstructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) })"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#properties","title":"Properties","text":"Name Summary snapshot [jvm]open override val snapshot: Cluster.SnapshotThe current moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) clusterChanged [jvm]@JvmOverloadsfun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf())Triggers a change to the cluster in response members becoming ready or not ready failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean newResourceMapper [jvm]open override fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service syncPoint [jvm]fun syncPoint(callback: () -> Unit)Triggers a callback once all of the actions on the queue have been processed. Useful for writing deterministic tests toString [jvm]open override fun toString(): String watch [jvm]open override fun watch(watch: ClusterWatch)Adds a new cluster watch"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-default-cluster/","title":"DefaultCluster - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/DefaultCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-default-cluster/#defaultcluster","title":"DefaultCluster","text":"[jvm]\\
@JvmOverloads
constructor(self: Cluster.Member, newResourceMapperFn: (members: Set<Cluster.Member>) -> ClusterResourceMapper = { ClusterHashRing(it) })
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/cluster-changed/","title":"clusterChanged - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/clusterChanged
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/cluster-changed/#clusterchanged","title":"clusterChanged","text":"[jvm]\\
@JvmOverloads
fun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf())
Triggers a change to the cluster in response members becoming ready or not ready
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/new-resource-mapper/","title":"newResourceMapper - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/newResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/new-resource-mapper/#newresourcemapper","title":"newResourceMapper","text":"[jvm]\\ open override fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/new-resource-mapper/#return","title":"Return","text":"A new ClusterResourceMapper for the given set of ready members
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/snapshot/","title":"snapshot - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/snapshot
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\ open override val snapshot: Cluster.Snapshot
The current moment-in-time view of the cluster state
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/sync-point/","title":"syncPoint - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/syncPoint
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/sync-point/#syncpoint","title":"syncPoint","text":"[jvm]\\ fun syncPoint(callback: () -> Unit)
Triggers a callback once all of the actions on the queue have been processed. Useful for writing deterministic tests
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/watch/","title":"watch - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(watch: ClusterWatch)
Adds a new cluster watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/","title":"Companion - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/log/","title":"log - Misk","text":"//misk-clustering/misk.clustering/DefaultCluster/Companion/log
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-default-cluster/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/","title":"NoMembersAvailableException - Misk","text":"//misk-clustering/misk.clustering/NoMembersAvailableException
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#nomembersavailableexception","title":"NoMembersAvailableException","text":"[jvm]\\ class NoMembersAvailableException(val resourceId: String) : Exception
Thrown if the cluster does not have any members available.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#constructors","title":"Constructors","text":"NoMembersAvailableException [jvm]constructor(resourceId: String)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String? resourceId [jvm]val resourceId: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/-no-members-available-exception/","title":"NoMembersAvailableException - Misk","text":"//misk-clustering/misk.clustering/NoMembersAvailableException/NoMembersAvailableException
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/-no-members-available-exception/#nomembersavailableexception","title":"NoMembersAvailableException","text":"[jvm]\\ constructor(resourceId: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/resource-id/","title":"resourceId - Misk","text":"//misk-clustering/misk.clustering/NoMembersAvailableException/resourceId
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering/-no-members-available-exception/resource-id/#resourceid","title":"resourceId","text":"[jvm]\\ val resourceId: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.fake
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/#types","title":"Types","text":"Name Summary ExplicitClusterResourceMapper [jvm]class ExplicitClusterResourceMapper : ClusterResourceMapperAn ExplicitClusterResourceMapper is a ClusterResourceMapper where the mapping is explicit managed. FakeCluster [jvm]@Singletonclass FakeCluster : ClusterService, ClusterA FakeCluster is a Cluster that is a fake. It delegates entirely to DefaultCluster, but allows us to keep DefaultCluster internal and make it clear that FakeCluster is only intended to be used for fakes. FakeClusterModule [jvm]class FakeClusterModule : KAbstractModuleFakeClusterModule installs fake implementations of the clustering primitives for use in tests"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/","title":"ExplicitClusterResourceMapper - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/#explicitclusterresourcemapper","title":"ExplicitClusterResourceMapper","text":"[jvm]\\ class ExplicitClusterResourceMapper : ClusterResourceMapper
An ExplicitClusterResourceMapper is a ClusterResourceMapper where the mapping is explicit managed.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/#constructors","title":"Constructors","text":"ExplicitClusterResourceMapper [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/#functions","title":"Functions","text":"Name Summary addMapping [jvm]fun addMapping(resourceId: String, member: Cluster.Member) clearDefaultMapping [jvm]fun clearDefaultMapping() get [jvm]open operator override fun get(resourceId: String): Cluster.Member removeMapping [jvm]fun removeMapping(resourceId: String) setDefaultMapping [jvm]fun setDefaultMapping(member: Cluster.Member)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/-explicit-cluster-resource-mapper/","title":"ExplicitClusterResourceMapper - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/ExplicitClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/-explicit-cluster-resource-mapper/#explicitclusterresourcemapper","title":"ExplicitClusterResourceMapper","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/add-mapping/","title":"addMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/addMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/add-mapping/#addmapping","title":"addMapping","text":"[jvm]\\ fun addMapping(resourceId: String, member: Cluster.Member)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/clear-default-mapping/","title":"clearDefaultMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/clearDefaultMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/clear-default-mapping/#cleardefaultmapping","title":"clearDefaultMapping","text":"[jvm]\\ fun clearDefaultMapping()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(resourceId: String): Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/#return","title":"Return","text":"The Cluster.Member that should own the given resource id
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/get/#throws","title":"Throws","text":"NoMembersAvailableException if there are no members in the cluster"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/remove-mapping/","title":"removeMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/removeMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/remove-mapping/#removemapping","title":"removeMapping","text":"[jvm]\\ fun removeMapping(resourceId: String)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/set-default-mapping/","title":"setDefaultMapping - Misk","text":"//misk-clustering/misk.clustering.fake/ExplicitClusterResourceMapper/setDefaultMapping
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-explicit-cluster-resource-mapper/set-default-mapping/#setdefaultmapping","title":"setDefaultMapping","text":"[jvm]\\ fun setDefaultMapping(member: Cluster.Member)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/","title":"FakeCluster - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#fakecluster","title":"FakeCluster","text":"[jvm]\\ @Singleton
class FakeCluster : ClusterService, Cluster
A FakeCluster is a Cluster that is a fake. It delegates entirely to DefaultCluster, but allows us to keep DefaultCluster internal and make it clear that FakeCluster is only intended to be used for fakes.
NB(mmihic): I\u2019d prefer for this to be in the misk-testing module, but it can\u2019t since it relies on DefaultCluster and we want to leave DefaultCluster internal
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#constructors","title":"Constructors","text":"FakeCluster [jvm]constructor(resourceMapper: ExplicitClusterResourceMapper)@Injectconstructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#properties","title":"Properties","text":"Name Summary resourceMapper [jvm]val resourceMapper: ExplicitClusterResourceMapper snapshot [jvm]open override val snapshot: Cluster.SnapshotThe current moment-in-time view of the cluster state"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/#functions","title":"Functions","text":"Name Summary addListener [jvm]open override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]open override fun awaitRunning()open fun awaitRunning(timeout: Duration)open override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]open override fun awaitTerminated()open fun awaitTerminated(timeout: Duration)open override fun awaitTerminated(timeout: Long, unit: TimeUnit) clusterChanged [jvm]@JvmOverloadsfun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf()) failureCause [jvm]open override fun failureCause(): Throwable isRunning [jvm]open override fun isRunning(): Boolean newResourceMapper [jvm]open override fun newResourceMapper(readyMembers: Set<Cluster.Member>): ClusterResourceMapper startAsync [jvm]@CanIgnoreReturnValueopen override fun startAsync(): Service state [jvm]open override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueopen override fun stopAsync(): Service watch [jvm]open override fun watch(watch: ClusterWatch)Registers interest in cluster changes"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-fake-cluster/","title":"FakeCluster - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/FakeCluster
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-fake-cluster/#fakecluster","title":"FakeCluster","text":"[jvm]\\ constructor(resourceMapper: ExplicitClusterResourceMapper)
@Inject
constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/cluster-changed/","title":"clusterChanged - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/clusterChanged
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/cluster-changed/#clusterchanged","title":"clusterChanged","text":"[jvm]\\
@JvmOverloads
fun clusterChanged(membersBecomingReady: Set<Cluster.Member> = setOf(), membersBecomingNotReady: Set<Cluster.Member> = setOf())
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/resource-mapper/","title":"resourceMapper - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/resourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/resource-mapper/#resourcemapper","title":"resourceMapper","text":"[jvm]\\ val resourceMapper: ExplicitClusterResourceMapper
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/watch/","title":"watch - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/watch
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(watch: ClusterWatch)
Registers interest in cluster changes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/","title":"Companion - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/#properties","title":"Properties","text":"Name Summary self [jvm]@JvmStaticval self: Cluster.Member SELF_IP [jvm]const val SELF_IP: String SELF_NAME [jvm]const val SELF_NAME: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-i-p/","title":"SELF_IP - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion/SELF_IP
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-i-p/#self_ip","title":"SELF_IP","text":"[jvm]\\ const val SELF_IP: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-n-a-m-e/","title":"SELF_NAME - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion/SELF_NAME
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/-s-e-l-f_-n-a-m-e/#self_name","title":"SELF_NAME","text":"[jvm]\\ const val SELF_NAME: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/self/","title":"self - Misk","text":"//misk-clustering/misk.clustering.fake/FakeCluster/Companion/self
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster/-companion/self/#self","title":"self","text":"[jvm]\\
@JvmStatic
val self: Cluster.Member
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/","title":"FakeClusterModule - Misk","text":"//misk-clustering/misk.clustering.fake/FakeClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/#fakeclustermodule","title":"FakeClusterModule","text":"[jvm]\\ class FakeClusterModule : KAbstractModule
FakeClusterModule installs fake implementations of the clustering primitives for use in tests
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/#constructors","title":"Constructors","text":"FakeClusterModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/-fake-cluster-module/","title":"FakeClusterModule - Misk","text":"//misk-clustering/misk.clustering.fake/FakeClusterModule/FakeClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake/-fake-cluster-module/-fake-cluster-module/#fakeclustermodule","title":"FakeClusterModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.fake.lease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/#types","title":"Types","text":"Name Summary FakeLeaseManager [jvm]@Singletonclass FakeLeaseManager@Injectconstructor : FakeLeaseManagerA FakeLeaseManager provides explicit control over leases for the purposes of testing. By default a lease is considered held, but it can be explicitly marked as not held if desired FakeLeaseModule [jvm]class FakeLeaseModule : KAbstractModuleFakeLeaseModule installs support for leasing using fakes"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseManager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\ @Singleton
class FakeLeaseManager@Injectconstructor : FakeLeaseManager
A FakeLeaseManager provides explicit control over leases for the purposes of testing. By default a lease is considered held, but it can be explicitly marked as not held if desired
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/#constructors","title":"Constructors","text":"FakeLeaseManager [jvm]@Injectconstructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/#functions","title":"Functions","text":"Name Summary isLeaseHeld [jvm]fun isLeaseHeld(name: String): Boolean markLeaseHeld [jvm]fun markLeaseHeld(name: String) markLeaseHeldElsewhere [jvm]fun markLeaseHeldElsewhere(name: String) releaseAll [jvm]open override fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): Lease"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseManager/FakeLeaseManager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-manager/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/","title":"FakeLeaseModule - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/#fakeleasemodule","title":"FakeLeaseModule","text":"[jvm]\\ class FakeLeaseModule : KAbstractModule
FakeLeaseModule installs support for leasing using fakes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/#constructors","title":"Constructors","text":"FakeLeaseModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/-fake-lease-module/","title":"FakeLeaseModule - Misk","text":"//misk-clustering/misk.clustering.fake.lease/FakeLeaseModule/FakeLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.fake.lease/-fake-lease-module/-fake-lease-module/#fakeleasemodule","title":"FakeLeaseModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.kubernetes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/#types","title":"Types","text":"Name Summary KubernetesClusterModule [jvm]class KubernetesClusterModule(config: KubernetesConfig) : KAbstractModuleKubernetesClusterModule installs cluster support based on Kubernetes KubernetesConfig [jvm]data class KubernetesConfig@JvmOverloadsconstructor(val my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", val my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", val my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", val clustering_pod_label_selector: String? = null, val kubernetes_watch_read_timeout: Long = 60, val kubernetes_read_timeout: Long = 15, val kubernetes_connect_timeout: Long = 5) : Config"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/","title":"KubernetesClusterModule - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/#kubernetesclustermodule","title":"KubernetesClusterModule","text":"[jvm]\\ class KubernetesClusterModule(config: KubernetesConfig) : KAbstractModule
KubernetesClusterModule installs cluster support based on Kubernetes
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/#constructors","title":"Constructors","text":"KubernetesClusterModule [jvm]constructor(config: KubernetesConfig)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/-kubernetes-cluster-module/","title":"KubernetesClusterModule - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesClusterModule/KubernetesClusterModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-cluster-module/-kubernetes-cluster-module/#kubernetesclustermodule","title":"KubernetesClusterModule","text":"[jvm]\\ constructor(config: KubernetesConfig)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/","title":"KubernetesConfig - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/#kubernetesconfig","title":"KubernetesConfig","text":"[jvm]\\ data class KubernetesConfig@JvmOverloadsconstructor(val my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", val my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", val my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", val clustering_pod_label_selector: String? = null, val kubernetes_watch_read_timeout: Long = 60, val kubernetes_read_timeout: Long = 15, val kubernetes_connect_timeout: Long = 5) : Config
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/#constructors","title":"Constructors","text":"KubernetesConfig [jvm]@JvmOverloadsconstructor(my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", clustering_pod_label_selector: String? = null, kubernetes_watch_read_timeout: Long = 60, kubernetes_read_timeout: Long = 15, kubernetes_connect_timeout: Long = 5)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/#properties","title":"Properties","text":"Name Summary clustering_pod_label_selector [jvm]val clustering_pod_label_selector: String? = nullOptional Kubernetes label selector to filter which pods in the namespace are considered to be in the same cluster. If omitted, all healthy pods in the namespace are included in the cluster. Ex: \"app = helloserver\". kubernetes_connect_timeout [jvm]val kubernetes_connect_timeout: Long = 5 kubernetes_read_timeout [jvm]val kubernetes_read_timeout: Long = 15 kubernetes_watch_read_timeout [jvm]val kubernetes_watch_read_timeout: Long = 60 my_pod_ip [jvm]val my_pod_ip: String my_pod_name [jvm]val my_pod_name: String my_pod_namespace [jvm]val my_pod_namespace: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/-kubernetes-config/","title":"KubernetesConfig - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/KubernetesConfig
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/-kubernetes-config/#kubernetesconfig","title":"KubernetesConfig","text":"[jvm]\\
@JvmOverloads
constructor(my_pod_namespace: String = System.getenv(\"MY_POD_NAMESPACE\") ?: \"<invalid-namespace>\", my_pod_name: String = System.getenv(\"MY_POD_NAME\") ?: \"<invalid-pod-name>\", my_pod_ip: String = System.getenv(\"MY_POD_IP\") ?: \"<invalid-pod-ip>\", clustering_pod_label_selector: String? = null, kubernetes_watch_read_timeout: Long = 60, kubernetes_read_timeout: Long = 15, kubernetes_connect_timeout: Long = 5)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/clustering_pod_label_selector/","title":"clustering_pod_label_selector - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/clustering_pod_label_selector
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/clustering_pod_label_selector/#clustering_pod_label_selector","title":"clustering_pod_label_selector","text":"[jvm]\\ val clustering_pod_label_selector: String? = null
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_connect_timeout/","title":"kubernetes_connect_timeout - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/kubernetes_connect_timeout
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_connect_timeout/#kubernetes_connect_timeout","title":"kubernetes_connect_timeout","text":"[jvm]\\ val kubernetes_connect_timeout: Long = 5
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_read_timeout/","title":"kubernetes_read_timeout - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/kubernetes_read_timeout
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_read_timeout/#kubernetes_read_timeout","title":"kubernetes_read_timeout","text":"[jvm]\\ val kubernetes_read_timeout: Long = 15
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_watch_read_timeout/","title":"kubernetes_watch_read_timeout - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/kubernetes_watch_read_timeout
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/kubernetes_watch_read_timeout/#kubernetes_watch_read_timeout","title":"kubernetes_watch_read_timeout","text":"[jvm]\\ val kubernetes_watch_read_timeout: Long = 60
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_ip/","title":"my_pod_ip - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/my_pod_ip
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_ip/#my_pod_ip","title":"my_pod_ip","text":"[jvm]\\ val my_pod_ip: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_name/","title":"my_pod_name - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/my_pod_name
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_name/#my_pod_name","title":"my_pod_name","text":"[jvm]\\ val my_pod_name: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_namespace/","title":"my_pod_namespace - Misk","text":"//misk-clustering/misk.clustering.kubernetes/KubernetesConfig/my_pod_namespace
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.kubernetes/-kubernetes-config/my_pod_namespace/#my_pod_namespace","title":"my_pod_namespace","text":"[jvm]\\ val my_pod_namespace: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.lease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/#types","title":"Types","text":"Name Summary ClusterAwareLease [jvm]class ClusterAwareLease(val name: String, clusterWeightProvider: ClusterWeightProvider) : LeaseProvides functions to acquire and check if a lease is held. Returns true for acquire() and checkHeld() if the app is running in the active region. ClusterAwareLeaseManager [jvm]class ClusterAwareLeaseManager : LeaseManagerReturns a Lease that always returns true for acquire() and checkHeld() if the app is running in the active region. ClusterAwareLeaseModule [jvm]class ClusterAwareLeaseModule : KAbstractModuleConfigures a LeaseManager that has leases that always return true for acquire() and checkHeld() if the app is running in the active region."},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/","title":"ClusterAwareLease - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#clusterawarelease","title":"ClusterAwareLease","text":"[jvm]\\ class ClusterAwareLease(val name: String, clusterWeightProvider: ClusterWeightProvider) : Lease
Provides functions to acquire and check if a lease is held. Returns true for acquire() and checkHeld() if the app is running in the active region.
This lease serves as a no-op lease, suitable for situations where lease injection is necessary but not functionally important, such as in Misk SQS.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#constructors","title":"Constructors","text":"ClusterAwareLease [jvm]constructor(name: String, clusterWeightProvider: ClusterWeightProvider)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): Boolean addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener) checkHeld [jvm]open override fun checkHeld(): Boolean release [jvm]open override fun release(): Boolean"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/-cluster-aware-lease/","title":"ClusterAwareLease - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/ClusterAwareLease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/-cluster-aware-lease/#clusterawarelease","title":"ClusterAwareLease","text":"[jvm]\\ constructor(name: String, clusterWeightProvider: ClusterWeightProvider)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/acquire/","title":"acquire - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/acquire
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/add-listener/","title":"addListener - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/addListener
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/add-listener/#addlistener","title":"addListener","text":"[jvm]\\ open override fun addListener(listener: Lease.StateChangeListener)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/check-held/","title":"checkHeld - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/checkHeld
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ open override fun checkHeld(): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/name/","title":"name - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/name
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/name/#name","title":"name","text":"[jvm]\\ open override val name: String
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/release/","title":"release - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLease/release
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease/release/#release","title":"release","text":"[jvm]\\ open override fun release(): Boolean
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/","title":"ClusterAwareLeaseManager - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseManager
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/#clusterawareleasemanager","title":"ClusterAwareLeaseManager","text":"[jvm]\\ class ClusterAwareLeaseManager : LeaseManager
Returns a Lease that always returns true for acquire() and checkHeld() if the app is running in the active region.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/#functions","title":"Functions","text":"Name Summary releaseAll [jvm]open fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): Lease"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/request-lease/","title":"requestLease - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseManager/requestLease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ open override fun requestLease(name: String): Lease
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/","title":"ClusterAwareLeaseModule - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/#clusterawareleasemodule","title":"ClusterAwareLeaseModule","text":"[jvm]\\ class ClusterAwareLeaseModule : KAbstractModule
Configures a LeaseManager that has leases that always return true for acquire() and checkHeld() if the app is running in the active region.
This can be used to ignore the lease injection required for Misk SQS Jobs.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/#constructors","title":"Constructors","text":"ClusterAwareLeaseModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/-cluster-aware-lease-module/","title":"ClusterAwareLeaseModule - Misk","text":"//misk-clustering/misk.clustering.lease/ClusterAwareLeaseModule/ClusterAwareLeaseModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.lease/-cluster-aware-lease-module/-cluster-aware-lease-module/#clusterawareleasemodule","title":"ClusterAwareLeaseModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/","title":"Package-level declarations - Misk","text":"//misk-clustering/misk.clustering.weights
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/#types","title":"Types","text":"Name Summary ActiveClusterWeight [jvm]class ActiveClusterWeight : ClusterWeightProviderA static ClusterWeightProvider that always returns 100 ActiveClusterWeightModule [jvm]class ActiveClusterWeightModule : KAbstractModuleProvides an ActiveClusterWeight ClusterWeightProvider [jvm]interface ClusterWeightProviderProvides the current weight assigned to the cluster. ClusterWeightService [jvm]interface ClusterWeightService : ServiceA marker interface for the Service that produces the ClusterWeightProvider. FakeClusterWeight [jvm]class FakeClusterWeight : ClusterWeightProviderA ClusterWeightProvider for testing FakeClusterWeightModule [jvm]class FakeClusterWeightModule : KAbstractModuleProvides a FakeClusterWeight for testing"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/","title":"ActiveClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/#activeclusterweight","title":"ActiveClusterWeight","text":"[jvm]\\ class ActiveClusterWeight : ClusterWeightProvider
A static ClusterWeightProvider that always returns 100
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/#constructors","title":"Constructors","text":"ActiveClusterWeight [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Int"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/-active-cluster-weight/","title":"ActiveClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeight/ActiveClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/-active-cluster-weight/#activeclusterweight","title":"ActiveClusterWeight","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeight/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/","title":"ActiveClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/#activeclusterweightmodule","title":"ActiveClusterWeightModule","text":"[jvm]\\ class ActiveClusterWeightModule : KAbstractModule
Provides an ActiveClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/#constructors","title":"Constructors","text":"ActiveClusterWeightModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/-active-cluster-weight-module/","title":"ActiveClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/ActiveClusterWeightModule/ActiveClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-active-cluster-weight-module/-active-cluster-weight-module/#activeclusterweightmodule","title":"ActiveClusterWeightModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/","title":"ClusterWeightProvider - Misk","text":"//misk-clustering/misk.clustering.weights/ClusterWeightProvider
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/#clusterweightprovider","title":"ClusterWeightProvider","text":"interface ClusterWeightProvider
Provides the current weight assigned to the cluster.
A weight value is between 0 and 100 to indicate how much traffic a cluster should handle. Typically an active-passive setup has 1 active cluster with 100 and 1 passive cluster with 0.
If your application does not require dynamic cluster weights, you can install the ActiveClusterWeightModule
If your application does require dynamic cluster weights, you need must provide your own impl and ClusterWeightService for others to depend on.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/#inheritors","title":"Inheritors","text":"ActiveClusterWeight FakeClusterWeight"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(): Int"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.weights/ClusterWeightProvider/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-provider/get/#get","title":"get","text":"[jvm]\\ abstract fun get(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-service/","title":"ClusterWeightService - Misk","text":"//misk-clustering/misk.clustering.weights/ClusterWeightService
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-service/#clusterweightservice","title":"ClusterWeightService","text":"[jvm]\\ interface ClusterWeightService : Service
A marker interface for the Service that produces the ClusterWeightProvider.
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-cluster-weight-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/","title":"FakeClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/#fakeclusterweight","title":"FakeClusterWeight","text":"[jvm]\\ class FakeClusterWeight : ClusterWeightProvider
A ClusterWeightProvider for testing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/#constructors","title":"Constructors","text":"FakeClusterWeight [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Int setClusterWeight [jvm]fun setClusterWeight(weight: Int)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/-fake-cluster-weight/","title":"FakeClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight/FakeClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/-fake-cluster-weight/#fakeclusterweight","title":"FakeClusterWeight","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/get/","title":"get - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight/get
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Int
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/set-cluster-weight/","title":"setClusterWeight - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeight/setClusterWeight
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight/set-cluster-weight/#setclusterweight","title":"setClusterWeight","text":"[jvm]\\ fun setClusterWeight(weight: Int)
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/","title":"FakeClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/#fakeclusterweightmodule","title":"FakeClusterWeightModule","text":"[jvm]\\ class FakeClusterWeightModule : KAbstractModule
Provides a FakeClusterWeight for testing
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/#constructors","title":"Constructors","text":"FakeClusterWeightModule [jvm]constructor()"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/-fake-cluster-weight-module/","title":"FakeClusterWeightModule - Misk","text":"//misk-clustering/misk.clustering.weights/FakeClusterWeightModule/FakeClusterWeightModule
"},{"location":"0.x/misk-clustering/misk-clustering/misk.clustering.weights/-fake-cluster-weight-module/-fake-cluster-weight-module/#fakeclusterweightmodule","title":"FakeClusterWeightModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-clustering-dynamodb/","title":"misk-clustering-dynamodb - Misk","text":"//misk-clustering-dynamodb
"},{"location":"0.x/misk-clustering-dynamodb/#misk-clustering-dynamodb","title":"misk-clustering-dynamodb","text":""},{"location":"0.x/misk-clustering-dynamodb/#packages","title":"Packages","text":"Name misk.clustering.dynamo"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/","title":"Package-level declarations - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/#types","title":"Types","text":"Name Summary DynamoClusterConfig [jvm]data class DynamoClusterConfig@JvmOverloadsconstructor(val appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", var table_name: String = \".misk-cluster-members\", val update_frequency_seconds: Long = 30, val stale_threshold_seconds: Long = 60) : Config DynamoClusterModule [jvm]class DynamoClusterModule@JvmOverloadsconstructor(config: DynamoClusterConfig = DynamoClusterConfig()) : KAbstractModule"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/","title":"DynamoClusterConfig - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/#dynamoclusterconfig","title":"DynamoClusterConfig","text":"[jvm]\\ data class DynamoClusterConfig@JvmOverloadsconstructor(val appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", var table_name: String = \".misk-cluster-members\", val update_frequency_seconds: Long = 30, val stale_threshold_seconds: Long = 60) : Config
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/#constructors","title":"Constructors","text":"DynamoClusterConfig [jvm]@JvmOverloadsconstructor(appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", table_name: String = \".misk-cluster-members\", update_frequency_seconds: Long = 30, stale_threshold_seconds: Long = 60)"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/#properties","title":"Properties","text":"Name Summary appName [jvm]val appName: String stale_threshold_seconds [jvm]val stale_threshold_seconds: Long = 60 table_name [jvm]var table_name: String update_frequency_seconds [jvm]val update_frequency_seconds: Long = 30"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/-dynamo-cluster-config/","title":"DynamoClusterConfig - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/DynamoClusterConfig
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/-dynamo-cluster-config/#dynamoclusterconfig","title":"DynamoClusterConfig","text":"[jvm]\\
@JvmOverloads
constructor(appName: String = System.getenv(\"SERVICE_NAME\") ?: \"<invalid-service-name>\", table_name: String = \".misk-cluster-members\", update_frequency_seconds: Long = 30, stale_threshold_seconds: Long = 60)
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/app-name/","title":"appName - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/appName
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/app-name/#appname","title":"appName","text":"[jvm]\\ val appName: String
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/stale_threshold_seconds/","title":"stale_threshold_seconds - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/stale_threshold_seconds
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/stale_threshold_seconds/#stale_threshold_seconds","title":"stale_threshold_seconds","text":"[jvm]\\ val stale_threshold_seconds: Long = 60
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/table_name/","title":"table_name - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/table_name
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/table_name/#table_name","title":"table_name","text":"[jvm]\\ var table_name: String
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/update_frequency_seconds/","title":"update_frequency_seconds - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterConfig/update_frequency_seconds
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-config/update_frequency_seconds/#update_frequency_seconds","title":"update_frequency_seconds","text":"[jvm]\\ val update_frequency_seconds: Long = 30
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/","title":"DynamoClusterModule - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterModule
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/#dynamoclustermodule","title":"DynamoClusterModule","text":"[jvm]\\ class DynamoClusterModule@JvmOverloadsconstructor(config: DynamoClusterConfig = DynamoClusterConfig()) : KAbstractModule
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/#constructors","title":"Constructors","text":"DynamoClusterModule [jvm]@JvmOverloadsconstructor(config: DynamoClusterConfig = DynamoClusterConfig())"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/-dynamo-cluster-module/","title":"DynamoClusterModule - Misk","text":"//misk-clustering-dynamodb/misk.clustering.dynamo/DynamoClusterModule/DynamoClusterModule
"},{"location":"0.x/misk-clustering-dynamodb/misk-clustering-dynamodb/misk.clustering.dynamo/-dynamo-cluster-module/-dynamo-cluster-module/#dynamoclustermodule","title":"DynamoClusterModule","text":"[jvm]\\
@JvmOverloads
constructor(config: DynamoClusterConfig = DynamoClusterConfig())
"},{"location":"0.x/misk-config/","title":"misk-config - Misk","text":"//misk-config
"},{"location":"0.x/misk-config/#misk-config","title":"misk-config","text":""},{"location":"0.x/misk-config/#packages","title":"Packages","text":"Name misk.config misk.resources misk.web.metadata"},{"location":"0.x/misk-config/misk-config/misk.config/","title":"Package-level declarations - Misk","text":"//misk-config/misk.config
"},{"location":"0.x/misk-config/misk-config/misk.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-config/misk-config/misk.config/#types","title":"Types","text":"Name Summary AppName [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])annotation class AppName AppNameModule [jvm]class AppNameModule(appName: String) : KAbstractModuleBinds a @AppName String to the provided application name ConfigModule [jvm]class ConfigModule<T : Config>(configClass: Class<T>, appName: String, config: T) : KAbstractModule MiskConfig [jvm]object MiskConfig Redact [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])annotation class RedactField or class will be redacted in dashboard output. Secret [jvm]interface Secret<T>Type for any secrets that need to be loaded as reference in their config file. Secret addresses should use format specified in misk.resources.ResourceLoader."},{"location":"0.x/misk-config/misk-config/misk.config/-app-name/","title":"AppName - Misk","text":"//misk-config/misk.config/AppName
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name/#appname","title":"AppName","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])
annotation class AppName
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/","title":"AppNameModule - Misk","text":"//misk-config/misk.config/AppNameModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/#appnamemodule","title":"AppNameModule","text":"[jvm]\\ class AppNameModule(appName: String) : KAbstractModule
Binds a @AppName String to the provided application name
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/#constructors","title":"Constructors","text":"AppNameModule [jvm]constructor(appName: String)"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/-app-name-module/","title":"AppNameModule - Misk","text":"//misk-config/misk.config/AppNameModule/AppNameModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-app-name-module/-app-name-module/#appnamemodule","title":"AppNameModule","text":"[jvm]\\ constructor(appName: String)
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/","title":"ConfigModule - Misk","text":"//misk-config/misk.config/ConfigModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#configmodule","title":"ConfigModule","text":"[jvm]\\ class ConfigModule<T : Config>(configClass: Class<T>, appName: String, config: T) : KAbstractModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#constructors","title":"Constructors","text":"ConfigModule [jvm]constructor(configClass: Class<T>, appName: String, config: T)"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-config-module/","title":"ConfigModule - Misk","text":"//misk-config/misk.config/ConfigModule/ConfigModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-config-module/#configmodule","title":"ConfigModule","text":"[jvm]\\ constructor(configClass: Class<T>, appName: String, config: T)
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/","title":"Companion - Misk","text":"//misk-config/misk.config/ConfigModule/Companion
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <T : Config> create(appName: String, config: T): ConfigModule<T>"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/create/","title":"create - Misk","text":"//misk-config/misk.config/ConfigModule/Companion/create
"},{"location":"0.x/misk-config/misk-config/misk.config/-config-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <T : Config> create(appName: String, config: T): ConfigModule<T>
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/","title":"MiskConfig - Misk","text":"//misk-config/misk.config/MiskConfig
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/#miskconfig","title":"MiskConfig","text":"[jvm]\\ object MiskConfig
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/#types","title":"Types","text":"Name Summary RealSecret [jvm]class RealSecret<T>@JvmOverloadsconstructor(val value: T, reference: String = \"\") : Secret<T> RedactSecretJacksonModule [jvm]class RedactSecretJacksonModule : SimpleModule SecretJacksonModule [jvm]class SecretJacksonModule(val resourceLoader: ResourceLoader, val mapper: ObjectMapper) : SimpleModule"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/#functions","title":"Functions","text":"Name Summary filesInDir [jvm]@JvmStaticfun filesInDir(dir: String, filter: FilenameFilter = FilenameFilter { _, filename -> filename.endsWith(\".yaml\") }): List<File> load [jvm]@JvmStaticinline fun <T : Config> load(appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticfun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticinline fun <T : Config> load(appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticfun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T@JvmStaticfun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM, failOnUnknownProperties: Boolean): T loadConfigYamlMap [jvm]fun loadConfigYamlMap(appName: String, deployment: Deployment, overrideResources: List<String>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): Map<String, String?>Returns a map whose keys are the names of the source Yaml files to load, and whose values are the contents of those files. If a file is absent the map\u2019s value will be null. toRedactedYaml [jvm]fun <T : Config> toRedactedYaml(config: T, resourceLoader: ResourceLoader): String"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/files-in-dir/","title":"filesInDir - Misk","text":"//misk-config/misk.config/MiskConfig/filesInDir
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/files-in-dir/#filesindir","title":"filesInDir","text":"[jvm]\\
@JvmStatic
fun filesInDir(dir: String, filter: FilenameFilter = FilenameFilter { _, filename -> filename.endsWith(\".yaml\") }): List<File>
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load-config-yaml-map/","title":"loadConfigYamlMap - Misk","text":"//misk-config/misk.config/MiskConfig/loadConfigYamlMap
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load-config-yaml-map/#loadconfigyamlmap","title":"loadConfigYamlMap","text":"[jvm]\\ fun loadConfigYamlMap(appName: String, deployment: Deployment, overrideResources: List<String>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): Map<String, String?>
Returns a map whose keys are the names of the source Yaml files to load, and whose values are the contents of those files. If a file is absent the map\u2019s value will be null.
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load/","title":"load - Misk","text":"//misk-config/misk.config/MiskConfig/load
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/load/#load","title":"load","text":"[jvm]\\
@JvmStatic
inline fun <T : Config> load(appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
inline fun <T : Config> load(appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
fun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideFiles: List<File> = listOf(), resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
fun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): T
@JvmStatic
fun <T : Config> load(configClass: Class<out Config>, appName: String, deployment: Deployment, overrideResources: List<String> = listOf(), overrideValues: JsonNode? = null, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM, failOnUnknownProperties: Boolean): T
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/to-redacted-yaml/","title":"toRedactedYaml - Misk","text":"//misk-config/misk.config/MiskConfig/toRedactedYaml
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/to-redacted-yaml/#toredactedyaml","title":"toRedactedYaml","text":"[jvm]\\ fun <T : Config> toRedactedYaml(config: T, resourceLoader: ResourceLoader): String
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/","title":"RealSecret - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#realsecret","title":"RealSecret","text":"[jvm]\\ class RealSecret<T>@JvmOverloadsconstructor(val value: T, reference: String = \"\") : Secret<T>
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#constructors","title":"Constructors","text":"RealSecret [jvm]@JvmOverloadsconstructor(value: T, reference: String = \"\")"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#properties","title":"Properties","text":"Name Summary value [jvm]open override val value: T"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/-real-secret/","title":"RealSecret - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret/RealSecret
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/-real-secret/#realsecret","title":"RealSecret","text":"[jvm]\\
@JvmOverloads
constructor(value: T, reference: String = \"\")
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/to-string/","title":"toString - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret/toString
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/value/","title":"value - Misk","text":"//misk-config/misk.config/MiskConfig/RealSecret/value
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-real-secret/value/#value","title":"value","text":"[jvm]\\ open override val value: T
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/","title":"RedactSecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/RedactSecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/#redactsecretjacksonmodule","title":"RedactSecretJacksonModule","text":"[jvm]\\ class RedactSecretJacksonModule : SimpleModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/#constructors","title":"Constructors","text":"RedactSecretJacksonModule [jvm]constructor()"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/#functions","title":"Functions","text":"Name Summary addAbstractTypeMapping [jvm]open fun <T : Any> addAbstractTypeMapping(p0: Class<T>, p1: Class<out T>): SimpleModule addDeserializer [jvm]open fun <T : Any> addDeserializer(p0: Class<T>, p1: JsonDeserializer<out T>): SimpleModule addKeyDeserializer [jvm]open fun addKeyDeserializer(p0: Class<*>, p1: KeyDeserializer): SimpleModule addKeySerializer [jvm]open fun <T : Any> addKeySerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addSerializer [jvm]open fun addSerializer(p0: JsonSerializer<*>): SimpleModuleopen fun <T : Any> addSerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addValueInstantiator [jvm]open fun addValueInstantiator(p0: Class<*>, p1: ValueInstantiator): SimpleModule getDependencies [jvm]open fun getDependencies(): MutableIterable<Module> getModuleName [jvm]open override fun getModuleName(): String getTypeId [jvm]open override fun getTypeId(): Any registerSubtypes [jvm]open fun registerSubtypes(vararg p0: NamedType): SimpleModuleopen fun registerSubtypes(vararg p0: Class<>): SimpleModuleopen fun registerSubtypes(p0: MutableCollection<Class<>>): SimpleModule setAbstractTypes [jvm]open fun setAbstractTypes(p0: SimpleAbstractTypeResolver) setDeserializerModifier [jvm]open fun setDeserializerModifier(p0: BeanDeserializerModifier): SimpleModule setDeserializers [jvm]open fun setDeserializers(p0: SimpleDeserializers) setKeyDeserializers [jvm]open fun setKeyDeserializers(p0: SimpleKeyDeserializers) setKeySerializers [jvm]open fun setKeySerializers(p0: SimpleSerializers) setMixInAnnotation [jvm]open fun setMixInAnnotation(p0: Class<>, p1: Class<>): SimpleModule setSerializerModifier [jvm]open fun setSerializerModifier(p0: BeanSerializerModifier): SimpleModule setSerializers [jvm]open fun setSerializers(p0: SimpleSerializers) setupModule [jvm]open override fun setupModule(context: Module.SetupContext?) setValueInstantiators [jvm]open fun setValueInstantiators(p0: SimpleValueInstantiators) version [jvm]open override fun version(): Version"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/-redact-secret-jackson-module/","title":"RedactSecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/RedactSecretJacksonModule/RedactSecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/-redact-secret-jackson-module/#redactsecretjacksonmodule","title":"RedactSecretJacksonModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/setup-module/","title":"setupModule - Misk","text":"//misk-config/misk.config/MiskConfig/RedactSecretJacksonModule/setupModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-redact-secret-jackson-module/setup-module/#setupmodule","title":"setupModule","text":"[jvm]\\ open override fun setupModule(context: Module.SetupContext?)
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/","title":"SecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#secretjacksonmodule","title":"SecretJacksonModule","text":"[jvm]\\ class SecretJacksonModule(val resourceLoader: ResourceLoader, val mapper: ObjectMapper) : SimpleModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#constructors","title":"Constructors","text":"SecretJacksonModule [jvm]constructor(resourceLoader: ResourceLoader, mapper: ObjectMapper)"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#properties","title":"Properties","text":"Name Summary mapper [jvm]val mapper: ObjectMapper resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/#functions","title":"Functions","text":"Name Summary addAbstractTypeMapping [jvm]open fun <T : Any> addAbstractTypeMapping(p0: Class<T>, p1: Class<out T>): SimpleModule addDeserializer [jvm]open fun <T : Any> addDeserializer(p0: Class<T>, p1: JsonDeserializer<out T>): SimpleModule addKeyDeserializer [jvm]open fun addKeyDeserializer(p0: Class<*>, p1: KeyDeserializer): SimpleModule addKeySerializer [jvm]open fun <T : Any> addKeySerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addSerializer [jvm]open fun addSerializer(p0: JsonSerializer<*>): SimpleModuleopen fun <T : Any> addSerializer(p0: Class<out T>, p1: JsonSerializer<T>): SimpleModule addValueInstantiator [jvm]open fun addValueInstantiator(p0: Class<*>, p1: ValueInstantiator): SimpleModule getDependencies [jvm]open fun getDependencies(): MutableIterable<Module> getModuleName [jvm]open override fun getModuleName(): String getTypeId [jvm]open override fun getTypeId(): Any registerSubtypes [jvm]open fun registerSubtypes(vararg p0: NamedType): SimpleModuleopen fun registerSubtypes(vararg p0: Class<>): SimpleModuleopen fun registerSubtypes(p0: MutableCollection<Class<>>): SimpleModule setAbstractTypes [jvm]open fun setAbstractTypes(p0: SimpleAbstractTypeResolver) setDeserializerModifier [jvm]open fun setDeserializerModifier(p0: BeanDeserializerModifier): SimpleModule setDeserializers [jvm]open fun setDeserializers(p0: SimpleDeserializers) setKeyDeserializers [jvm]open fun setKeyDeserializers(p0: SimpleKeyDeserializers) setKeySerializers [jvm]open fun setKeySerializers(p0: SimpleSerializers) setMixInAnnotation [jvm]open fun setMixInAnnotation(p0: Class<>, p1: Class<>): SimpleModule setSerializerModifier [jvm]open fun setSerializerModifier(p0: BeanSerializerModifier): SimpleModule setSerializers [jvm]open fun setSerializers(p0: SimpleSerializers) setupModule [jvm]open override fun setupModule(context: Module.SetupContext?) setValueInstantiators [jvm]open fun setValueInstantiators(p0: SimpleValueInstantiators) version [jvm]open override fun version(): Version"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/-secret-jackson-module/","title":"SecretJacksonModule - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/SecretJacksonModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/-secret-jackson-module/#secretjacksonmodule","title":"SecretJacksonModule","text":"[jvm]\\ constructor(resourceLoader: ResourceLoader, mapper: ObjectMapper)
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/mapper/","title":"mapper - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/mapper
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/mapper/#mapper","title":"mapper","text":"[jvm]\\ val mapper: ObjectMapper
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/resource-loader/","title":"resourceLoader - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/resourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/setup-module/","title":"setupModule - Misk","text":"//misk-config/misk.config/MiskConfig/SecretJacksonModule/setupModule
"},{"location":"0.x/misk-config/misk-config/misk.config/-misk-config/-secret-jackson-module/setup-module/#setupmodule","title":"setupModule","text":"[jvm]\\ open override fun setupModule(context: Module.SetupContext?)
"},{"location":"0.x/misk-config/misk-config/misk.config/-redact/","title":"Redact - Misk","text":"//misk-config/misk.config/Redact
"},{"location":"0.x/misk-config/misk-config/misk.config/-redact/#redact","title":"Redact","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER])
annotation class Redact
Field or class will be redacted in dashboard output.
import misk.config.Redact\n\ndata class MyServiceConfig(\n val customConfig: CustomConfig,\n val secretConfig: SecretConfig\n)\n\ndata class CustomConfig(\n @Redact\n val secretSubconfig: Subconfig\n)\n\n@Redact\ndata class SecretConfig(\n val key: String\n)\n//misk-config/misk.config/Secret
"},{"location":"0.x/misk-config/misk-config/misk.config/-secret/#secret","title":"Secret","text":"interface Secret<T>
Type for any secrets that need to be loaded as reference in their config file. Secret addresses should use format specified in misk.resources.ResourceLoader.
Usage example:
data class SuperSecretConfig(\n val string_value: String,\n val secret_information: Secret<SecretInformationConfig>,\n) : Config\nWith
data class SecretInformationConfig(\n val answer_to_universe: String,\n val limit: Int\n) : Config\nWe would have the SuperSecretConfig yaml be:
string_value: \"this is not a secret\"\nsecret_information: \"classpath:/misk/resources/secret_information_values.yaml\"\nAnd the secret_information stored as:
answer_to_universe: 42\nlimit: 5\nLastly, this secret information would be accessed using:
superSecretConfig.secret_information.value.answer_to_universe\n//misk-config/misk.config/Secret/value
"},{"location":"0.x/misk-config/misk-config/misk.config/-secret/value/#value","title":"value","text":"[jvm]\\ abstract val value: T
"},{"location":"0.x/misk-config/misk-config/misk.resources/","title":"Package-level declarations - Misk","text":"//misk-config/misk.resources
"},{"location":"0.x/misk-config/misk-config/misk.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-config/misk-config/misk.resources/#types","title":"Types","text":"Name Summary FakeFilesModule [jvm]class FakeFilesModule(fakeFiles: Map<String, String>) : KAbstractModuleAdds the provided fake files to the map used by FilesystemLoaderBackend. ForFakeFiles [jvm]@Qualifierannotation class ForFakeFiles ResourceLoader [jvm]@Singletonclass ResourceLoader@Injectconstructor(backends: Map<String, ResourceLoader.Backend>)ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source. ResourceLoaderModule [jvm]class ResourceLoaderModule : KAbstractModule TestingResourceLoaderModule [jvm]class TestingResourceLoaderModule : KAbstractModuleCan be used instead of ResourceLoaderModule in tests to load filesystem: resources using FakeFilesystemLoaderBackend"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/","title":"FakeFilesModule - Misk","text":"//misk-config/misk.resources/FakeFilesModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/#fakefilesmodule","title":"FakeFilesModule","text":"[jvm]\\ class FakeFilesModule(fakeFiles: Map<String, String>) : KAbstractModule
Adds the provided fake files to the map used by FilesystemLoaderBackend.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/#constructors","title":"Constructors","text":"FakeFilesModule [jvm]constructor(fakeFiles: Map<String, String>)"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/-fake-files-module/","title":"FakeFilesModule - Misk","text":"//misk-config/misk.resources/FakeFilesModule/FakeFilesModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-fake-files-module/-fake-files-module/#fakefilesmodule","title":"FakeFilesModule","text":"[jvm]\\ constructor(fakeFiles: Map<String, String>)
"},{"location":"0.x/misk-config/misk-config/misk.resources/-for-fake-files/","title":"ForFakeFiles - Misk","text":"//misk-config/misk.resources/ForFakeFiles
"},{"location":"0.x/misk-config/misk-config/misk.resources/-for-fake-files/#forfakefiles","title":"ForFakeFiles","text":"[jvm]\\ @Qualifier
annotation class ForFakeFiles
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/","title":"ResourceLoader - Misk","text":"//misk-config/misk.resources/ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\ @Singleton
class ResourceLoader@Injectconstructor(backends: Map<String, ResourceLoader.Backend>)
ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source.
Resource addresses have a scheme name, a colon, and an absolute filesystem-like path: classpath:/migrations/v1.sql. Schemes identify backends classpath: or memory:. Paths start with a slash and have any number of segments.
Classpath resources use the scheme classpath:. The backend reads data from the src/main/resources of the project\u2019s modules and the contents of all library .jar files. Classpath resources are read-only.
Filesystem resources use the scheme filesystem:. The backend reads data from the host machine\u2019s local filesystem. It is read-only and does not support list.
Memory resources use the scheme memory:. The backend starts empty and is populated by calls to put.
Other backends are permitted. They should be registered with a MapBinder with the backend scheme like classpath: as the key.
address exists. list [jvm]fun list(address: String): List<String>Returns the full path of the resources that are immediate children of address. open [jvm]fun open(address: String): BufferedSource?Return a buffered source for address, or null if no such resource exists. put [jvm]fun put(address: String, utf8: String)Writes a resource as UTF-8. Throws if the backend is readonly.[jvm]fun put(address: String, data: ByteString)Writes a resource. Throws if the backend is readonly. requireUtf8 [jvm]fun requireUtf8(address: String): StringLike utf8, but throws IllegalStateException if the resource is missing. utf8 [jvm]fun utf8(address: String): String?Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently. walk [jvm]fun walk(address: String): List<String>"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-resource-loader/","title":"ResourceLoader - Misk","text":"//misk-config/misk.resources/ResourceLoader/ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\
@Inject
constructor(backends: Map<String, ResourceLoader.Backend>)
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/copy-to/","title":"copyTo - Misk","text":"//misk-config/misk.resources/ResourceLoader/copyTo
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/copy-to/#copyto","title":"copyTo","text":"[jvm]\\ fun copyTo(root: String, dir: Path)
Copies all resources with root as a prefix to the directory dir.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/delegate/","title":"delegate - Misk","text":"//misk-config/misk.resources/ResourceLoader/delegate
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/exists/","title":"exists - Misk","text":"//misk-config/misk.resources/ResourceLoader/exists
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/exists/#exists","title":"exists","text":"[jvm]\\ fun exists(address: String): Boolean
Returns true if a resource at address exists.
//misk-config/misk.resources/ResourceLoader/list
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/list/#list","title":"list","text":"[jvm]\\ fun list(address: String): List<String>
Returns the full path of the resources that are immediate children of address.
//misk-config/misk.resources/ResourceLoader/open
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/open/#open","title":"open","text":"[jvm]\\ fun open(address: String): BufferedSource?
Return a buffered source for address, or null if no such resource exists.
//misk-config/misk.resources/ResourceLoader/put
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/put/#put","title":"put","text":"[jvm]\\ fun put(address: String, utf8: String)
Writes a resource as UTF-8. Throws if the backend is readonly.
[jvm]\\ fun put(address: String, data: ByteString)
Writes a resource. Throws if the backend is readonly.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/require-utf8/","title":"requireUtf8 - Misk","text":"//misk-config/misk.resources/ResourceLoader/requireUtf8
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/require-utf8/#requireutf8","title":"requireUtf8","text":"[jvm]\\ fun requireUtf8(address: String): String
Like utf8, but throws IllegalStateException if the resource is missing.
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/utf8/","title":"utf8 - Misk","text":"//misk-config/misk.resources/ResourceLoader/utf8
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/utf8/#utf8","title":"utf8","text":"[jvm]\\ fun utf8(address: String): String?
Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently.
//misk-config/misk.resources/ResourceLoader/walk
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/walk/#walk","title":"walk","text":"[jvm]\\ fun walk(address: String): List<String>
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/","title":"Companion - Misk","text":"//misk-config/misk.resources/ResourceLoader/Companion
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/#properties","title":"Properties","text":"Name Summary SYSTEM [jvm]val SYSTEM: ResourceLoader"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/-s-y-s-t-e-m/","title":"SYSTEM - Misk","text":"//misk-config/misk.resources/ResourceLoader/Companion/SYSTEM
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader/-companion/-s-y-s-t-e-m/#system","title":"SYSTEM","text":"[jvm]\\ val SYSTEM: ResourceLoader
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/","title":"ResourceLoaderModule - Misk","text":"//misk-config/misk.resources/ResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/#resourceloadermodule","title":"ResourceLoaderModule","text":"[jvm]\\ class ResourceLoaderModule : KAbstractModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/#constructors","title":"Constructors","text":"ResourceLoaderModule [jvm]constructor()"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/-resource-loader-module/","title":"ResourceLoaderModule - Misk","text":"//misk-config/misk.resources/ResourceLoaderModule/ResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-resource-loader-module/-resource-loader-module/#resourceloadermodule","title":"ResourceLoaderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/","title":"TestingResourceLoaderModule - Misk","text":"//misk-config/misk.resources/TestingResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/#testingresourceloadermodule","title":"TestingResourceLoaderModule","text":"[jvm]\\ class TestingResourceLoaderModule : KAbstractModule
Can be used instead of ResourceLoaderModule in tests to load filesystem: resources using FakeFilesystemLoaderBackend
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/#constructors","title":"Constructors","text":"TestingResourceLoaderModule [jvm]constructor()"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/-testing-resource-loader-module/","title":"TestingResourceLoaderModule - Misk","text":"//misk-config/misk.resources/TestingResourceLoaderModule/TestingResourceLoaderModule
"},{"location":"0.x/misk-config/misk-config/misk.resources/-testing-resource-loader-module/-testing-resource-loader-module/#testingresourceloadermodule","title":"TestingResourceLoaderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/","title":"Package-level declarations - Misk","text":"//misk-config/misk.web.metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-config/misk-config/misk.web.metadata/#types","title":"Types","text":"Name Summary Metadata [jvm]open class Metadata@JvmOverloadsconstructor(val metadata: Any, val prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), val descriptionString: String = \"\") MetadataModule [jvm]class MetadataModule<T : Metadata>(provider: MetadataProvider<T>) : KAbstractModuleInstalls a new Metadata type with associated provider to expose in AllMetadataAction. MetadataProvider [jvm]interface MetadataProvider<T : Metadata> : Provider<T>"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/#functions","title":"Functions","text":"Name Summary toFormattedJson [jvm]fun <T> JsonAdapter<T>.toFormattedJson(value: T): String"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/to-formatted-json/","title":"toFormattedJson - Misk","text":"//misk-config/misk.web.metadata/toFormattedJson
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/to-formatted-json/#toformattedjson","title":"toFormattedJson","text":"[jvm]\\ fun <T> JsonAdapter<T>.toFormattedJson(value: T): String
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/","title":"Metadata - Misk","text":"//misk-config/misk.web.metadata/Metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#metadata","title":"Metadata","text":"[jvm]\\ open class Metadata@JvmOverloadsconstructor(val metadata: Any, val prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), val descriptionString: String = \"\")
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#constructors","title":"Constructors","text":"Metadata [jvm]@JvmOverloadsconstructor(metadata: Any, prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), descriptionString: String = \"\")"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#properties","title":"Properties","text":"Name Summary descriptionString [jvm]val descriptionString: StringDescription of what the metadata covers or administrator instructions. metadata [jvm]val metadata: AnyMetadata object, should be a data class for easy built-in serialization to JSON. prettyPrint [jvm]val prettyPrint: StringPretty Print representation of the metadata used in the admin dashboard. Most metadata should create a Moshi JSON adapter and use toFormattedJson to do this."},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/#functions","title":"Functions","text":"Name Summary contentBlock [jvm]open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>HTML block for the content. Can be overridden to show more complex UI than the default prettyPrint console output. descriptionBlock [jvm]open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>HTML block for description. Can be overridden to show more complex UI or documentation."},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/-metadata/","title":"Metadata - Misk","text":"//misk-config/misk.web.metadata/Metadata/Metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/-metadata/#metadata","title":"Metadata","text":"[jvm]\\
@JvmOverloads
constructor(metadata: Any, prettyPrint: String = metadata.toString() // Improves readability of default data class toString() for admin dashboard if JSON or custom prettyPrint isn\u2019t provided .split(\"),\").joinToString(\"), \") .split(\",\").joinToString(\", \"), descriptionString: String = \"\")
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/content-block/","title":"contentBlock - Misk","text":"//misk-config/misk.web.metadata/Metadata/contentBlock
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/content-block/#contentblock","title":"contentBlock","text":"[jvm]\\ open fun contentBlock(tagConsumer: TagConsumer<>): TagConsumer<>
HTML block for the content. Can be overridden to show more complex UI than the default prettyPrint console output.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-block/","title":"descriptionBlock - Misk","text":"//misk-config/misk.web.metadata/Metadata/descriptionBlock
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-block/#descriptionblock","title":"descriptionBlock","text":"[jvm]\\ open fun descriptionBlock(tagConsumer: TagConsumer<>): TagConsumer<>
HTML block for description. Can be overridden to show more complex UI or documentation.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-string/","title":"descriptionString - Misk","text":"//misk-config/misk.web.metadata/Metadata/descriptionString
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/description-string/#descriptionstring","title":"descriptionString","text":"[jvm]\\ val descriptionString: String
Description of what the metadata covers or administrator instructions.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/metadata/","title":"metadata - Misk","text":"//misk-config/misk.web.metadata/Metadata/metadata
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/metadata/#metadata","title":"metadata","text":"[jvm]\\ val metadata: Any
Metadata object, should be a data class for easy built-in serialization to JSON.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/pretty-print/","title":"prettyPrint - Misk","text":"//misk-config/misk.web.metadata/Metadata/prettyPrint
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata/pretty-print/#prettyprint","title":"prettyPrint","text":"[jvm]\\ val prettyPrint: String
Pretty Print representation of the metadata used in the admin dashboard. Most metadata should create a Moshi JSON adapter and use toFormattedJson to do this.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/","title":"MetadataModule - Misk","text":"//misk-config/misk.web.metadata/MetadataModule
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/#metadatamodule","title":"MetadataModule","text":"[jvm]\\ class MetadataModule<T : Metadata>(provider: MetadataProvider<T>) : KAbstractModule
Installs a new Metadata type with associated provider to expose in AllMetadataAction.
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/#constructors","title":"Constructors","text":"MetadataModule [jvm]constructor(provider: MetadataProvider<T>)"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/-metadata-module/","title":"MetadataModule - Misk","text":"//misk-config/misk.web.metadata/MetadataModule/MetadataModule
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-module/-metadata-module/#metadatamodule","title":"MetadataModule","text":"[jvm]\\ constructor(provider: MetadataProvider<T>)
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/","title":"MetadataProvider - Misk","text":"//misk-config/misk.web.metadata/MetadataProvider
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/#metadataprovider","title":"MetadataProvider","text":"[jvm]\\ interface MetadataProvider<T : Metadata> : Provider<T>
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: StringUnique identifier for the type of metadata. Ie. \"web-actions\" or \"config\"."},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/#functions","title":"Functions","text":"Name Summary get [jvm]abstract override fun get(): T"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/id/","title":"id - Misk","text":"//misk-config/misk.web.metadata/MetadataProvider/id
"},{"location":"0.x/misk-config/misk-config/misk.web.metadata/-metadata-provider/id/#id","title":"id","text":"[jvm]\\ abstract val id: String
Unique identifier for the type of metadata. Ie. \"web-actions\" or \"config\".
"},{"location":"0.x/misk-core/","title":"misk-core - Misk","text":"//misk-core
"},{"location":"0.x/misk-core/#misk-core","title":"misk-core","text":""},{"location":"0.x/misk-core/#packages","title":"Packages","text":"Name misk.backoff misk.concurrent misk.config misk.healthchecks misk.logging misk.random misk.retries misk.sampling misk.security.ssl misk.tokens misk.web.mediatype"},{"location":"0.x/misk-core/misk-core/misk.backoff/","title":"Package-level declarations - Misk","text":"//misk-core/misk.backoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.backoff/#types","title":"Types","text":"Name Summary Backoff [jvm]interface BackoffCalculates how long to backoff on a retry. Backoffs are stateful and not thread-safe DontRetryException [jvm]class DontRetryException : Exception ExponentialBackoff [jvm]open class ExponentialBackoff@JvmOverloadsconstructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() }) : BackoffPerforms exponential backoff with optional jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags) FlatBackoff [jvm]class FlatBackoff@JvmOverloadsconstructor(val duration: Duration = Duration.ofMillis(0)) : Backoff FullJitterBackoff [jvm]class FullJitterBackoff(baseDelay: () -> Duration, maxDelay: () -> Duration) : ExponentialBackoffPerforms exponential backoff with 100% jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags)"},{"location":"0.x/misk-core/misk-core/misk.backoff/#functions","title":"Functions","text":"Name Summary retry [jvm]@JvmOverloadsfun <A> retry(upTo: Int, withBackoff: Backoff, onRetry: (retryCount: Int, Exception) -> Unit? = null, block: (retryCount: Int) -> A): ARetries the provided function up to a certain number of times, applying the given backoff between each retry. If provided, the onRetry callback is called when a retry happens, allowing clients to perform a task (log, emit metrics) every time a retry occurs. The retry function is provided with current retry count, in case this is relevant."},{"location":"0.x/misk-core/misk-core/misk.backoff/retry/","title":"retry - Misk","text":"//misk-core/misk.backoff/retry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/retry/#retry","title":"retry","text":"[jvm]\\
@JvmOverloads
fun <A> retry(upTo: Int, withBackoff: Backoff, onRetry: (retryCount: Int, Exception) -> Unit? = null, block: (retryCount: Int) -> A): A
Retries the provided function up to a certain number of times, applying the given backoff between each retry. If provided, the onRetry callback is called when a retry happens, allowing clients to perform a task (log, emit metrics) every time a retry occurs. The retry function is provided with current retry count, in case this is relevant.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/","title":"Backoff - Misk","text":"//misk-core/misk.backoff/Backoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/#backoff","title":"Backoff","text":"interface Backoff
Calculates how long to backoff on a retry. Backoffs are stateful and not thread-safe
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/#inheritors","title":"Inheritors","text":"ExponentialBackoff FlatBackoff"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]abstract fun nextRetry(): Duration reset [jvm]abstract fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/next-retry/","title":"nextRetry - Misk","text":"//misk-core/misk.backoff/Backoff/nextRetry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/next-retry/#nextretry","title":"nextRetry","text":"[jvm]\\ abstract fun nextRetry(): Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/next-retry/#return","title":"Return","text":"Determines the amount of time to wait before the next retry.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/reset/","title":"reset - Misk","text":"//misk-core/misk.backoff/Backoff/reset
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-backoff/reset/#reset","title":"reset","text":"[jvm]\\ abstract fun reset()
Resets the backoff, typically when a request has succeeded
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/","title":"DontRetryException - Misk","text":"//misk-core/misk.backoff/DontRetryException
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#dontretryexception","title":"DontRetryException","text":"[jvm]\\ class DontRetryException : Exception
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#constructors","title":"Constructors","text":"DontRetryException [jvm]constructor(message: String? = null)constructor(cause: Exception?)constructor(message: String?, cause: Exception?)"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/-dont-retry-exception/","title":"DontRetryException - Misk","text":"//misk-core/misk.backoff/DontRetryException/DontRetryException
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-dont-retry-exception/-dont-retry-exception/#dontretryexception","title":"DontRetryException","text":"[jvm]\\ constructor(message: String? = null)
constructor(cause: Exception?)
constructor(message: String?, cause: Exception?)
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/","title":"ExponentialBackoff - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#exponentialbackoff","title":"ExponentialBackoff","text":"open class ExponentialBackoff@JvmOverloadsconstructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() }) : Backoff
Performs exponential backoff with optional jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags)
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#inheritors","title":"Inheritors","text":"FullJitterBackoff"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#constructors","title":"Constructors","text":"ExponentialBackoff [jvm]constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)Creates a new unjittered ExponentialBackoff using a function for the base and max retry delays.constructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitterFromNextDelay: (Long) -> Duration)Creates a new jittered ExponentialBackoff using a function for the base and max retry delays, and a function for the jitter amount.constructor(baseDelay: Duration, maxDelay: Duration, jitterFromNextDelay: (Long) -> Duration)Creates a new jittered ExponentialBackoff from fixed delays and jitter amounts and a function for the jitter.constructor(baseDelay: Duration, maxDelay: Duration, jitter: Duration)Creates a new ExponentialBackoff from fixed delays and jitter amountsconstructor(baseDelay: Duration, maxDelay: Duration)Creates a new ExponentialBackoff from fixed delays, without jitter@JvmOverloadsconstructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() })"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]open override fun nextRetry(): Duration reset [jvm]open override fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/","title":"ExponentialBackoff - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff/ExponentialBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#exponentialbackoff","title":"ExponentialBackoff","text":"[jvm]\\ constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)
Creates a new unjittered ExponentialBackoff using a function for the base and max retry delays.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters","title":"Parameters","text":"jvm
baseDelay The Supplier for the base delay maxDelay The Supplier for maximum amount of time to wait between retries[jvm]\\ constructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitterFromNextDelay: (Long) -> Duration)
Creates a new jittered ExponentialBackoff using a function for the base and max retry delays, and a function for the jitter amount.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_1","title":"Parameters","text":"jvm
baseDelay The Supplier for the base delay maxDelay The Supplier for maximum amount of time to wait between retries jitterFromNextDelay The Supplier for maximum amount of time to wait between retries[jvm]\\ constructor(baseDelay: Duration, maxDelay: Duration, jitterFromNextDelay: (Long) -> Duration)
Creates a new jittered ExponentialBackoff from fixed delays and jitter amounts and a function for the jitter.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_2","title":"Parameters","text":"jvm
baseDelay The base retry delay maxDelay The max amount of time to delay jitterFromNextDelay The Supplier for maximum amount of time to wait between retries[jvm]\\ constructor(baseDelay: Duration, maxDelay: Duration, jitter: Duration)
Creates a new ExponentialBackoff from fixed delays and jitter amounts
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_3","title":"Parameters","text":"jvm
baseDelay The base retry delay maxDelay The max amount of time to delay jitter The amount of jitter to introduce[jvm]\\ constructor(baseDelay: Duration, maxDelay: Duration)
Creates a new ExponentialBackoff from fixed delays, without jitter
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/-exponential-backoff/#parameters_4","title":"Parameters","text":"jvm
baseDelay The base retry delay maxDelay The max amount of time to delay[jvm]\\
@JvmOverloads
constructor(baseDelay: () -> Duration, maxDelay: () -> Duration, jitter: () -> Duration, jitterFromNextDelay: (Long) -> Duration = { jitter() })
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/next-retry/","title":"nextRetry - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff/nextRetry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/next-retry/#nextretry","title":"nextRetry","text":"[jvm]\\ open override fun nextRetry(): Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/next-retry/#return","title":"Return","text":"Determines the amount of time to wait before the next retry.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/reset/","title":"reset - Misk","text":"//misk-core/misk.backoff/ExponentialBackoff/reset
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-exponential-backoff/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
Resets the backoff, typically when a request has succeeded
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/","title":"FlatBackoff - Misk","text":"//misk-core/misk.backoff/FlatBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#flatbackoff","title":"FlatBackoff","text":"[jvm]\\ class FlatBackoff@JvmOverloadsconstructor(val duration: Duration = Duration.ofMillis(0)) : Backoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#constructors","title":"Constructors","text":"FlatBackoff [jvm]@JvmOverloadsconstructor(duration: Duration = Duration.ofMillis(0))"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#properties","title":"Properties","text":"Name Summary duration [jvm]val duration: Duration"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]open override fun nextRetry(): Duration reset [jvm]open override fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/-flat-backoff/","title":"FlatBackoff - Misk","text":"//misk-core/misk.backoff/FlatBackoff/FlatBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/-flat-backoff/#flatbackoff","title":"FlatBackoff","text":"[jvm]\\
@JvmOverloads
constructor(duration: Duration = Duration.ofMillis(0))
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/duration/","title":"duration - Misk","text":"//misk-core/misk.backoff/FlatBackoff/duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/duration/#duration","title":"duration","text":"[jvm]\\ val duration: Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/next-retry/","title":"nextRetry - Misk","text":"//misk-core/misk.backoff/FlatBackoff/nextRetry
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/next-retry/#nextretry","title":"nextRetry","text":"[jvm]\\ open override fun nextRetry(): Duration
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/next-retry/#return","title":"Return","text":"Determines the amount of time to wait before the next retry.
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/reset/","title":"reset - Misk","text":"//misk-core/misk.backoff/FlatBackoff/reset
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-flat-backoff/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
Resets the backoff, typically when a request has succeeded
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/","title":"FullJitterBackoff - Misk","text":"//misk-core/misk.backoff/FullJitterBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/#fulljitterbackoff","title":"FullJitterBackoff","text":"[jvm]\\ class FullJitterBackoff(baseDelay: () -> Duration, maxDelay: () -> Duration) : ExponentialBackoff
Performs exponential backoff with 100% jitter. Durations are supplied as functions, so that they can change dynamically as the system is running (e.g. in response to changes in dynamic flags)
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/#constructors","title":"Constructors","text":"FullJitterBackoff [jvm]constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/#functions","title":"Functions","text":"Name Summary nextRetry [jvm]open override fun nextRetry(): Duration reset [jvm]open override fun reset()Resets the backoff, typically when a request has succeeded"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/-full-jitter-backoff/","title":"FullJitterBackoff - Misk","text":"//misk-core/misk.backoff/FullJitterBackoff/FullJitterBackoff
"},{"location":"0.x/misk-core/misk-core/misk.backoff/-full-jitter-backoff/-full-jitter-backoff/#fulljitterbackoff","title":"FullJitterBackoff","text":"[jvm]\\ constructor(baseDelay: () -> Duration, maxDelay: () -> Duration)
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk-core/misk.concurrent
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.concurrent/#types","title":"Types","text":"Name Summary ExecutorServiceFactory [jvm]interface ExecutorServiceFactoryInject this rather than using the Executors factory class to create thread pools. Executors created with this factory will automatically be shut down when the service or test completes. Sleeper [jvm]interface SleeperAbstraction for Thread.sleep() that allows for testing."},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/","title":"ExecutorServiceFactory - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/#executorservicefactory","title":"ExecutorServiceFactory","text":"[jvm]\\ interface ExecutorServiceFactory
Inject this rather than using the Executors factory class to create thread pools. Executors created with this factory will automatically be shut down when the service or test completes.
For all functions, nameFormat a string in the format specified by ThreadFactoryBuilder.setNameFormat, like \"rpc-pool-%d\". If the string has a single %d placeholder it will be assigned sequentially. Omit the placeholder if only one thread will be required.
//misk-core/misk.concurrent/ExecutorServiceFactory/fixed
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/fixed/#fixed","title":"fixed","text":"[jvm]\\ abstract fun fixed(nameFormat: String, threadCount: Int): ExecutorService
Returns an executor service that uses Executors.newFixedThreadPool.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/scheduled/","title":"scheduled - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory/scheduled
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/scheduled/#scheduled","title":"scheduled","text":"[jvm]\\ abstract fun scheduled(nameFormat: String, threadCount: Int): ScheduledExecutorService
Returns an executor service that uses Executors.newScheduledThreadPool.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/single/","title":"single - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory/single
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/single/#single","title":"single","text":"[jvm]\\ abstract fun single(nameFormat: String): ExecutorService
Returns an executor service that uses Executors.newSingleThreadExecutor.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/unbounded/","title":"unbounded - Misk","text":"//misk-core/misk.concurrent/ExecutorServiceFactory/unbounded
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-executor-service-factory/unbounded/#unbounded","title":"unbounded","text":"[jvm]\\ abstract fun unbounded(nameFormat: String): ExecutorService
Returns an executor service that uses Executors.newCachedThreadPool.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/","title":"Sleeper - Misk","text":"//misk-core/misk.concurrent/Sleeper
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/#sleeper","title":"Sleeper","text":"[jvm]\\ interface Sleeper
Abstraction for Thread.sleep() that allows for testing.
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/#functions","title":"Functions","text":"Name Summary sleep [jvm]abstract fun sleep(duration: Duration)"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/sleep/","title":"sleep - Misk","text":"//misk-core/misk.concurrent/Sleeper/sleep
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/sleep/#sleep","title":"sleep","text":"[jvm]\\ abstract fun sleep(duration: Duration)
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/","title":"Companion - Misk","text":"//misk-core/misk.concurrent/Sleeper/Companion
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT [jvm]val DEFAULT: Sleeper"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/-d-e-f-a-u-l-t/","title":"DEFAULT - Misk","text":"//misk-core/misk.concurrent/Sleeper/Companion/DEFAULT
"},{"location":"0.x/misk-core/misk-core/misk.concurrent/-sleeper/-companion/-d-e-f-a-u-l-t/#default","title":"DEFAULT","text":"[jvm]\\ val DEFAULT: Sleeper
"},{"location":"0.x/misk-core/misk-core/misk.config/","title":"Package-level declarations - Misk","text":"//misk-core/misk.config
"},{"location":"0.x/misk-core/misk-core/misk.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.config/#types","title":"Types","text":"Name Summary Config [jvm]interface Config : Config"},{"location":"0.x/misk-core/misk-core/misk.config/-config/","title":"Config - Misk","text":"//misk-core/misk.config/Config
"},{"location":"0.x/misk-core/misk-core/misk.config/-config/#config","title":"Config","text":"[jvm]\\ interface Config : Config
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/","title":"Package-level declarations - Misk","text":"//misk-core/misk.healthchecks
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.healthchecks/#types","title":"Types","text":"Name Summary HealthCheck [jvm]interface HealthCheckAllows users to define custom health checks. An app with a failing HealthCheck will fail the readiness check inReadinessCheckAction, indicating that the app should not accept traffic. HealthStatus [jvm]data class HealthStatus(val isHealthy: Boolean, val messages: List<String>)"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-check/","title":"HealthCheck - Misk","text":"//misk-core/misk.healthchecks/HealthCheck
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-check/#healthcheck","title":"HealthCheck","text":"[jvm]\\ interface HealthCheck
Allows users to define custom health checks. An app with a failing HealthCheck will fail the readiness check in ReadinessCheckAction, indicating that the app should not accept traffic.
//misk-core/misk.healthchecks/HealthCheck/status
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-check/status/#status","title":"status","text":"[jvm]\\ abstract fun status(): HealthStatus
Computes whether a component of an application is healthy. For example, an implementing class can check database connectivity.
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/","title":"HealthStatus - Misk","text":"//misk-core/misk.healthchecks/HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#healthstatus","title":"HealthStatus","text":"[jvm]\\ data class HealthStatus(val isHealthy: Boolean, val messages: List<String>)
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#constructors","title":"Constructors","text":"HealthStatus [jvm]constructor(isHealthy: Boolean, messages: List<String>)"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/#properties","title":"Properties","text":"Name Summary isHealthy [jvm]val isHealthy: Boolean messages [jvm]val messages: List<String>"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-health-status/","title":"HealthStatus - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-health-status/#healthstatus","title":"HealthStatus","text":"[jvm]\\ constructor(isHealthy: Boolean, messages: List<String>)
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/is-healthy/","title":"isHealthy - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/isHealthy
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/is-healthy/#ishealthy","title":"isHealthy","text":"[jvm]\\ val isHealthy: Boolean
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/messages/","title":"messages - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/messages
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/messages/#messages","title":"messages","text":"[jvm]\\ val messages: List<String>
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/","title":"Companion - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/Companion
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/#functions","title":"Functions","text":"Name Summary healthy [jvm]fun healthy(vararg messages: String): HealthStatus unhealthy [jvm]fun unhealthy(vararg messages: String): HealthStatus"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/healthy/","title":"healthy - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/Companion/healthy
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/healthy/#healthy","title":"healthy","text":"[jvm]\\ fun healthy(vararg messages: String): HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/unhealthy/","title":"unhealthy - Misk","text":"//misk-core/misk.healthchecks/HealthStatus/Companion/unhealthy
"},{"location":"0.x/misk-core/misk-core/misk.healthchecks/-health-status/-companion/unhealthy/#unhealthy","title":"unhealthy","text":"[jvm]\\ fun unhealthy(vararg messages: String): HealthStatus
"},{"location":"0.x/misk-core/misk-core/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-core/misk.logging
"},{"location":"0.x/misk-core/misk-core/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.logging/#types","title":"Types","text":"Name Summary SampledLogger [jvm]class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger"},{"location":"0.x/misk-core/misk-core/misk.logging/#functions","title":"Functions","text":"Name Summary sampled [jvm]fun KLogger.sampled(sampler: Sampler): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton."},{"location":"0.x/misk-core/misk-core/misk.logging/sampled/","title":"sampled - Misk","text":"//misk-core/misk.logging/sampled
"},{"location":"0.x/misk-core/misk-core/misk.logging/sampled/#sampled","title":"sampled","text":"[jvm]\\ fun KLogger.sampled(sampler: Sampler): KLogger
Returns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton.
To get a rate limited logger:
val logger = getLogger().sampled(RateLimitingSampler(RATE_PER_SECOND))
To get a probabilistic sampler
val logger = getLogger().sampled(PercentSampler(PERCENTAGE_TO_ALLOW))"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/","title":"SampledLogger - Misk","text":"
//misk-core/misk.logging/SampledLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#constructors","title":"Constructors","text":"SampledLogger [jvm]constructor(underlyingLogger: KLogger, sampler: Sampler)"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#properties","title":"Properties","text":"Name Summary underlyingLogger [jvm]open override val underlyingLogger: KLogger"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/#functions","title":"Functions","text":"Name Summary atDebug [jvm]@CheckReturnValueopen fun atDebug(): LoggingEventBuilder atError [jvm]@CheckReturnValueopen fun atError(): LoggingEventBuilder atInfo [jvm]@CheckReturnValueopen fun atInfo(): LoggingEventBuilder atLevel [jvm]@CheckReturnValueopen fun atLevel(p0: Level): LoggingEventBuilder atTrace [jvm]@CheckReturnValueopen fun atTrace(): LoggingEventBuilder atWarn [jvm]@CheckReturnValueopen fun atWarn(): LoggingEventBuilder catching [jvm]open override fun <T : Throwable> catching(throwable: T) debug [jvm]open override fun debug(msg: () -> Any?)open override fun debug(msg: String?)open override fun debug(format: String?, arg: Any?)open override fun debug(format: String?, vararg arguments: Any?)open override fun debug(msg: String?, t: Throwable?)open override fun debug(t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: String?)open override fun debug(format: String?, arg1: Any?, arg2: Any?)open override fun debug(marker: Marker?, format: String?, arg: Any?)open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)open override fun debug(marker: Marker?, msg: String?, t: Throwable?)open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) entry [jvm]open override fun entry(vararg argArray: Any?) error [jvm]open override fun error(msg: () -> Any?)open override fun error(msg: String?)open override fun error(format: String?, arg: Any?)open override fun error(format: String?, vararg arguments: Any?)open override fun error(msg: String?, t: Throwable?)open override fun error(t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, msg: () -> Any?)open override fun error(marker: Marker?, msg: String?)open override fun error(format: String?, arg1: Any?, arg2: Any?)open override fun error(marker: Marker?, format: String?, arg: Any?)open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)open override fun error(marker: Marker?, msg: String?, t: Throwable?)open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) exit [jvm]open override fun exit()open override fun <T> exit(result: T): T getName [jvm]open override fun getName(): String info [jvm]open override fun info(msg: () -> Any?)open override fun info(msg: String?)open override fun info(format: String?, arg: Any?)open override fun info(format: String?, vararg arguments: Any?)open override fun info(msg: String?, t: Throwable?)open override fun info(t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, msg: () -> Any?)open override fun info(marker: Marker?, msg: String?)open override fun info(format: String?, arg1: Any?, arg2: Any?)open override fun info(marker: Marker?, format: String?, arg: Any?)open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)open override fun info(marker: Marker?, msg: String?, t: Throwable?)open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) isDebugEnabled [jvm]open override fun isDebugEnabled(): Booleanopen override fun isDebugEnabled(marker: Marker?): Boolean isEnabledForLevel [jvm]open fun isEnabledForLevel(p0: Level): Boolean isErrorEnabled [jvm]open override fun isErrorEnabled(): Booleanopen override fun isErrorEnabled(marker: Marker?): Boolean isInfoEnabled [jvm]open override fun isInfoEnabled(): Booleanopen override fun isInfoEnabled(marker: Marker?): Boolean isTraceEnabled [jvm]open override fun isTraceEnabled(): Booleanopen override fun isTraceEnabled(marker: Marker?): Boolean isWarnEnabled [jvm]open override fun isWarnEnabled(): Booleanopen override fun isWarnEnabled(marker: Marker?): Boolean makeLoggingEventBuilder [jvm]open fun makeLoggingEventBuilder(p0: Level): LoggingEventBuilder sampled [jvm]fun KLogger.sampled(sampler: Sampler): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton. throwing [jvm]open override fun <T : Throwable> throwing(throwable: T): T trace [jvm]open override fun trace(msg: () -> Any?)open override fun trace(msg: String?)open override fun trace(format: String?, arg: Any?)open override fun trace(format: String?, vararg arguments: Any?)open override fun trace(msg: String?, t: Throwable?)open override fun trace(t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: String?)open override fun trace(format: String?, arg1: Any?, arg2: Any?)open override fun trace(marker: Marker?, format: String?, arg: Any?)open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)open override fun trace(marker: Marker?, msg: String?, t: Throwable?)open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) warn [jvm]open override fun warn(msg: () -> Any?)open override fun warn(msg: String?)open override fun warn(format: String?, arg: Any?)open override fun warn(format: String?, vararg arguments: Any?)open override fun warn(msg: String?, t: Throwable?)open override fun warn(t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: String?)open override fun warn(format: String?, arg1: Any?, arg2: Any?)open override fun warn(marker: Marker?, format: String?, arg: Any?)open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)open override fun warn(marker: Marker?, msg: String?, t: Throwable?)open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/-sampled-logger/","title":"SampledLogger - Misk","text":"//misk-core/misk.logging/SampledLogger/SampledLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ constructor(underlyingLogger: KLogger, sampler: Sampler)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/catching/","title":"catching - Misk","text":"//misk-core/misk.logging/SampledLogger/catching
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/catching/#catching","title":"catching","text":"[jvm]\\ open override fun <T : Throwable> catching(throwable: T)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/debug/","title":"debug - Misk","text":"//misk-core/misk.logging/SampledLogger/debug
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/debug/#debug","title":"debug","text":"[jvm]\\ open override fun debug(msg: () -> Any?)
open override fun debug(t: Throwable?, msg: () -> Any?)
open override fun debug(marker: Marker?, msg: () -> Any?)
open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun debug(msg: String?)
open override fun debug(format: String?, arg: Any?)
open override fun debug(format: String?, arg1: Any?, arg2: Any?)
open override fun debug(format: String?, vararg arguments: Any?)
open override fun debug(msg: String?, t: Throwable?)
open override fun debug(marker: Marker?, msg: String?)
open override fun debug(marker: Marker?, format: String?, arg: Any?)
open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun debug(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/entry/","title":"entry - Misk","text":"//misk-core/misk.logging/SampledLogger/entry
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/entry/#entry","title":"entry","text":"[jvm]\\ open override fun entry(vararg argArray: Any?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/error/","title":"error - Misk","text":"//misk-core/misk.logging/SampledLogger/error
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/error/#error","title":"error","text":"[jvm]\\ open override fun error(msg: () -> Any?)
open override fun error(t: Throwable?, msg: () -> Any?)
open override fun error(marker: Marker?, msg: () -> Any?)
open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun error(msg: String?)
open override fun error(format: String?, arg: Any?)
open override fun error(format: String?, arg1: Any?, arg2: Any?)
open override fun error(format: String?, vararg arguments: Any?)
open override fun error(msg: String?, t: Throwable?)
open override fun error(marker: Marker?, msg: String?)
open override fun error(marker: Marker?, format: String?, arg: Any?)
open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun error(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/exit/","title":"exit - Misk","text":"//misk-core/misk.logging/SampledLogger/exit
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/exit/#exit","title":"exit","text":"[jvm]\\ open override fun exit()
open override fun <T> exit(result: T): T
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/get-name/","title":"getName - Misk","text":"//misk-core/misk.logging/SampledLogger/getName
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/get-name/#getname","title":"getName","text":"[jvm]\\ open override fun getName(): String
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/info/","title":"info - Misk","text":"//misk-core/misk.logging/SampledLogger/info
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/info/#info","title":"info","text":"[jvm]\\ open override fun info(msg: () -> Any?)
open override fun info(t: Throwable?, msg: () -> Any?)
open override fun info(marker: Marker?, msg: () -> Any?)
open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun info(msg: String?)
open override fun info(format: String?, arg: Any?)
open override fun info(format: String?, arg1: Any?, arg2: Any?)
open override fun info(format: String?, vararg arguments: Any?)
open override fun info(msg: String?, t: Throwable?)
open override fun info(marker: Marker?, msg: String?)
open override fun info(marker: Marker?, format: String?, arg: Any?)
open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun info(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-debug-enabled/","title":"isDebugEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isDebugEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-debug-enabled/#isdebugenabled","title":"isDebugEnabled","text":"[jvm]\\ open override fun isDebugEnabled(): Boolean
open override fun isDebugEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-error-enabled/","title":"isErrorEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isErrorEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-error-enabled/#iserrorenabled","title":"isErrorEnabled","text":"[jvm]\\ open override fun isErrorEnabled(): Boolean
open override fun isErrorEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-info-enabled/","title":"isInfoEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isInfoEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-info-enabled/#isinfoenabled","title":"isInfoEnabled","text":"[jvm]\\ open override fun isInfoEnabled(): Boolean
open override fun isInfoEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-trace-enabled/","title":"isTraceEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isTraceEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-trace-enabled/#istraceenabled","title":"isTraceEnabled","text":"[jvm]\\ open override fun isTraceEnabled(): Boolean
open override fun isTraceEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-warn-enabled/","title":"isWarnEnabled - Misk","text":"//misk-core/misk.logging/SampledLogger/isWarnEnabled
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/is-warn-enabled/#iswarnenabled","title":"isWarnEnabled","text":"[jvm]\\ open override fun isWarnEnabled(): Boolean
open override fun isWarnEnabled(marker: Marker?): Boolean
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/throwing/","title":"throwing - Misk","text":"//misk-core/misk.logging/SampledLogger/throwing
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/throwing/#throwing","title":"throwing","text":"[jvm]\\ open override fun <T : Throwable> throwing(throwable: T): T
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/trace/","title":"trace - Misk","text":"//misk-core/misk.logging/SampledLogger/trace
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/trace/#trace","title":"trace","text":"[jvm]\\ open override fun trace(msg: () -> Any?)
open override fun trace(t: Throwable?, msg: () -> Any?)
open override fun trace(marker: Marker?, msg: () -> Any?)
open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun trace(msg: String?)
open override fun trace(format: String?, arg: Any?)
open override fun trace(format: String?, arg1: Any?, arg2: Any?)
open override fun trace(format: String?, vararg arguments: Any?)
open override fun trace(msg: String?, t: Throwable?)
open override fun trace(marker: Marker?, msg: String?)
open override fun trace(marker: Marker?, format: String?, arg: Any?)
open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)
open override fun trace(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/underlying-logger/","title":"underlyingLogger - Misk","text":"//misk-core/misk.logging/SampledLogger/underlyingLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/underlying-logger/#underlyinglogger","title":"underlyingLogger","text":"[jvm]\\ open override val underlyingLogger: KLogger
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/warn/","title":"warn - Misk","text":"//misk-core/misk.logging/SampledLogger/warn
"},{"location":"0.x/misk-core/misk-core/misk.logging/-sampled-logger/warn/#warn","title":"warn","text":"[jvm]\\ open override fun warn(msg: () -> Any?)
open override fun warn(t: Throwable?, msg: () -> Any?)
open override fun warn(marker: Marker?, msg: () -> Any?)
open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun warn(msg: String?)
open override fun warn(format: String?, arg: Any?)
open override fun warn(format: String?, vararg arguments: Any?)
open override fun warn(format: String?, arg1: Any?, arg2: Any?)
open override fun warn(msg: String?, t: Throwable?)
open override fun warn(marker: Marker?, msg: String?)
open override fun warn(marker: Marker?, format: String?, arg: Any?)
open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun warn(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/misk-core/misk-core/misk.random/","title":"Package-level declarations - Misk","text":"//misk-core/misk.random
"},{"location":"0.x/misk-core/misk-core/misk.random/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.random/#types","title":"Types","text":"Name Summary Random [jvm]@Singletonopen class Random@Injectconstructor : RandomAbstraction for Java\u2019s Random that allows for testing. ThreadLocalRandom [jvm]@Singletonopen class ThreadLocalRandom@InjectconstructorAbstraction for Java\u2019s ThreadLocalRandom that allows for testing."},{"location":"0.x/misk-core/misk-core/misk.random/-random/","title":"Random - Misk","text":"//misk-core/misk.random/Random
"},{"location":"0.x/misk-core/misk-core/misk.random/-random/#random","title":"Random","text":"[jvm]\\ @Singleton
open class Random@Injectconstructor : Random
Abstraction for Java\u2019s Random that allows for testing.
"},{"location":"0.x/misk-core/misk-core/misk.random/-random/#constructors","title":"Constructors","text":"Random [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.random/-random/#functions","title":"Functions","text":"Name Summary doubles [jvm]open override fun doubles(): DoubleStreamopen override fun doubles(p0: Long): DoubleStreamopen override fun doubles(p0: Double, p1: Double): DoubleStreamopen override fun doubles(p0: Long, p1: Double, p2: Double): DoubleStream ints [jvm]open override fun ints(): IntStreamopen override fun ints(p0: Long): IntStreamopen override fun ints(p0: Int, p1: Int): IntStreamopen override fun ints(p0: Long, p1: Int, p2: Int): IntStream isDeprecated [jvm]open fun isDeprecated(): Boolean longs [jvm]open override fun longs(): LongStreamopen override fun longs(p0: Long): LongStreamopen override fun longs(p0: Long, p1: Long): LongStreamopen override fun longs(p0: Long, p1: Long, p2: Long): LongStream nextBoolean [jvm]open override fun nextBoolean(): Boolean nextBytes [jvm]open override fun nextBytes(p0: ByteArray) nextDouble [jvm]open override fun nextDouble(): Doubleopen fun nextDouble(p0: Double): Doubleopen fun nextDouble(p0: Double, p1: Double): Double nextExponential [jvm]open fun nextExponential(): Double nextFloat [jvm]open override fun nextFloat(): Floatopen fun nextFloat(p0: Float): Floatopen fun nextFloat(p0: Float, p1: Float): Float nextGaussian [jvm]open override fun nextGaussian(): Doubleopen fun nextGaussian(p0: Double, p1: Double): Double nextInt [jvm]open override fun nextInt(): Intopen override fun nextInt(p0: Int): Intopen fun nextInt(p0: Int, p1: Int): Int nextLong [jvm]open override fun nextLong(): Longopen fun nextLong(p0: Long): Longopen fun nextLong(p0: Long, p1: Long): Long setSeed [jvm]open fun setSeed(p0: Long)"},{"location":"0.x/misk-core/misk-core/misk.random/-random/-random/","title":"Random - Misk","text":"//misk-core/misk.random/Random/Random
"},{"location":"0.x/misk-core/misk-core/misk.random/-random/-random/#random","title":"Random","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/","title":"ThreadLocalRandom - Misk","text":"//misk-core/misk.random/ThreadLocalRandom
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/#threadlocalrandom","title":"ThreadLocalRandom","text":"[jvm]\\ @Singleton
open class ThreadLocalRandom@Injectconstructor
Abstraction for Java\u2019s ThreadLocalRandom that allows for testing.
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/#constructors","title":"Constructors","text":"ThreadLocalRandom [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/#functions","title":"Functions","text":"Name Summary current [jvm]open fun current(): Random"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/-thread-local-random/","title":"ThreadLocalRandom - Misk","text":"//misk-core/misk.random/ThreadLocalRandom/ThreadLocalRandom
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/-thread-local-random/#threadlocalrandom","title":"ThreadLocalRandom","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/current/","title":"current - Misk","text":"//misk-core/misk.random/ThreadLocalRandom/current
"},{"location":"0.x/misk-core/misk-core/misk.random/-thread-local-random/current/#current","title":"current","text":"[jvm]\\ open fun current(): Random
"},{"location":"0.x/misk-core/misk-core/misk.retries/","title":"Package-level declarations - Misk","text":"//misk-core/misk.retries
"},{"location":"0.x/misk-core/misk-core/misk.retries/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.retries/#functions","title":"Functions","text":"Name Summary doNotRetry [jvm]inline fun <T : Exception> doNotRetry(): RetryPolicy<Throwable>Returns a RetryPolicy that will throw the error that triggered the retry if it is type T. Otherwise, it voices no objection to retrying. retryWithHooks [jvm]suspend fun <T> retryWithHooks(policy: RetryPolicy<Throwable>, beforeRetryHook: () -> Unit, op: () -> T): TThis is a retry helper function with some hooks."},{"location":"0.x/misk-core/misk-core/misk.retries/do-not-retry/","title":"doNotRetry - Misk","text":"//misk-core/misk.retries/doNotRetry
"},{"location":"0.x/misk-core/misk-core/misk.retries/do-not-retry/#donotretry","title":"doNotRetry","text":"[jvm]\\ inline fun <T : Exception> doNotRetry(): RetryPolicy<Throwable>
Returns a RetryPolicy that will throw the error that triggered the retry if it is type T. Otherwise, it voices no objection to retrying.
"},{"location":"0.x/misk-core/misk-core/misk.retries/retry-with-hooks/","title":"retryWithHooks - Misk","text":"//misk-core/misk.retries/retryWithHooks
"},{"location":"0.x/misk-core/misk-core/misk.retries/retry-with-hooks/#retrywithhooks","title":"retryWithHooks","text":"[jvm]\\ suspend fun <T> retryWithHooks(policy: RetryPolicy<Throwable>, beforeRetryHook: () -> Unit, op: () -> T): T
This is a retry helper function with some hooks.
//misk-core/misk.sampling
"},{"location":"0.x/misk-core/misk-core/misk.sampling/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.sampling/#types","title":"Types","text":"Name Summary AlwaysSampler [jvm]@Singletonclass AlwaysSampler@Injectconstructor : SamplerSampler that always invokes an action PercentSampler [jvm]class PercentSampler@JvmOverloadsconstructor(val samplePercentage: () -> Int, val random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) }) : SamplerA Sampler randomly invokes an action based on a sample percentage RateLimiter [jvm]class RateLimiterA deterministic testable rate limiter that uses two variables: RateLimitingSampler [jvm]class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler Sampler [jvm]interface Sampler"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/","title":"AlwaysSampler - Misk","text":"//misk-core/misk.sampling/AlwaysSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\ @Singleton
class AlwaysSampler@Injectconstructor : Sampler
Sampler that always invokes an action
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/#constructors","title":"Constructors","text":"AlwaysSampler [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/-always-sampler/","title":"AlwaysSampler - Misk","text":"//misk-core/misk.sampling/AlwaysSampler/AlwaysSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/AlwaysSampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-always-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/","title":"PercentSampler - Misk","text":"//misk-core/misk.sampling/PercentSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#percentsampler","title":"PercentSampler","text":"[jvm]\\ class PercentSampler@JvmOverloadsconstructor(val samplePercentage: () -> Int, val random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) }) : Sampler
A Sampler randomly invokes an action based on a sample percentage
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#constructors","title":"Constructors","text":"PercentSampler [jvm]constructor(samplePercentage: Int, random: () -> Int)constructor(samplePercentage: Int)@JvmOverloadsconstructor(samplePercentage: () -> Int, random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) })"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#properties","title":"Properties","text":"Name Summary random [jvm]val random: () -> Int samplePercentage [jvm]val samplePercentage: () -> Int"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/-percent-sampler/","title":"PercentSampler - Misk","text":"//misk-core/misk.sampling/PercentSampler/PercentSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/-percent-sampler/#percentsampler","title":"PercentSampler","text":"[jvm]\\ constructor(samplePercentage: Int, random: () -> Int)
constructor(samplePercentage: Int)
@JvmOverloads
constructor(samplePercentage: () -> Int, random: () -> Int = { ThreadLocalRandom.current().nextInt(0, 100) })
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/random/","title":"random - Misk","text":"//misk-core/misk.sampling/PercentSampler/random
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/random/#random","title":"random","text":"[jvm]\\ val random: () -> Int
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample-percentage/","title":"samplePercentage - Misk","text":"//misk-core/misk.sampling/PercentSampler/samplePercentage
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample-percentage/#samplepercentage","title":"samplePercentage","text":"[jvm]\\ val samplePercentage: () -> Int
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/PercentSampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-percent-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/","title":"RateLimiter - Misk","text":"//misk-core/misk.sampling/RateLimiter
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\ class RateLimiter
A deterministic testable rate limiter that uses two variables:
The implementation tracks a future timestamp that permits are consumed until.
This class is similar to Guava\u2019s rate limiter. Unlike Guava\u2019s rate limiter this class is testable by application code using the rate limiter. It also has very predictable behavior because its internal mechanisms are simpler than Guava\u2019s.
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#types","title":"Types","text":"Name Summary Factory [jvm]class Factory@Injectconstructor(ticker: Ticker, sleeper: Sleeper)"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#properties","title":"Properties","text":"Name Summary permitsPerSecond [jvm]@Volatilevar permitsPerSecond: Long"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/#functions","title":"Functions","text":"Name Summary getPermitsRemaining [jvm]fun getPermitsRemaining(unit: TimeUnit, timeout: Long): LongReturns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit. tryAcquire [jvm]fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): BooleanAttempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available."},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/get-permits-remaining/","title":"getPermitsRemaining - Misk","text":"//misk-core/misk.sampling/RateLimiter/getPermitsRemaining
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/get-permits-remaining/#getpermitsremaining","title":"getPermitsRemaining","text":"[jvm]\\ fun getPermitsRemaining(unit: TimeUnit, timeout: Long): Long
Returns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit.
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/permits-per-second/","title":"permitsPerSecond - Misk","text":"//misk-core/misk.sampling/RateLimiter/permitsPerSecond
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/permits-per-second/#permitspersecond","title":"permitsPerSecond","text":"[jvm]\\
@Volatile
var permitsPerSecond: Long
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"//misk-core/misk.sampling/RateLimiter/tryAcquire
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"[jvm]\\ fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): Boolean
Attempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available.
Returns true if permits were acquired.
This always returns false if you request more than 1 window size worth of permits. If you need many permits, shrink your batch size. This is intended to smooth out consumption of the resources guarded by this rate limiter.
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/","title":"Factory - Misk","text":"//misk-core/misk.sampling/RateLimiter/Factory
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/#factory","title":"Factory","text":"[jvm]\\ class Factory@Injectconstructor(ticker: Ticker, sleeper: Sleeper)
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor(ticker: Ticker, sleeper: Sleeper)"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(rate: Long): RateLimiter"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/-factory/","title":"Factory - Misk","text":"//misk-core/misk.sampling/RateLimiter/Factory/Factory
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor(ticker: Ticker, sleeper: Sleeper)
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/create/","title":"create - Misk","text":"//misk-core/misk.sampling/RateLimiter/Factory/create
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiter/-factory/create/#create","title":"create","text":"[jvm]\\ fun create(rate: Long): RateLimiter
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//misk-core/misk.sampling/RateLimitingSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/#constructors","title":"Constructors","text":"RateLimitingSampler [jvm]constructor(ratePerSecond: Long)constructor(rateLimiter: RateLimiter)"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//misk-core/misk.sampling/RateLimitingSampler/RateLimitingSampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ constructor(ratePerSecond: Long)
constructor(rateLimiter: RateLimiter)
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/RateLimitingSampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-rate-limiting-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/","title":"Sampler - Misk","text":"//misk-core/misk.sampling/Sampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/#sampler","title":"Sampler","text":"interface Sampler
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/#inheritors","title":"Inheritors","text":"PercentSampler RateLimitingSampler AlwaysSampler"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]abstract fun sample(): BooleanIf an action should be taken based on the implementation\u2019s policy, returns true sampledCall [jvm]open fun sampledCall(f: () -> Unit)If sample returns true, runs the given lambda"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sample/","title":"sample - Misk","text":"//misk-core/misk.sampling/Sampler/sample
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sample/#sample","title":"sample","text":"[jvm]\\ abstract fun sample(): Boolean
If an action should be taken based on the implementation\u2019s policy, returns true
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sampled-call/","title":"sampledCall - Misk","text":"//misk-core/misk.sampling/Sampler/sampledCall
"},{"location":"0.x/misk-core/misk-core/misk.sampling/-sampler/sampled-call/#sampledcall","title":"sampledCall","text":"[jvm]\\ open fun sampledCall(f: () -> Unit)
If sample returns true, runs the given lambda
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/","title":"Package-level declarations - Misk","text":"//misk-core/misk.security.ssl
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#types","title":"Types","text":"Name Summary CertificateAndKey [jvm]typealias CertificateAndKey = wisp.security.ssl.CertificateAndKey CertStore [jvm]typealias CertStore = wisp.security.ssl.CertStoreA certificate and its private key. CertStoreConfig [jvm]data class CertStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS) SslContextFactory [jvm]class SslContextFactory@Injectconstructor(sslLoader: SslLoader) SslLoader [jvm]class SslLoaderLoads keys and certificates from the file system. TrustStore [jvm]typealias TrustStore = wisp.security.ssl.TrustStoreA set of trusted root certificates. TrustStoreConfig [jvm]data class TrustStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#properties","title":"Properties","text":"Name Summary onlyAlias [jvm]val KeyStore.onlyAlias: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/#functions","title":"Functions","text":"Name Summary aliasesOfType [jvm]inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String> getCertificateAndKey [jvm]fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey? getPrivateKey [jvm]fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKeyfun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey getX509Certificate [jvm]fun KeyStore.getX509Certificate(): X509Certificatefun KeyStore.getX509Certificate(alias: String): X509Certificate getX509CertificateChain [jvm]fun KeyStore.getX509CertificateChain(): Array<X509Certificate>fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/aliases-of-type/","title":"aliasesOfType - Misk","text":"//misk-core/misk.security.ssl/aliasesOfType
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/aliases-of-type/#aliasesoftype","title":"aliasesOfType","text":"[jvm]\\ fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/aliases-of-type/#return","title":"Return","text":"all aliases present in the keystore of a given entry type.
[jvm]\\ inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/","title":"getCertificateAndKey - Misk","text":"//misk-core/misk.security.ssl/getCertificateAndKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/#getcertificateandkey","title":"getCertificateAndKey","text":"[jvm]\\ fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/#return","title":"Return","text":"the certificate and key pair for the given alias
[jvm]\\ fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-certificate-and-key/#return_1","title":"Return","text":"the one and only CertificateAndKey in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/","title":"getPrivateKey - Misk","text":"//misk-core/misk.security.ssl/getPrivateKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/#getprivatekey","title":"getPrivateKey","text":"[jvm]\\ fun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/#return","title":"Return","text":"the PrivateKey with the given alias
[jvm]\\ fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-private-key/#return_1","title":"Return","text":"the one and only PrivateKey in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/","title":"getX509CertificateChain - Misk","text":"//misk-core/misk.security.ssl/getX509CertificateChain
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/#getx509certificatechain","title":"getX509CertificateChain","text":"[jvm]\\ fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/#return","title":"Return","text":"the X509Certificate chain with the provided alias
[jvm]\\ fun KeyStore.getX509CertificateChain(): Array<X509Certificate>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate-chain/#return_1","title":"Return","text":"the one and only X509Certificate chain in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/","title":"getX509Certificate - Misk","text":"//misk-core/misk.security.ssl/getX509Certificate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/#getx509certificate","title":"getX509Certificate","text":"[jvm]\\ fun KeyStore.getX509Certificate(alias: String): X509Certificate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/#return","title":"Return","text":"The X509Certificate with the provided alias
[jvm]\\ fun KeyStore.getX509Certificate(): X509Certificate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/get-x509-certificate/#return_1","title":"Return","text":"the one and only X509Certificate in the keystore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/only-alias/","title":"onlyAlias - Misk","text":"//misk-core/misk.security.ssl/onlyAlias
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/only-alias/#onlyalias","title":"onlyAlias","text":"[jvm]\\ val KeyStore.onlyAlias: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/only-alias/#return","title":"Return","text":"the only alias in the keystore, if the keystore only has a single entry
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store/","title":"CertStore - Misk","text":"//misk-core/misk.security.ssl/CertStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store/#certstore","title":"CertStore","text":"[jvm]\\ typealias CertStore = wisp.security.ssl.CertStore
A certificate and its private key.
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\ data class CertStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#constructors","title":"Constructors","text":"CertStoreConfig [jvm]@Injectconstructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): CertStoreConfig"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/CertStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\
@Inject
constructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/format/","title":"format - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/format
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/passphrase/","title":"passphrase - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/passphrase
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/resource/","title":"resource - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/resource
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk-core/misk.security.ssl/CertStoreConfig/toWispConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-cert-store-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): CertStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-certificate-and-key/","title":"CertificateAndKey - Misk","text":"//misk-core/misk.security.ssl/CertificateAndKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-certificate-and-key/#certificateandkey","title":"CertificateAndKey","text":"[jvm]\\ typealias CertificateAndKey = wisp.security.ssl.CertificateAndKey
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\ class SslContextFactory@Injectconstructor(sslLoader: SslLoader)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#constructors","title":"Constructors","text":"SslContextFactory [jvm]@Injectconstructor(sslLoader: SslLoader)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: SslContextFactory"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsfun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext@JvmOverloadsfun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext loadTrustManagers [jvm]fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/SslContextFactory
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\
@Inject
constructor(sslLoader: SslLoader)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/create/","title":"create - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/create
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/create/#create","title":"create","text":"[jvm]\\
@JvmOverloads
fun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext
@JvmOverloads
fun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/create/#return","title":"Return","text":"A new SSLContext for the given certstore and optional truststore config
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/delegate/","title":"delegate - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/delegate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: SslContextFactory
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/load-trust-managers/","title":"loadTrustManagers - Misk","text":"//misk-core/misk.security.ssl/SslContextFactory/loadTrustManagers
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/load-trust-managers/#loadtrustmanagers","title":"loadTrustManagers","text":"[jvm]\\ fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-context-factory/load-trust-managers/#return","title":"Return","text":"a set of TrustManagers based on the certificates in the given truststore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/","title":"SslLoader - Misk","text":"//misk-core/misk.security.ssl/SslLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#sslloader","title":"SslLoader","text":"[jvm]\\ class SslLoader
Loads keys and certificates from the file system.
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#properties","title":"Properties","text":"Name Summary delegate [jvm]val delegate: SslLoader resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/#functions","title":"Functions","text":"Name Summary loadCertStore [jvm]fun loadCertStore(config: CertStoreConfig): CertStore?@JvmOverloadsfun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore? loadTrustStore [jvm]fun loadTrustStore(config: TrustStoreConfig): TrustStore?@JvmOverloadsfun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/delegate/","title":"delegate - Misk","text":"//misk-core/misk.security.ssl/SslLoader/delegate
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/delegate/#delegate","title":"delegate","text":"[jvm]\\ val delegate: SslLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-cert-store/","title":"loadCertStore - Misk","text":"//misk-core/misk.security.ssl/SslLoader/loadCertStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-cert-store/#loadcertstore","title":"loadCertStore","text":"[jvm]\\
@JvmOverloads
fun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore?
fun loadCertStore(config: CertStoreConfig): CertStore?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-trust-store/","title":"loadTrustStore - Misk","text":"//misk-core/misk.security.ssl/SslLoader/loadTrustStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/load-trust-store/#loadtruststore","title":"loadTrustStore","text":"[jvm]\\
@JvmOverloads
fun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?
fun loadTrustStore(config: TrustStoreConfig): TrustStore?
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/resource-loader/","title":"resourceLoader - Misk","text":"//misk-core/misk.security.ssl/SslLoader/resourceLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/","title":"Companion - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/#properties","title":"Properties","text":"Name Summary FORMAT_JCEKS [jvm]const val FORMAT_JCEKS: String FORMAT_JKS [jvm]const val FORMAT_JKS: String FORMAT_PEM [jvm]const val FORMAT_PEM: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/","title":"FORMAT_JCEKS - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion/FORMAT_JCEKS
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/#format_jceks","title":"FORMAT_JCEKS","text":"[jvm]\\ const val FORMAT_JCEKS: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/","title":"FORMAT_JKS - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion/FORMAT_JKS
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/#format_jks","title":"FORMAT_JKS","text":"[jvm]\\ const val FORMAT_JKS: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/","title":"FORMAT_PEM - Misk","text":"//misk-core/misk.security.ssl/SslLoader/Companion/FORMAT_PEM
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/#format_pem","title":"FORMAT_PEM","text":"[jvm]\\ const val FORMAT_PEM: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store/","title":"TrustStore - Misk","text":"//misk-core/misk.security.ssl/TrustStore
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store/#truststore","title":"TrustStore","text":"[jvm]\\ typealias TrustStore = wisp.security.ssl.TrustStore
A set of trusted root certificates.
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\ data class TrustStoreConfig@Injectconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#constructors","title":"Constructors","text":"TrustStoreConfig [jvm]@Injectconstructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/#functions","title":"Functions","text":"Name Summary toWispConfig [jvm]fun toWispConfig(): TrustStoreConfig"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/TrustStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\
@Inject
constructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/format/","title":"format - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/format
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/passphrase/","title":"passphrase - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/passphrase
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/resource/","title":"resource - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/resource
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/to-wisp-config/","title":"toWispConfig - Misk","text":"//misk-core/misk.security.ssl/TrustStoreConfig/toWispConfig
"},{"location":"0.x/misk-core/misk-core/misk.security.ssl/-trust-store-config/to-wisp-config/#towispconfig","title":"toWispConfig","text":"[jvm]\\ fun toWispConfig(): TrustStoreConfig
"},{"location":"0.x/misk-core/misk-core/misk.tokens/","title":"Package-level declarations - Misk","text":"//misk-core/misk.tokens
"},{"location":"0.x/misk-core/misk-core/misk.tokens/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.tokens/#types","title":"Types","text":"Name Summary FakeTokenGenerator [jvm]@Singletonclass FakeTokenGenerator@Injectconstructor : TokenGenerator FakeTokenGenerator2 [jvm]@Singletonclass FakeTokenGenerator2@Injectconstructor : TokenGenerator2 FakeTokenGeneratorModule [jvm]class FakeTokenGeneratorModule : KAbstractModule RealTokenGenerator [jvm]@Singletonclass RealTokenGenerator@Injectconstructor : TokenGenerator RealTokenGenerator2 [jvm]@Singletonclass RealTokenGenerator2@Injectconstructor : TokenGenerator2 TokenGenerator [jvm]typealias TokenGenerator = wisp.token.TokenGenerator TokenGenerator2 [jvm]interface TokenGenerator2 TokenGeneratorModule [jvm]class TokenGeneratorModule : KAbstractModule"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\ @Singleton
class FakeTokenGenerator@Injectconstructor : TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/#constructors","title":"Constructors","text":"FakeTokenGenerator [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator/FakeTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/","title":"FakeTokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/FakeTokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/#faketokengeneratormodule","title":"FakeTokenGeneratorModule","text":"[jvm]\\ class FakeTokenGeneratorModule : KAbstractModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/#constructors","title":"Constructors","text":"FakeTokenGeneratorModule [jvm]constructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/-fake-token-generator-module/","title":"FakeTokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/FakeTokenGeneratorModule/FakeTokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator-module/-fake-token-generator-module/#faketokengeneratormodule","title":"FakeTokenGeneratorModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/","title":"FakeTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/#faketokengenerator2","title":"FakeTokenGenerator2","text":"[jvm]\\ @Singleton
class FakeTokenGenerator2@Injectconstructor : TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/#constructors","title":"Constructors","text":"FakeTokenGenerator2 [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/-fake-token-generator2/","title":"FakeTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator2/FakeTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/-fake-token-generator2/#faketokengenerator2","title":"FakeTokenGenerator2","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/generate/","title":"generate - Misk","text":"//misk-core/misk.tokens/FakeTokenGenerator2/generate
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-fake-token-generator2/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\ @Singleton
class RealTokenGenerator@Injectconstructor : TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/#constructors","title":"Constructors","text":"RealTokenGenerator [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator/RealTokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/","title":"RealTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/#realtokengenerator2","title":"RealTokenGenerator2","text":"[jvm]\\ @Singleton
class RealTokenGenerator2@Injectconstructor : TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/#constructors","title":"Constructors","text":"RealTokenGenerator2 [jvm]@Injectconstructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/-real-token-generator2/","title":"RealTokenGenerator2 - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator2/RealTokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/-real-token-generator2/#realtokengenerator2","title":"RealTokenGenerator2","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/generate/","title":"generate - Misk","text":"//misk-core/misk.tokens/RealTokenGenerator2/generate
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-real-token-generator2/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator/","title":"TokenGenerator - Misk","text":"//misk-core/misk.tokens/TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator/#tokengenerator","title":"TokenGenerator","text":"[jvm]\\ typealias TokenGenerator = wisp.token.TokenGenerator
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/","title":"TokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/TokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/#tokengeneratormodule","title":"TokenGeneratorModule","text":"[jvm]\\ class TokenGeneratorModule : KAbstractModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/#constructors","title":"Constructors","text":"TokenGeneratorModule [jvm]constructor()"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/-token-generator-module/","title":"TokenGeneratorModule - Misk","text":"//misk-core/misk.tokens/TokenGeneratorModule/TokenGeneratorModule
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator-module/-token-generator-module/#tokengeneratormodule","title":"TokenGeneratorModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/","title":"TokenGenerator2 - Misk","text":"//misk-core/misk.tokens/TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#tokengenerator2","title":"TokenGenerator2","text":"interface TokenGenerator2
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#inheritors","title":"Inheritors","text":"FakeTokenGenerator2 RealTokenGenerator2"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/#functions","title":"Functions","text":"Name Summary generate [jvm]abstract fun generate(label: String? = null, length: Int = 25): String"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/generate/","title":"generate - Misk","text":"//misk-core/misk.tokens/TokenGenerator2/generate
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/generate/#generate","title":"generate","text":"[jvm]\\ abstract fun generate(label: String? = null, length: Int = 25): String
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/","title":"Companion - Misk","text":"//misk-core/misk.tokens/TokenGenerator2/Companion
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/#functions","title":"Functions","text":"Name Summary canonicalize [jvm]fun canonicalize(token: String): StringReturns a token semantically equal totoken but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted."},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/canonicalize/","title":"canonicalize - Misk","text":"//misk-core/misk.tokens/TokenGenerator2/Companion/canonicalize
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/canonicalize/#canonicalize","title":"canonicalize","text":"[jvm]\\ fun canonicalize(token: String): String
Returns a token semantically equal to token but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted.
Call this when accepting tokens that may have been transcribed by a user. It is not necessary to canonicalize tokens that haven\u2019t been manually entered; they will already be in canonical form.
"},{"location":"0.x/misk-core/misk-core/misk.tokens/-token-generator2/-companion/canonicalize/#throws","title":"Throws","text":"IllegalArgumentException iftoken contains a character that cannot be mapped and that is not a space."},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/","title":"Package-level declarations - Misk","text":"//misk-core/misk.web.mediatype
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/#types","title":"Types","text":"Name Summary MediaRange [jvm]data class MediaRange@JvmOverloadsconstructor(val type: String, val subtype: String, val charset: Charset? = null, val qualityFactor: Double = 1.0, val parameters: Map<String, String> = mapOf(), val extensions: Map<String, String> = mapOf(), rawText: String) : Comparable<MediaRange> An RFC-2616 media range MediaTypes [jvm]object MediaTypes"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/#functions","title":"Functions","text":"Name Summary asMediaRange [jvm]fun String.asMediaRange(): MediaRange asMediaType [jvm]fun String.asMediaType(): MediaType compareTo [jvm]fun MediaType.compareTo(other: MediaType): Int"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-range/","title":"asMediaRange - Misk","text":"//misk-core/misk.web.mediatype/asMediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-range/#asmediarange","title":"asMediaRange","text":"[jvm]\\ fun String.asMediaRange(): MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-type/","title":"asMediaType - Misk","text":"//misk-core/misk.web.mediatype/asMediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/as-media-type/#asmediatype","title":"asMediaType","text":"[jvm]\\ fun String.asMediaType(): MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/compare-to/","title":"compareTo - Misk","text":"//misk-core/misk.web.mediatype/compareTo
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ fun MediaType.compareTo(other: MediaType): Int
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/","title":"MediaRange - Misk","text":"//misk-core/misk.web.mediatype/MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#mediarange","title":"MediaRange","text":"[jvm]\\ data class MediaRange@JvmOverloadsconstructor(val type: String, val subtype: String, val charset: Charset? = null, val qualityFactor: Double = 1.0, val parameters: Map<String, String> = mapOf(), val extensions: Map<String, String> = mapOf(), rawText: String) : Comparable<MediaRange>
An RFC-2616 media range
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#constructors","title":"Constructors","text":"MediaRange [jvm]@JvmOverloadsconstructor(type: String, subtype: String, charset: Charset? = null, qualityFactor: Double = 1.0, parameters: Map<String, String> = mapOf(), extensions: Map<String, String> = mapOf(), rawText: String)"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Matcher [jvm]class Matcher@JvmOverloadsconstructor(val mediaRange: MediaRange, val matchesCharset: Boolean = false) : Comparable<MediaRange.Matcher>"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#properties","title":"Properties","text":"Name Summary charset [jvm]val charset: Charset? = null extensions [jvm]val extensions: Map<String, String> parameters [jvm]val parameters: Map<String, String> qualityFactor [jvm]val qualityFactor: Double = 1.0 subtype [jvm]val subtype: String type [jvm]val type: String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: MediaRange): Int matcher [jvm]fun matcher(mediaType: MediaType): MediaRange.Matcher? toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-media-range/","title":"MediaRange - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-media-range/#mediarange","title":"MediaRange","text":"[jvm]\\
@JvmOverloads
constructor(type: String, subtype: String, charset: Charset? = null, qualityFactor: Double = 1.0, parameters: Map<String, String> = mapOf(), extensions: Map<String, String> = mapOf(), rawText: String)
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/charset/","title":"charset - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/charset
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/charset/#charset","title":"charset","text":"[jvm]\\ val charset: Charset? = null
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/compare-to/","title":"compareTo - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/compareTo
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: MediaRange): Int
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/extensions/","title":"extensions - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/extensions
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/extensions/#extensions","title":"extensions","text":"[jvm]\\ val extensions: Map<String, String>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/matcher/","title":"matcher - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/matcher
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/matcher/#matcher","title":"matcher","text":"[jvm]\\ fun matcher(mediaType: MediaType): MediaRange.Matcher?
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/parameters/","title":"parameters - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/parameters
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/parameters/#parameters","title":"parameters","text":"[jvm]\\ val parameters: Map<String, String>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/quality-factor/","title":"qualityFactor - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/qualityFactor
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/quality-factor/#qualityfactor","title":"qualityFactor","text":"[jvm]\\ val qualityFactor: Double = 1.0
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/subtype/","title":"subtype - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/subtype
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/subtype/#subtype","title":"subtype","text":"[jvm]\\ val subtype: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/to-string/","title":"toString - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/toString
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/type/","title":"type - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/type
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/","title":"Companion - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/#properties","title":"Properties","text":"Name Summary ALL_MEDIA [jvm]val ALL_MEDIA: MediaRange WILDCARD [jvm]const val WILDCARD: String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(s: String): MediaRange parseRanges [jvm]fun parseRanges(s: String, swallowExceptions: Boolean = false): List<MediaRange>"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-a-l-l_-m-e-d-i-a/","title":"ALL_MEDIA - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/ALL_MEDIA
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-a-l-l_-m-e-d-i-a/#all_media","title":"ALL_MEDIA","text":"[jvm]\\ val ALL_MEDIA: MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-w-i-l-d-c-a-r-d/","title":"WILDCARD - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/WILDCARD
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/-w-i-l-d-c-a-r-d/#wildcard","title":"WILDCARD","text":"[jvm]\\ const val WILDCARD: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse-ranges/","title":"parseRanges - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/parseRanges
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse-ranges/#parseranges","title":"parseRanges","text":"[jvm]\\ fun parseRanges(s: String, swallowExceptions: Boolean = false): List<MediaRange>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse/","title":"parse - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Companion/parse
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(s: String): MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/","title":"Matcher - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#matcher","title":"Matcher","text":"[jvm]\\ class Matcher@JvmOverloadsconstructor(val mediaRange: MediaRange, val matchesCharset: Boolean = false) : Comparable<MediaRange.Matcher>
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#constructors","title":"Constructors","text":"Matcher [jvm]@JvmOverloadsconstructor(mediaRange: MediaRange, matchesCharset: Boolean = false)"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#properties","title":"Properties","text":"Name Summary matchesCharset [jvm]val matchesCharset: Boolean = false mediaRange [jvm]val mediaRange: MediaRange"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: MediaRange.Matcher): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/-matcher/","title":"Matcher - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/Matcher
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/-matcher/#matcher","title":"Matcher","text":"[jvm]\\
@JvmOverloads
constructor(mediaRange: MediaRange, matchesCharset: Boolean = false)
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/compare-to/","title":"compareTo - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/compareTo
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: MediaRange.Matcher): Int
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/matches-charset/","title":"matchesCharset - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/matchesCharset
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/matches-charset/#matchescharset","title":"matchesCharset","text":"[jvm]\\ val matchesCharset: Boolean = false
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/media-range/","title":"mediaRange - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/mediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/media-range/#mediarange","title":"mediaRange","text":"[jvm]\\ val mediaRange: MediaRange
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/to-string/","title":"toString - Misk","text":"//misk-core/misk.web.mediatype/MediaRange/Matcher/toString
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-range/-matcher/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/","title":"MediaTypes - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/#mediatypes","title":"MediaTypes","text":"[jvm]\\ object MediaTypes
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/#properties","title":"Properties","text":"Name Summary ALL [jvm]const val ALL: String ALL_MEDIA_TYPE [jvm]val ALL_MEDIA_TYPE: MediaType APPLICATION_FORM_URLENCODED [jvm]const val APPLICATION_FORM_URLENCODED: String APPLICATION_GRPC [jvm]const val APPLICATION_GRPC: String APPLICATION_GRPC_MEDIA_TYPE [jvm]val APPLICATION_GRPC_MEDIA_TYPE: MediaType APPLICATION_JAVASCRIPT [jvm]const val APPLICATION_JAVASCRIPT: String APPLICATION_JAVASCRIPT_MEDIA_TYPE [jvm]val APPLICATION_JAVASCRIPT_MEDIA_TYPE: MediaType APPLICATION_JSON [jvm]const val APPLICATION_JSON: String APPLICATION_JSON_MEDIA_TYPE [jvm]val APPLICATION_JSON_MEDIA_TYPE: MediaType APPLICATION_OCTETSTREAM [jvm]const val APPLICATION_OCTETSTREAM: String APPLICATION_OCTETSTREAM_MEDIA_TYPE [jvm]val APPLICATION_OCTETSTREAM_MEDIA_TYPE: MediaType APPLICATION_PROTOBUF [jvm]const val APPLICATION_PROTOBUF: String APPLICATION_PROTOBUF_MEDIA_TYPE [jvm]val APPLICATION_PROTOBUF_MEDIA_TYPE: MediaType APPLICATION_XML [jvm]const val APPLICATION_XML: String APPLICATION_XML_MEDIA_TYPE [jvm]val APPLICATION_XML_MEDIA_TYPE: MediaType IMAGE_GIF [jvm]const val IMAGE_GIF: String IMAGE_GIF_MEDIA_TYPE [jvm]val IMAGE_GIF_MEDIA_TYPE: MediaType IMAGE_ICO [jvm]const val IMAGE_ICO: String IMAGE_ICO_MEDIA_TYPE [jvm]val IMAGE_ICO_MEDIA_TYPE: MediaType IMAGE_JPEG [jvm]const val IMAGE_JPEG: String IMAGE_JPEG_MEDIA_TYPE [jvm]val IMAGE_JPEG_MEDIA_TYPE: MediaType IMAGE_PNG [jvm]const val IMAGE_PNG: String IMAGE_PNG_MEDIA_TYPE [jvm]val IMAGE_PNG_MEDIA_TYPE: MediaType IMAGE_SVG [jvm]const val IMAGE_SVG: String IMAGE_SVG_MEDIA_TYPE [jvm]val IMAGE_SVG_MEDIA_TYPE: MediaType TEXT_CSS [jvm]const val TEXT_CSS: String TEXT_CSS_MEDIA_TYPE [jvm]val TEXT_CSS_MEDIA_TYPE: MediaType TEXT_HTML [jvm]const val TEXT_HTML: String TEXT_HTML_MEDIA_TYPE [jvm]val TEXT_HTML_MEDIA_TYPE: MediaType TEXT_PLAIN_UTF8 [jvm]const val TEXT_PLAIN_UTF8: String TEXT_PLAIN_UTF8_MEDIA_TYPE [jvm]val TEXT_PLAIN_UTF8_MEDIA_TYPE: MediaType TURBO_STREAM [jvm]const val TURBO_STREAM: String TURBO_STREAM_MEDIA_TYPE [jvm]val TURBO_STREAM_MEDIA_TYPE: MediaType"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/#functions","title":"Functions","text":"Name Summary fromFileExtension [jvm]fun fromFileExtension(ext: String): MediaType"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l/","title":"ALL - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/ALL
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l/#all","title":"ALL","text":"[jvm]\\ const val ALL: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l_-m-e-d-i-a_-t-y-p-e/","title":"ALL_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/ALL_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-l-l_-m-e-d-i-a_-t-y-p-e/#all_media_type","title":"ALL_MEDIA_TYPE","text":"[jvm]\\ val ALL_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-f-o-r-m_-u-r-l-e-n-c-o-d-e-d/","title":"APPLICATION_FORM_URLENCODED - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_FORM_URLENCODED
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-f-o-r-m_-u-r-l-e-n-c-o-d-e-d/#application_form_urlencoded","title":"APPLICATION_FORM_URLENCODED","text":"[jvm]\\ const val APPLICATION_FORM_URLENCODED: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c/","title":"APPLICATION_GRPC - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_GRPC
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c/#application_grpc","title":"APPLICATION_GRPC","text":"[jvm]\\ const val APPLICATION_GRPC: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_GRPC_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_GRPC_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-g-r-p-c_-m-e-d-i-a_-t-y-p-e/#application_grpc_media_type","title":"APPLICATION_GRPC_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_GRPC_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t/","title":"APPLICATION_JAVASCRIPT - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JAVASCRIPT
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t/#application_javascript","title":"APPLICATION_JAVASCRIPT","text":"[jvm]\\ const val APPLICATION_JAVASCRIPT: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_JAVASCRIPT_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JAVASCRIPT_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-a-v-a-s-c-r-i-p-t_-m-e-d-i-a_-t-y-p-e/#application_javascript_media_type","title":"APPLICATION_JAVASCRIPT_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_JAVASCRIPT_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n/","title":"APPLICATION_JSON - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JSON
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n/#application_json","title":"APPLICATION_JSON","text":"[jvm]\\ const val APPLICATION_JSON: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_JSON_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_JSON_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-j-s-o-n_-m-e-d-i-a_-t-y-p-e/#application_json_media_type","title":"APPLICATION_JSON_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_JSON_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m/","title":"APPLICATION_OCTETSTREAM - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_OCTETSTREAM
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m/#application_octetstream","title":"APPLICATION_OCTETSTREAM","text":"[jvm]\\ const val APPLICATION_OCTETSTREAM: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_OCTETSTREAM_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_OCTETSTREAM_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-o-c-t-e-t-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/#application_octetstream_media_type","title":"APPLICATION_OCTETSTREAM_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_OCTETSTREAM_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f/","title":"APPLICATION_PROTOBUF - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_PROTOBUF
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f/#application_protobuf","title":"APPLICATION_PROTOBUF","text":"[jvm]\\ const val APPLICATION_PROTOBUF: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_PROTOBUF_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_PROTOBUF_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-p-r-o-t-o-b-u-f_-m-e-d-i-a_-t-y-p-e/#application_protobuf_media_type","title":"APPLICATION_PROTOBUF_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_PROTOBUF_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l/","title":"APPLICATION_XML - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_XML
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l/#application_xml","title":"APPLICATION_XML","text":"[jvm]\\ const val APPLICATION_XML: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l_-m-e-d-i-a_-t-y-p-e/","title":"APPLICATION_XML_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/APPLICATION_XML_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-a-p-p-l-i-c-a-t-i-o-n_-x-m-l_-m-e-d-i-a_-t-y-p-e/#application_xml_media_type","title":"APPLICATION_XML_MEDIA_TYPE","text":"[jvm]\\ val APPLICATION_XML_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f/","title":"IMAGE_GIF - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_GIF
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f/#image_gif","title":"IMAGE_GIF","text":"[jvm]\\ const val IMAGE_GIF: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_GIF_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_GIF_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-g-i-f_-m-e-d-i-a_-t-y-p-e/#image_gif_media_type","title":"IMAGE_GIF_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_GIF_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o/","title":"IMAGE_ICO - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_ICO
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o/#image_ico","title":"IMAGE_ICO","text":"[jvm]\\ const val IMAGE_ICO: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_ICO_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_ICO_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-i-c-o_-m-e-d-i-a_-t-y-p-e/#image_ico_media_type","title":"IMAGE_ICO_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_ICO_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g/","title":"IMAGE_JPEG - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_JPEG
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g/#image_jpeg","title":"IMAGE_JPEG","text":"[jvm]\\ const val IMAGE_JPEG: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_JPEG_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_JPEG_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-j-p-e-g_-m-e-d-i-a_-t-y-p-e/#image_jpeg_media_type","title":"IMAGE_JPEG_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_JPEG_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g/","title":"IMAGE_PNG - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_PNG
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g/#image_png","title":"IMAGE_PNG","text":"[jvm]\\ const val IMAGE_PNG: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_PNG_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_PNG_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-p-n-g_-m-e-d-i-a_-t-y-p-e/#image_png_media_type","title":"IMAGE_PNG_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_PNG_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g/","title":"IMAGE_SVG - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_SVG
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g/#image_svg","title":"IMAGE_SVG","text":"[jvm]\\ const val IMAGE_SVG: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g_-m-e-d-i-a_-t-y-p-e/","title":"IMAGE_SVG_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/IMAGE_SVG_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-i-m-a-g-e_-s-v-g_-m-e-d-i-a_-t-y-p-e/#image_svg_media_type","title":"IMAGE_SVG_MEDIA_TYPE","text":"[jvm]\\ val IMAGE_SVG_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s/","title":"TEXT_CSS - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_CSS
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s/#text_css","title":"TEXT_CSS","text":"[jvm]\\ const val TEXT_CSS: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s_-m-e-d-i-a_-t-y-p-e/","title":"TEXT_CSS_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_CSS_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-c-s-s_-m-e-d-i-a_-t-y-p-e/#text_css_media_type","title":"TEXT_CSS_MEDIA_TYPE","text":"[jvm]\\ val TEXT_CSS_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l/","title":"TEXT_HTML - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_HTML
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l/#text_html","title":"TEXT_HTML","text":"[jvm]\\ const val TEXT_HTML: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l_-m-e-d-i-a_-t-y-p-e/","title":"TEXT_HTML_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_HTML_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-h-t-m-l_-m-e-d-i-a_-t-y-p-e/#text_html_media_type","title":"TEXT_HTML_MEDIA_TYPE","text":"[jvm]\\ val TEXT_HTML_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8/","title":"TEXT_PLAIN_UTF8 - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_PLAIN_UTF8
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8/#text_plain_utf8","title":"TEXT_PLAIN_UTF8","text":"[jvm]\\ const val TEXT_PLAIN_UTF8: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8_-m-e-d-i-a_-t-y-p-e/","title":"TEXT_PLAIN_UTF8_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TEXT_PLAIN_UTF8_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-e-x-t_-p-l-a-i-n_-u-t-f8_-m-e-d-i-a_-t-y-p-e/#text_plain_utf8_media_type","title":"TEXT_PLAIN_UTF8_MEDIA_TYPE","text":"[jvm]\\ val TEXT_PLAIN_UTF8_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m/","title":"TURBO_STREAM - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TURBO_STREAM
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m/#turbo_stream","title":"TURBO_STREAM","text":"[jvm]\\ const val TURBO_STREAM: String
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/","title":"TURBO_STREAM_MEDIA_TYPE - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/TURBO_STREAM_MEDIA_TYPE
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/-t-u-r-b-o_-s-t-r-e-a-m_-m-e-d-i-a_-t-y-p-e/#turbo_stream_media_type","title":"TURBO_STREAM_MEDIA_TYPE","text":"[jvm]\\ val TURBO_STREAM_MEDIA_TYPE: MediaType
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/from-file-extension/","title":"fromFileExtension - Misk","text":"//misk-core/misk.web.mediatype/MediaTypes/fromFileExtension
"},{"location":"0.x/misk-core/misk-core/misk.web.mediatype/-media-types/from-file-extension/#fromfileextension","title":"fromFileExtension","text":"[jvm]\\ fun fromFileExtension(ext: String): MediaType
"},{"location":"0.x/misk-cron/","title":"misk-cron - Misk","text":"//misk-cron
"},{"location":"0.x/misk-cron/#misk-cron","title":"misk-cron","text":""},{"location":"0.x/misk-cron/#packages","title":"Packages","text":"Name misk.cron"},{"location":"0.x/misk-cron/misk-cron/misk.cron/","title":"Package-level declarations - Misk","text":"//misk-cron/misk.cron
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-cron/misk-cron/misk.cron/#types","title":"Types","text":"Name Summary CronEntryModule [jvm]class CronEntryModule<A : Runnable> : KAbstractModule CronManager [jvm]@Singletonclass CronManager@Injectconstructor CronModule [jvm]class CronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KInstallOnceModule CronPattern [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])annotation class CronPattern(val pattern: String) FakeCronModule [jvm]class FakeCronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KAbstractModule"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/","title":"CronEntryModule - Misk","text":"//misk-cron/misk.cron/CronEntryModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/#cronentrymodule","title":"CronEntryModule","text":"[jvm]\\ class CronEntryModule<A : Runnable> : KAbstractModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/","title":"Companion - Misk","text":"//misk-cron/misk.cron/CronEntryModule/Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/#functions","title":"Functions","text":"Name Summary create [jvm]inline fun <A : Runnable> create(): CronEntryModule<A>[jvm]fun <A : Runnable> create(cronRunnableClass: KClass<A>): CronEntryModule<A>Registers a cron runnable."},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/create/","title":"create - Misk","text":"//misk-cron/misk.cron/CronEntryModule/Companion/create
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/create/#create","title":"create","text":"[jvm]\\ inline fun <A : Runnable> create(): CronEntryModule<A>
[jvm]\\ fun <A : Runnable> create(cronRunnableClass: KClass<A>): CronEntryModule<A>
Registers a cron runnable.
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-entry-module/-companion/create/#parameters","title":"Parameters","text":"jvm
cronRunnableClass : The cron runnable to register."},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/","title":"CronManager - Misk","text":"//misk-cron/misk.cron/CronManager
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#cronmanager","title":"CronManager","text":"[jvm]\\ @Singleton
class CronManager@Injectconstructor
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#constructors","title":"Constructors","text":"CronManager [jvm]@Injectconstructor()"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion CronEntry [jvm]data class CronEntry(val name: String, val cronTab: String, val executionTime: ExecutionTime, val runnable: Runnable)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/#functions","title":"Functions","text":"Name Summary runReadyCrons [jvm]fun runReadyCrons(lastRun: Instant) waitForCronsComplete [jvm]fun waitForCronsComplete()"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-manager/","title":"CronManager - Misk","text":"//misk-cron/misk.cron/CronManager/CronManager
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-manager/#cronmanager","title":"CronManager","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/run-ready-crons/","title":"runReadyCrons - Misk","text":"//misk-cron/misk.cron/CronManager/runReadyCrons
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/run-ready-crons/#runreadycrons","title":"runReadyCrons","text":"[jvm]\\ fun runReadyCrons(lastRun: Instant)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/wait-for-crons-complete/","title":"waitForCronsComplete - Misk","text":"//misk-cron/misk.cron/CronManager/waitForCronsComplete
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/wait-for-crons-complete/#waitforcronscomplete","title":"waitForCronsComplete","text":"[jvm]\\ fun waitForCronsComplete()
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-companion/","title":"Companion - Misk","text":"//misk-cron/misk.cron/CronManager/Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/","title":"CronEntry - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/#cronentry","title":"CronEntry","text":"[jvm]\\ data class CronEntry(val name: String, val cronTab: String, val executionTime: ExecutionTime, val runnable: Runnable)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/#constructors","title":"Constructors","text":"CronEntry [jvm]constructor(name: String, cronTab: String, executionTime: ExecutionTime, runnable: Runnable)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/#properties","title":"Properties","text":"Name Summary cronTab [jvm]val cronTab: String executionTime [jvm]val executionTime: ExecutionTime name [jvm]val name: String runnable [jvm]val runnable: Runnable"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/-cron-entry/","title":"CronEntry - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/CronEntry
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/-cron-entry/#cronentry","title":"CronEntry","text":"[jvm]\\ constructor(name: String, cronTab: String, executionTime: ExecutionTime, runnable: Runnable)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/cron-tab/","title":"cronTab - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/cronTab
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/cron-tab/#crontab","title":"cronTab","text":"[jvm]\\ val cronTab: String
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/execution-time/","title":"executionTime - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/executionTime
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/execution-time/#executiontime","title":"executionTime","text":"[jvm]\\ val executionTime: ExecutionTime
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/name/","title":"name - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/name
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/runnable/","title":"runnable - Misk","text":"//misk-cron/misk.cron/CronManager/CronEntry/runnable
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-manager/-cron-entry/runnable/#runnable","title":"runnable","text":"[jvm]\\ val runnable: Runnable
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/","title":"CronModule - Misk","text":"//misk-cron/misk.cron/CronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/#cronmodule","title":"CronModule","text":"[jvm]\\ class CronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KInstallOnceModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/#constructors","title":"Constructors","text":"CronModule [jvm]@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int provideTaskQueue [jvm]@Provides@Singletonfun provideTaskQueue(queueFactory: RepeatedTaskQueueFactory): RepeatedTaskQueue"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/-cron-module/","title":"CronModule - Misk","text":"//misk-cron/misk.cron/CronModule/CronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/-cron-module/#cronmodule","title":"CronModule","text":"[jvm]\\
@JvmOverloads
constructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/provide-task-queue/","title":"provideTaskQueue - Misk","text":"//misk-cron/misk.cron/CronModule/provideTaskQueue
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-module/provide-task-queue/#providetaskqueue","title":"provideTaskQueue","text":"[jvm]\\
@Provides
@Singleton
fun provideTaskQueue(queueFactory: RepeatedTaskQueueFactory): RepeatedTaskQueue
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/","title":"CronPattern - Misk","text":"//misk-cron/misk.cron/CronPattern
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/#cronpattern","title":"CronPattern","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class CronPattern(val pattern: String)
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/#properties","title":"Properties","text":"Name Summary pattern [jvm]val pattern: String"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/pattern/","title":"pattern - Misk","text":"//misk-cron/misk.cron/CronPattern/pattern
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-cron-pattern/pattern/#pattern","title":"pattern","text":"[jvm]\\ val pattern: String
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/","title":"FakeCronModule - Misk","text":"//misk-cron/misk.cron/FakeCronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/#fakecronmodule","title":"FakeCronModule","text":"[jvm]\\ class FakeCronModule@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf()) : KAbstractModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/#constructors","title":"Constructors","text":"FakeCronModule [jvm]@JvmOverloadsconstructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/-fake-cron-module/","title":"FakeCronModule - Misk","text":"//misk-cron/misk.cron/FakeCronModule/FakeCronModule
"},{"location":"0.x/misk-cron/misk-cron/misk.cron/-fake-cron-module/-fake-cron-module/#fakecronmodule","title":"FakeCronModule","text":"[jvm]\\
@JvmOverloads
constructor(zoneId: ZoneId, threadPoolSize: Int = 10, dependencies: List<Key<out Service>> = listOf())
"},{"location":"0.x/misk-crypto/","title":"misk-crypto - Misk","text":"//misk-crypto
"},{"location":"0.x/misk-crypto/#misk-crypto","title":"misk-crypto","text":""},{"location":"0.x/misk-crypto/#packages","title":"Packages","text":"Name misk.crypto misk.crypto.internal misk.crypto.pgp misk.crypto.pgp.internal"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/#types","title":"Types","text":"Name Summary AeadKeyManager [jvm]@Singletonclass AeadKeyManager : MappedKeyManager<Aead> Holds a map of every Aead key name to its primitive listed in the configuration for this app. AwsKmsClientModule [jvm]class AwsKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModuleAWS specific KMS client module. Currently uses a file path to a JSON credentials file to initialize the client. If no file is provided, tries to initialize the client using the default credentials path as specified in AwsKmsClient.withDefaultCredentials BucketNameSource [jvm]interface BucketNameSourceBind this to an instance to control how external buckets are referenced. CiphertextFormat [jvm]class CiphertextFormatWraps a ciphertext and the encryption context associated with it in a ByteArray. CryptoConfig [jvm]data class CryptoConfig@JvmOverloadsconstructor(val keys: List<Key>?, val kms_uri: String, val external_data_keys: Map<KeyAlias, KeyType>? = null) : ConfigMain configuration object representing to be used in the app. CryptoModule [jvm]class CryptoModule(config: CryptoConfig) : KAbstractModuleConfigures and registers the keys listed in the configuration file. Each key is read, decrypted, and then bound via Google Guice and added to a MappedKeyManager. DeterministicAeadKeyManager [jvm]@Singletonclass DeterministicAeadKeyManager : MappedKeyManager<DeterministicAead> Holds a map of every DeterministicAead key name to its primitive listed in the configuration for this app. DigitalSignature [jvm]data class DigitalSignature(val signer: PublicKeySign, val verifier: PublicKeyVerify) DigitalSignatureKeyManager [jvm]@Singletonclass DigitalSignatureKeyManager : MappedKeyManager<DigitalSignature> Holds a map of every key name to its corresponding PublicKeySign and PublicKeyVerify primitives. ExternalDataKeys [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class ExternalDataKeysThis annotation is used to decorate the collection of external data keys used in the service. ExternalKeyManagerException [jvm]class ExternalKeyManagerException(message: String) : IOExceptionThrown on creation if external key does not exist. ExternalKeyResolver [jvm]class ExternalKeyResolver@Injectconstructor(val allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>) : KeyResolverExternalKeyResolver implements an KeyResolver that fetches Tink keysets from an external source, such as an S3 bucket. If multiple sources are registered (by binding implementations of KeyResolver), the first one to contain the key (via ExternalKeySource.keyExists) is the key that is used. ExternalKeySource [jvm]interface ExternalKeySourceImplement an ExternalKeySource to provide Tink keysets from an external location, such as an S3 bucket or an NFS share. GcpKmsClientModule [jvm]class GcpKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModuleGCP specific KMS client module. Uses a file path to a JSON credentials file to initialize the client. HybridDecryptKeyManager [jvm]@Singletonclass HybridDecryptKeyManager : MappedKeyManager<HybridDecrypt> Holds a map of every HybridDecrypt key name to its corresponding primitive listed in the configuration for this app. HybridEncryptKeyManager [jvm]@Singletonclass HybridEncryptKeyManager : MappedKeyManager<HybridEncrypt> Holds a map of every HybridEncrypt key name to its corresponding primitive listed in the configuration for this app. Key [jvm]data class Key@JvmOverloadsconstructor(val key_name: String, val key_type: KeyType, val encrypted_key: Secret<String>? = null, val kms_uri: String? = null) : ConfigDescribes a specific key KeyAlias [jvm]typealias KeyAlias = StringA KeyAlias is how we refer to a Tink keyset. KeyNotFoundException [jvm]class KeyNotFoundException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : GeneralSecurityException KeyReader [jvm]open class KeyReader KeyResolver [jvm]interface KeyResolverKeyResolver provides an interface to access keys indexed by aliases. Optionally, callers can register a callback to be invoked when a key is updated. KeyType [jvm]enum KeyType : Enum<KeyType> Supported key types LocalConfigKeyResolver [jvm]class LocalConfigKeyResolver(keys: List<Key>, defaultKmsUri: String) : KeyResolverLocalConfigKeyResolver provides keys that are stored locally and protected by a single KMS key. MacKeyManager [jvm]@Singletonclass MacKeyManager : MappedKeyManager<Mac> Holds a map of every Mac key name to its primitive listed in the configuration for this app. MappedKeyManager [jvm]sealed class MappedKeyManager<KeyT> MiskAWSKMS [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class MiskAWSKMSThis annotation is used to specify which com.amazonaws.services.kms.AWSKMS instance should be used by misk to construct a KmsClient and communicate with the KMS service MiskKmsClient [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class MiskKmsClientThis annotation is used to specify the KmsClient that\u2019s being used by misk to load encryption keys PgpDecrypterManager [jvm]@Singletonclass PgpDecrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpDecrypter> Holds a map of every PgpDecrypter key name to its primitive listed in the configuration for this app. PgpEncrypterManager [jvm]@Singletonclass PgpEncrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpEncrypter> Holds a map of every PgpEncrypter key name to its primitive listed in the configuration for this app. S3KeySource [jvm]class S3KeySource@Injectconstructor(deployment: Deployment, defaultS3: AmazonS3, val allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider) : ExternalKeySourceS3KeySource implements an ExternalKeySource that fetches Tink keysets from an S3 bucket. Keysets are indexed by an alias and a region, and are encrypted with a key in the KMS using an envelope key encryption scheme. Each Keyset is protected by a KMS key in each service region. ServiceKeys [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])annotation class ServiceKeysThis annotation is used to decorate the collection of service keys used in the service. StreamingAeadKeyManager [jvm]@Singletonclass StreamingAeadKeyManager@Injectconstructor(injector: Injector) : MappedKeyManager<StreamingAead> Holds a map of every StreamingAead key name to its primitive listed in the configuration for this app."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/#functions","title":"Functions","text":"Name Summary computeMac [jvm]fun Mac.computeMac(data: String): StringExtension function for conveniently computing an HMAC and encoding it with Base64. verifyMac [jvm]fun Mac.verifyMac(tag: String, data: String)Extension function for conveniently verifying a message\u2019s authenticity. This function expects the tag string variable to contain a Base64 encoded array of bytes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/compute-mac/","title":"computeMac - Misk","text":"//misk-crypto/misk.crypto/computeMac
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/compute-mac/#computemac","title":"computeMac","text":"[jvm]\\ fun Mac.computeMac(data: String): String
Extension function for conveniently computing an HMAC and encoding it with Base64.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/verify-mac/","title":"verifyMac - Misk","text":"//misk-crypto/misk.crypto/verifyMac
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/verify-mac/#verifymac","title":"verifyMac","text":"[jvm]\\ fun Mac.verifyMac(tag: String, data: String)
Extension function for conveniently verifying a message\u2019s authenticity. This function expects the tag string variable to contain a Base64 encoded array of bytes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aead-key-manager/","title":"AeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/AeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aead-key-manager/#aeadkeymanager","title":"AeadKeyManager","text":"[jvm]\\ @Singleton
class AeadKeyManager : MappedKeyManager<Aead>
Holds a map of every Aead key name to its primitive listed in the configuration for this app.
Users may use this object to obtain an Aead dynamically:
val myKey: Aead = aeadKeyManager[\"myKey\"]\nNote: Aead instances provided by this module are envelope Aead instances. This means that all data is encrypted with an ephemeral data encryption key (DEK), which is then protected by a key-encryption key (KEK) and stored inline with ciphertext. This effectively means that ciphertext will be a bit larger than the plaintext, and that migrating keys (KEKs) should not require the re-encryption of stored data.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aead-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): Aead"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/","title":"AwsKmsClientModule - Misk","text":"//misk-crypto/misk.crypto/AwsKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/#awskmsclientmodule","title":"AwsKmsClientModule","text":"[jvm]\\ class AwsKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModule
AWS specific KMS client module. Currently uses a file path to a JSON credentials file to initialize the client. If no file is provided, tries to initialize the client using the default credentials path as specified in AwsKmsClient.withDefaultCredentials
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/#constructors","title":"Constructors","text":"AwsKmsClientModule [jvm]@JvmOverloadsconstructor(credentialsPath: String? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) getKmsClient [jvm]@Provides@Singletonfun getKmsClient(): KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/-aws-kms-client-module/","title":"AwsKmsClientModule - Misk","text":"//misk-crypto/misk.crypto/AwsKmsClientModule/AwsKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/-aws-kms-client-module/#awskmsclientmodule","title":"AwsKmsClientModule","text":"[jvm]\\
@JvmOverloads
constructor(credentialsPath: String? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/get-kms-client/","title":"getKmsClient - Misk","text":"//misk-crypto/misk.crypto/AwsKmsClientModule/getKmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-aws-kms-client-module/get-kms-client/#getkmsclient","title":"getKmsClient","text":"[jvm]\\
@Provides
@Singleton
fun getKmsClient(): KmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/","title":"BucketNameSource - Misk","text":"//misk-crypto/misk.crypto/BucketNameSource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/#bucketnamesource","title":"BucketNameSource","text":"[jvm]\\ interface BucketNameSource
Bind this to an instance to control how external buckets are referenced.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/#functions","title":"Functions","text":"Name Summary getBucketName [jvm]abstract fun getBucketName(deployment: Deployment): StringName of the bucket that stores keys getBucketRegion [jvm]open fun getBucketRegion(deployment: Deployment): String?The region that the bucket lives in."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-name/","title":"getBucketName - Misk","text":"//misk-crypto/misk.crypto/BucketNameSource/getBucketName
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-name/#getbucketname","title":"getBucketName","text":"[jvm]\\ abstract fun getBucketName(deployment: Deployment): String
Name of the bucket that stores keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-region/","title":"getBucketRegion - Misk","text":"//misk-crypto/misk.crypto/BucketNameSource/getBucketRegion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-bucket-name-source/get-bucket-region/#getbucketregion","title":"getBucketRegion","text":"[jvm]\\ open fun getBucketRegion(deployment: Deployment): String?
The region that the bucket lives in.
Returns null for same region as the service.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/","title":"CiphertextFormat - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/#ciphertextformat","title":"CiphertextFormat","text":"[jvm]\\ class CiphertextFormat
Wraps a ciphertext and the encryption context associated with it in a ByteArray.
Misk uses Tink to encrypt data, which uses Encryption Context (EC), or Additional Authentication Data (AAD) to authenticate ciphertext. This class introduces a new, higher level abstraction, that\u2019ll be used instead of the AAD byte array interfaces Tink exposes to users. The main reasons to do this are:
Map<String, String>[ AAD:\n[ varint: pair count ]\n [ pairs:\n ( [ varint: key length ] [ ByteArray: key ]\n [ varint: value length ] [ ByteArray: value ]\n )*\n ]\n]\nThe final output will be serialized using the following format:
[ 0xEE: magic+version ]\n[ varint: AAD length ]\n[ AAD ]\n[ tink ciphertext ]\nFor the full documentation of the CiphertextFormat serialization, read FORMAT.md
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion EncryptionContextMismatchException [jvm]class EncryptionContextMismatchException(message: String) : GeneralSecurityException InvalidCiphertextFormatException [jvm]class InvalidCiphertextFormatException(message: String) : GeneralSecurityException InvalidEncryptionContextException [jvm]class InvalidEncryptionContextException(message: String) : GeneralSecurityException MissingEncryptionContextException [jvm]class MissingEncryptionContextException : GeneralSecurityException UnexpectedEncryptionContextException [jvm]class UnexpectedEncryptionContextException : GeneralSecurityException"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/#properties","title":"Properties","text":"Name Summary CURRENT_VERSION [jvm]const val CURRENT_VERSION: Int = 238Current version of the encryption packet schema"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/#functions","title":"Functions","text":"Name Summary deserializeFleFormat [jvm]fun deserializeFleFormat(serialized: ByteArray): Pair<ByteArray, Map<String, String?>>Extracts the ciphertext and encryption context from the serialized ByteArray."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/-c-u-r-r-e-n-t_-v-e-r-s-i-o-n/","title":"CURRENT_VERSION - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/Companion/CURRENT_VERSION
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/-c-u-r-r-e-n-t_-v-e-r-s-i-o-n/#current_version","title":"CURRENT_VERSION","text":"[jvm]\\ const val CURRENT_VERSION: Int = 238
Current version of the encryption packet schema
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/deserialize-fle-format/","title":"deserializeFleFormat - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/Companion/deserializeFleFormat
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-companion/deserialize-fle-format/#deserializefleformat","title":"deserializeFleFormat","text":"[jvm]\\ fun deserializeFleFormat(serialized: ByteArray): Pair<ByteArray, Map<String, String?>>
Extracts the ciphertext and encryption context from the serialized ByteArray.
This method is meant to be used with field-level-encryption in Hibernate only.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/","title":"EncryptionContextMismatchException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/EncryptionContextMismatchException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#encryptioncontextmismatchexception","title":"EncryptionContextMismatchException","text":"[jvm]\\ class EncryptionContextMismatchException(message: String) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#constructors","title":"Constructors","text":"EncryptionContextMismatchException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/-encryption-context-mismatch-exception/","title":"EncryptionContextMismatchException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/EncryptionContextMismatchException/EncryptionContextMismatchException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-encryption-context-mismatch-exception/-encryption-context-mismatch-exception/#encryptioncontextmismatchexception","title":"EncryptionContextMismatchException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/","title":"InvalidCiphertextFormatException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidCiphertextFormatException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#invalidciphertextformatexception","title":"InvalidCiphertextFormatException","text":"[jvm]\\ class InvalidCiphertextFormatException(message: String) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#constructors","title":"Constructors","text":"InvalidCiphertextFormatException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/-invalid-ciphertext-format-exception/","title":"InvalidCiphertextFormatException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidCiphertextFormatException/InvalidCiphertextFormatException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-ciphertext-format-exception/-invalid-ciphertext-format-exception/#invalidciphertextformatexception","title":"InvalidCiphertextFormatException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/","title":"InvalidEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#invalidencryptioncontextexception","title":"InvalidEncryptionContextException","text":"[jvm]\\ class InvalidEncryptionContextException(message: String) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#constructors","title":"Constructors","text":"InvalidEncryptionContextException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/-invalid-encryption-context-exception/","title":"InvalidEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/InvalidEncryptionContextException/InvalidEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-invalid-encryption-context-exception/-invalid-encryption-context-exception/#invalidencryptioncontextexception","title":"InvalidEncryptionContextException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/","title":"MissingEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/MissingEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#missingencryptioncontextexception","title":"MissingEncryptionContextException","text":"[jvm]\\ class MissingEncryptionContextException : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#constructors","title":"Constructors","text":"MissingEncryptionContextException [jvm]constructor()"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/-missing-encryption-context-exception/","title":"MissingEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/MissingEncryptionContextException/MissingEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-missing-encryption-context-exception/-missing-encryption-context-exception/#missingencryptioncontextexception","title":"MissingEncryptionContextException","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/","title":"UnexpectedEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/UnexpectedEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#unexpectedencryptioncontextexception","title":"UnexpectedEncryptionContextException","text":"[jvm]\\ class UnexpectedEncryptionContextException : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#constructors","title":"Constructors","text":"UnexpectedEncryptionContextException [jvm]constructor()"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/-unexpected-encryption-context-exception/","title":"UnexpectedEncryptionContextException - Misk","text":"//misk-crypto/misk.crypto/CiphertextFormat/UnexpectedEncryptionContextException/UnexpectedEncryptionContextException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-ciphertext-format/-unexpected-encryption-context-exception/-unexpected-encryption-context-exception/#unexpectedencryptioncontextexception","title":"UnexpectedEncryptionContextException","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/","title":"CryptoConfig - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/#cryptoconfig","title":"CryptoConfig","text":"[jvm]\\ data class CryptoConfig@JvmOverloadsconstructor(val keys: List<Key>?, val kms_uri: String, val external_data_keys: Map<KeyAlias, KeyType>? = null) : Config
Main configuration object representing to be used in the app.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/#constructors","title":"Constructors","text":"CryptoConfig [jvm]@JvmOverloadsconstructor(keys: List<Key>?, kms_uri: String, external_data_keys: Map<KeyAlias, KeyType>? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/#properties","title":"Properties","text":"Name Summary external_data_keys [jvm]val external_data_keys: Map<KeyAlias, KeyType>? = nullThe key references (map of alias to type) of keys we want to use that are loaded from an external key source, such as an S3 bucket. keys [jvm]val keys: List<Key>? kms_uri [jvm]val kms_uri: StringThe KMS\u2019 key URI. For GCP users that may look like:gcp-kms://projects/<project>/locations/<location>/keyRings/<keyRing>/cryptoKeys/<key> For AWS users the Key URI looks like: aws-kms://arn:aws:kms:<region>:<account-id>:key/<key-id>"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/-crypto-config/","title":"CryptoConfig - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/CryptoConfig
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/-crypto-config/#cryptoconfig","title":"CryptoConfig","text":"[jvm]\\
@JvmOverloads
constructor(keys: List<Key>?, kms_uri: String, external_data_keys: Map<KeyAlias, KeyType>? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/external_data_keys/","title":"external_data_keys - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/external_data_keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/external_data_keys/#external_data_keys","title":"external_data_keys","text":"[jvm]\\ val external_data_keys: Map<KeyAlias, KeyType>? = null
The key references (map of alias to type) of keys we want to use that are loaded from an external key source, such as an S3 bucket.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/keys/","title":"keys - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/keys/#keys","title":"keys","text":"[jvm]\\ val keys: List<Key>?
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/kms_uri/","title":"kms_uri - Misk","text":"//misk-crypto/misk.crypto/CryptoConfig/kms_uri
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-config/kms_uri/#kms_uri","title":"kms_uri","text":"[jvm]\\ val kms_uri: String
The KMS\u2019 key URI. For GCP users that may look like: gcp-kms://projects/<project>/locations/<location>/keyRings/<keyRing>/cryptoKeys/<key> For AWS users the Key URI looks like: aws-kms://arn:aws:kms:<region>:<account-id>:key/<key-id>
//misk-crypto/misk.crypto/CryptoModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/#cryptomodule","title":"CryptoModule","text":"[jvm]\\ class CryptoModule(config: CryptoConfig) : KAbstractModule
Configures and registers the keys listed in the configuration file. Each key is read, decrypted, and then bound via Google Guice and added to a MappedKeyManager.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/#constructors","title":"Constructors","text":"CryptoModule [jvm]constructor(config: CryptoConfig)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/-crypto-module/","title":"CryptoModule - Misk","text":"//misk-crypto/misk.crypto/CryptoModule/CryptoModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-crypto-module/-crypto-module/#cryptomodule","title":"CryptoModule","text":"[jvm]\\ constructor(config: CryptoConfig)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-deterministic-aead-key-manager/","title":"DeterministicAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/DeterministicAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-deterministic-aead-key-manager/#deterministicaeadkeymanager","title":"DeterministicAeadKeyManager","text":"[jvm]\\ @Singleton
class DeterministicAeadKeyManager : MappedKeyManager<DeterministicAead>
Holds a map of every DeterministicAead key name to its primitive listed in the configuration for this app.
Users may use this object to obtain an DeterministicAead dynamically:
val myKey: DeterministicAead = deterministicAeadKeyManager[\"myKey\"]\nNote that DeterministicAead objects do not provide secrecy to the same level as AEAD do, since multiple plaintexts encrypted with the same key will produce identical ciphertext. This behavior is desirable when querying data via its ciphertext (i.e. equality will hold), but an attacker can detect repeated plaintexts.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-deterministic-aead-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): DeterministicAead"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/","title":"DigitalSignature - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/#digitalsignature","title":"DigitalSignature","text":"[jvm]\\ data class DigitalSignature(val signer: PublicKeySign, val verifier: PublicKeyVerify)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/#constructors","title":"Constructors","text":"DigitalSignature [jvm]constructor(signer: PublicKeySign, verifier: PublicKeyVerify)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/#properties","title":"Properties","text":"Name Summary signer [jvm]val signer: PublicKeySign verifier [jvm]val verifier: PublicKeyVerify"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/-digital-signature/","title":"DigitalSignature - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature/DigitalSignature
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/-digital-signature/#digitalsignature","title":"DigitalSignature","text":"[jvm]\\ constructor(signer: PublicKeySign, verifier: PublicKeyVerify)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/signer/","title":"signer - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature/signer
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/signer/#signer","title":"signer","text":"[jvm]\\ val signer: PublicKeySign
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/verifier/","title":"verifier - Misk","text":"//misk-crypto/misk.crypto/DigitalSignature/verifier
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature/verifier/#verifier","title":"verifier","text":"[jvm]\\ val verifier: PublicKeyVerify
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/","title":"DigitalSignatureKeyManager - Misk","text":"//misk-crypto/misk.crypto/DigitalSignatureKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/#digitalsignaturekeymanager","title":"DigitalSignatureKeyManager","text":"[jvm]\\ @Singleton
class DigitalSignatureKeyManager : MappedKeyManager<DigitalSignature>
Holds a map of every key name to its corresponding PublicKeySign and PublicKeyVerify primitives.
Users may use this class to obtain a PublicKeySign to sign data or PublicKeyVerify to verify the integrity of a message dynamically:
val signer: PublicKeySign = keyManager.getSigner(\"myDigitalSignatureKey\")\nval verifier: PublicKeyVerify = keyManager.getVerifier(\"mySigitalSignatureKey\")\nval signature = signer.sign(data)\nverifier.verify(signature, data)\n//misk-crypto/misk.crypto/DigitalSignatureKeyManager/getSigner
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/get-signer/#getsigner","title":"getSigner","text":"[jvm]\\ fun getSigner(name: String): PublicKeySign
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/get-verifier/","title":"getVerifier - Misk","text":"//misk-crypto/misk.crypto/DigitalSignatureKeyManager/getVerifier
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-digital-signature-key-manager/get-verifier/#getverifier","title":"getVerifier","text":"[jvm]\\ fun getVerifier(name: String): PublicKeyVerify
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-data-keys/","title":"ExternalDataKeys - Misk","text":"//misk-crypto/misk.crypto/ExternalDataKeys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-data-keys/#externaldatakeys","title":"ExternalDataKeys","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class ExternalDataKeys
This annotation is used to decorate the collection of external data keys used in the service.
External data keys are defined in the configuration as a Map<KeyAlias, KeyType>.
This annotation can be useful for cases where one would need access to all external data keys available to the service.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/","title":"ExternalKeyManagerException - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyManagerException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#externalkeymanagerexception","title":"ExternalKeyManagerException","text":"[jvm]\\ class ExternalKeyManagerException(message: String) : IOException
Thrown on creation if external key does not exist.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#constructors","title":"Constructors","text":"ExternalKeyManagerException [jvm]constructor(message: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/-external-key-manager-exception/","title":"ExternalKeyManagerException - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyManagerException/ExternalKeyManagerException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-manager-exception/-external-key-manager-exception/#externalkeymanagerexception","title":"ExternalKeyManagerException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/","title":"ExternalKeyResolver - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#externalkeyresolver","title":"ExternalKeyResolver","text":"[jvm]\\ class ExternalKeyResolver@Injectconstructor(val allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>) : KeyResolver
ExternalKeyResolver implements an KeyResolver that fetches Tink keysets from an external source, such as an S3 bucket. If multiple sources are registered (by binding implementations of KeyResolver), the first one to contain the key (via ExternalKeySource.keyExists) is the key that is used.
If a key is not found, an ExternalKeyManagerException exception is raised.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#constructors","title":"Constructors","text":"ExternalKeyResolver [jvm]@Injectconstructor(allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]open override val allKeyAliases: Map<KeyAlias, KeyType>All resolved key aliases and their respective KeyTypes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/#functions","title":"Functions","text":"Name Summary getKeyByAlias [jvm]open override fun getKeyByAlias(alias: KeyAlias): Key?Fetch and return a Key (includes contents, type and a KMS ARN) by its alias."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-external-key-resolver/","title":"ExternalKeyResolver - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/ExternalKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-external-key-resolver/#externalkeyresolver","title":"ExternalKeyResolver","text":"[jvm]\\
@Inject
constructor(allKeyAliases: Map<KeyAlias, KeyType>, externalKeySources: Set<ExternalKeySource>)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ open override val allKeyAliases: Map<KeyAlias, KeyType>
All resolved key aliases and their respective KeyTypes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/get-key-by-alias/","title":"getKeyByAlias - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/getKeyByAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/get-key-by-alias/#getkeybyalias","title":"getKeyByAlias","text":"[jvm]\\ open override fun getKeyByAlias(alias: KeyAlias): Key?
Fetch and return a Key (includes contents, type and a KMS ARN) by its alias.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/ExternalKeyResolver/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-resolver/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/","title":"ExternalKeySource - Misk","text":"//misk-crypto/misk.crypto/ExternalKeySource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/#externalkeysource","title":"ExternalKeySource","text":"interface ExternalKeySource
Implement an ExternalKeySource to provide Tink keysets from an external location, such as an S3 bucket or an NFS share.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/#inheritors","title":"Inheritors","text":"S3KeySource"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/#functions","title":"Functions","text":"Name Summary getKey [jvm]abstract fun getKey(alias: KeyAlias): Key?Return a Key from an external key source. keyExists [jvm]abstract fun keyExists(alias: KeyAlias): BooleanCheck if a key alias exists in the key source."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/get-key/","title":"getKey - Misk","text":"//misk-crypto/misk.crypto/ExternalKeySource/getKey
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/get-key/#getkey","title":"getKey","text":"[jvm]\\ abstract fun getKey(alias: KeyAlias): Key?
Return a Key from an external key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/key-exists/","title":"keyExists - Misk","text":"//misk-crypto/misk.crypto/ExternalKeySource/keyExists
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-external-key-source/key-exists/#keyexists","title":"keyExists","text":"[jvm]\\ abstract fun keyExists(alias: KeyAlias): Boolean
Check if a key alias exists in the key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/","title":"GcpKmsClientModule - Misk","text":"//misk-crypto/misk.crypto/GcpKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/#gcpkmsclientmodule","title":"GcpKmsClientModule","text":"[jvm]\\ class GcpKmsClientModule@JvmOverloadsconstructor(credentialsPath: String? = null) : KAbstractModule
GCP specific KMS client module. Uses a file path to a JSON credentials file to initialize the client.
//misk-crypto/misk.crypto/GcpKmsClientModule/GcpKmsClientModule
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/-gcp-kms-client-module/#gcpkmsclientmodule","title":"GcpKmsClientModule","text":"[jvm]\\
@JvmOverloads
constructor(credentialsPath: String? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/get-kms-client/","title":"getKmsClient - Misk","text":"//misk-crypto/misk.crypto/GcpKmsClientModule/getKmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-gcp-kms-client-module/get-kms-client/#getkmsclient","title":"getKmsClient","text":"[jvm]\\
@Provides
@Singleton
fun getKmsClient(): KmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-decrypt-key-manager/","title":"HybridDecryptKeyManager - Misk","text":"//misk-crypto/misk.crypto/HybridDecryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-decrypt-key-manager/#hybriddecryptkeymanager","title":"HybridDecryptKeyManager","text":"[jvm]\\ @Singleton
class HybridDecryptKeyManager : MappedKeyManager<HybridDecrypt>
Holds a map of every HybridDecrypt key name to its corresponding primitive listed in the configuration for this app.
Users may this class to obtain a HybridDecrypt object dynamically:
val hybridDecrypt: HybridDecrypt = hybridKeyManager[\"myHybridKey\"]\n//misk-crypto/misk.crypto/HybridEncryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-encrypt-key-manager/#hybridencryptkeymanager","title":"HybridEncryptKeyManager","text":"[jvm]\\ @Singleton
class HybridEncryptKeyManager : MappedKeyManager<HybridEncrypt>
Holds a map of every HybridEncrypt key name to its corresponding primitive listed in the configuration for this app.
Users may use this class to obtain a HybridEncrypt object dynamically:
val hybridEncrypt: HybridEncrypt = hybridKeyManager[\"myHybridKey\"]\nNote: Hybrid encryption is intentionally divided to 2 separate key managers, HybridEncryptKeyManager and HybridDecryptKeyManager, so that the public portion of the keyset could be exported to other services. This configuration helps achieve the goal of allowing some services to encrypt only and other services to both encrypt and decrypt.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-hybrid-encrypt-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): HybridEncrypt"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/","title":"Key - Misk","text":"//misk-crypto/misk.crypto/Key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/#key","title":"Key","text":"[jvm]\\ data class Key@JvmOverloadsconstructor(val key_name: String, val key_type: KeyType, val encrypted_key: Secret<String>? = null, val kms_uri: String? = null) : Config
Describes a specific key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/#constructors","title":"Constructors","text":"Key [jvm]@JvmOverloadsconstructor(key_name: String, key_type: KeyType, encrypted_key: Secret<String>? = null, kms_uri: String? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/#properties","title":"Properties","text":"Name Summary encrypted_key [jvm]val encrypted_key: Secret<String>? = nullIn config it\u2019s the path to a file containing the encrypted key material in Tink\u2019s JSON format. However MiskConfig will read the contents of the file, so this variable is the file\u2019s contents. key_name [jvm]val key_name: StringDescriptive short string for the key. This name will be used when injecting the corresponding key object in the app, like: key_type [jvm]val key_type: KeyTypeType of Tink primitive to initialize. kms_uri [jvm]val kms_uri: String? = nullA key-specific, and region-specific KMS uri that was used to encrypt this key."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/-key/","title":"Key - Misk","text":"//misk-crypto/misk.crypto/Key/Key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/-key/#key","title":"Key","text":"[jvm]\\
@JvmOverloads
constructor(key_name: String, key_type: KeyType, encrypted_key: Secret<String>? = null, kms_uri: String? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/encrypted_key/","title":"encrypted_key - Misk","text":"//misk-crypto/misk.crypto/Key/encrypted_key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/encrypted_key/#encrypted_key","title":"encrypted_key","text":"[jvm]\\ val encrypted_key: Secret<String>? = null
In config it\u2019s the path to a file containing the encrypted key material in Tink\u2019s JSON format. However MiskConfig will read the contents of the file, so this variable is the file\u2019s contents.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/key_name/","title":"key_name - Misk","text":"//misk-crypto/misk.crypto/Key/key_name
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/key_name/#key_name","title":"key_name","text":"[jvm]\\ val key_name: String
Descriptive short string for the key. This name will be used when injecting the corresponding key object in the app, like:
@Inject @Named(\"keyName\") lateinit var myKey: Aead\n//misk-crypto/misk.crypto/Key/key_type
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/key_type/#key_type","title":"key_type","text":"[jvm]\\ val key_type: KeyType
Type of Tink primitive to initialize.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/kms_uri/","title":"kms_uri - Misk","text":"//misk-crypto/misk.crypto/Key/kms_uri
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key/kms_uri/#kms_uri","title":"kms_uri","text":"[jvm]\\ val kms_uri: String? = null
A key-specific, and region-specific KMS uri that was used to encrypt this key.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-alias/","title":"KeyAlias - Misk","text":"//misk-crypto/misk.crypto/KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-alias/#keyalias","title":"KeyAlias","text":"[jvm]\\ typealias KeyAlias = String
A KeyAlias is how we refer to a Tink keyset.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/","title":"KeyNotFoundException - Misk","text":"//misk-crypto/misk.crypto/KeyNotFoundException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#keynotfoundexception","title":"KeyNotFoundException","text":"[jvm]\\ class KeyNotFoundException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : GeneralSecurityException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#constructors","title":"Constructors","text":"KeyNotFoundException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/-key-not-found-exception/","title":"KeyNotFoundException - Misk","text":"//misk-crypto/misk.crypto/KeyNotFoundException/KeyNotFoundException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-not-found-exception/-key-not-found-exception/#keynotfoundexception","title":"KeyNotFoundException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/","title":"KeyReader - Misk","text":"//misk-crypto/misk.crypto/KeyReader
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#keyreader","title":"KeyReader","text":"open class KeyReader
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#inheritors","title":"Inheritors","text":"AeadEnvelopeProvider DeterministicAeadProvider MacProvider DigitalSignatureSignerProvider DigitalSignatureVerifierProvider HybridEncryptProvider HybridDecryptProvider StreamingAeadProvider PgpDecrypterProvider PgpEncrypterProvider"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#constructors","title":"Constructors","text":"KeyReader [jvm]constructor()"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#properties","title":"Properties","text":"Name Summary keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/#functions","title":"Functions","text":"Name Summary readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-key-reader/","title":"KeyReader - Misk","text":"//misk-crypto/misk.crypto/KeyReader/KeyReader
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-key-reader/#keyreader","title":"KeyReader","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/key-sources/","title":"keySources - Misk","text":"//misk-crypto/misk.crypto/KeyReader/keySources
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/key-sources/#keysources","title":"keySources","text":"[jvm]\\
@Inject
lateinit var keySources: Set<KeyResolver>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/kms-client/","title":"kmsClient - Misk","text":"//misk-crypto/misk.crypto/KeyReader/kmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/kms-client/#kmsclient","title":"kmsClient","text":"[jvm]\\
@Inject
lateinit var kmsClient: KmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/read-key/","title":"readKey - Misk","text":"//misk-crypto/misk.crypto/KeyReader/readKey
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/read-key/#readkey","title":"readKey","text":"[jvm]\\ fun readKey(alias: KeyAlias): KeysetHandle
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/KeyReader/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/#properties","title":"Properties","text":"Name Summary KEK_TEMPLATE [jvm]val KEK_TEMPLATE: KeyTemplate"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/-k-e-k_-t-e-m-p-l-a-t-e/","title":"KEK_TEMPLATE - Misk","text":"//misk-crypto/misk.crypto/KeyReader/Companion/KEK_TEMPLATE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-reader/-companion/-k-e-k_-t-e-m-p-l-a-t-e/#kek_template","title":"KEK_TEMPLATE","text":"[jvm]\\ val KEK_TEMPLATE: KeyTemplate
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/","title":"KeyResolver - Misk","text":"//misk-crypto/misk.crypto/KeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#keyresolver","title":"KeyResolver","text":"interface KeyResolver
KeyResolver provides an interface to access keys indexed by aliases. Optionally, callers can register a callback to be invoked when a key is updated.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#inheritors","title":"Inheritors","text":"ExternalKeyResolver LocalConfigKeyResolver"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]abstract val allKeyAliases: Map<KeyAlias, KeyType>All resolved key aliases and their respective KeyTypes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/#functions","title":"Functions","text":"Name Summary getKeyByAlias [jvm]abstract fun getKeyByAlias(alias: KeyAlias): Key?Fetch and return a Key (includes contents, type and a KMS ARN) by its alias."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/KeyResolver/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ abstract val allKeyAliases: Map<KeyAlias, KeyType>
All resolved key aliases and their respective KeyTypes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/get-key-by-alias/","title":"getKeyByAlias - Misk","text":"//misk-crypto/misk.crypto/KeyResolver/getKeyByAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-resolver/get-key-by-alias/#getkeybyalias","title":"getKeyByAlias","text":"[jvm]\\ abstract fun getKeyByAlias(alias: KeyAlias): Key?
Fetch and return a Key (includes contents, type and a KMS ARN) by its alias.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/","title":"KeyType - Misk","text":"//misk-crypto/misk.crypto/KeyType
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#keytype","title":"KeyType","text":"[jvm]\\ enum KeyType : Enum<KeyType>
Supported key types
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#entries","title":"Entries","text":"AEAD [jvm]AEAD DAEAD [jvm]DAEAD MAC [jvm]MAC DIGITAL_SIGNATURE [jvm]DIGITAL_SIGNATURE HYBRID_ENCRYPT [jvm]HYBRID_ENCRYPT HYBRID_ENCRYPT_DECRYPT [jvm]HYBRID_ENCRYPT_DECRYPT STREAMING_AEAD [jvm]STREAMING_AEAD PGP_DECRYPT [jvm]PGP_DECRYPT PGP_ENCRYPT [jvm]PGP_ENCRYPT SIGNATURE [jvm]SIGNATUREAlias for DIGITAL_SIGNATURE."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<KeyType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): KeyTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<KeyType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/entries/","title":"entries - Misk","text":"//misk-crypto/misk.crypto/KeyType/entries
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<KeyType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/value-of/","title":"valueOf - Misk","text":"//misk-crypto/misk.crypto/KeyType/valueOf
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): KeyType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/values/","title":"values - Misk","text":"//misk-crypto/misk.crypto/KeyType/values
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<KeyType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-a-e-a-d/","title":"AEAD - Misk","text":"//misk-crypto/misk.crypto/KeyType/AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-a-e-a-d/#aead","title":"AEAD","text":"[jvm]\\ AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-a-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-a-e-a-d/","title":"DAEAD - Misk","text":"//misk-crypto/misk.crypto/KeyType/DAEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-a-e-a-d/#daead","title":"DAEAD","text":"[jvm]\\ DAEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-a-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-i-g-i-t-a-l_-s-i-g-n-a-t-u-r-e/","title":"DIGITAL_SIGNATURE - Misk","text":"//misk-crypto/misk.crypto/KeyType/DIGITAL_SIGNATURE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-i-g-i-t-a-l_-s-i-g-n-a-t-u-r-e/#digital_signature","title":"DIGITAL_SIGNATURE","text":"[jvm]\\ DIGITAL_SIGNATURE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-d-i-g-i-t-a-l_-s-i-g-n-a-t-u-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t/","title":"HYBRID_ENCRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/HYBRID_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t/#hybrid_encrypt","title":"HYBRID_ENCRYPT","text":"[jvm]\\ HYBRID_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t_-d-e-c-r-y-p-t/","title":"HYBRID_ENCRYPT_DECRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/HYBRID_ENCRYPT_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t_-d-e-c-r-y-p-t/#hybrid_encrypt_decrypt","title":"HYBRID_ENCRYPT_DECRYPT","text":"[jvm]\\ HYBRID_ENCRYPT_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-h-y-b-r-i-d_-e-n-c-r-y-p-t_-d-e-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-m-a-c/","title":"MAC - Misk","text":"//misk-crypto/misk.crypto/KeyType/MAC
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-m-a-c/#mac","title":"MAC","text":"[jvm]\\ MAC
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-m-a-c/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-d-e-c-r-y-p-t/","title":"PGP_DECRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/PGP_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-d-e-c-r-y-p-t/#pgp_decrypt","title":"PGP_DECRYPT","text":"[jvm]\\ PGP_DECRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-d-e-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-e-n-c-r-y-p-t/","title":"PGP_ENCRYPT - Misk","text":"//misk-crypto/misk.crypto/KeyType/PGP_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-e-n-c-r-y-p-t/#pgp_encrypt","title":"PGP_ENCRYPT","text":"[jvm]\\ PGP_ENCRYPT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-p-g-p_-e-n-c-r-y-p-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-i-g-n-a-t-u-r-e/","title":"SIGNATURE - Misk","text":"//misk-crypto/misk.crypto/KeyType/SIGNATURE
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-i-g-n-a-t-u-r-e/#signature","title":"SIGNATURE","text":"[jvm]\\ SIGNATURE
Alias for DIGITAL_SIGNATURE.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-i-g-n-a-t-u-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-t-r-e-a-m-i-n-g_-a-e-a-d/","title":"STREAMING_AEAD - Misk","text":"//misk-crypto/misk.crypto/KeyType/STREAMING_AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-t-r-e-a-m-i-n-g_-a-e-a-d/#streaming_aead","title":"STREAMING_AEAD","text":"[jvm]\\ STREAMING_AEAD
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-key-type/-s-t-r-e-a-m-i-n-g_-a-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/","title":"LocalConfigKeyResolver - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#localconfigkeyresolver","title":"LocalConfigKeyResolver","text":"[jvm]\\ class LocalConfigKeyResolver(keys: List<Key>, defaultKmsUri: String) : KeyResolver
LocalConfigKeyResolver provides keys that are stored locally and protected by a single KMS key.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#constructors","title":"Constructors","text":"LocalConfigKeyResolver [jvm]constructor(keys: List<Key>, defaultKmsUri: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]open override val allKeyAliases: Map<KeyAlias, KeyType>All resolved key aliases and their respective KeyTypes."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/#functions","title":"Functions","text":"Name Summary getKeyByAlias [jvm]open override fun getKeyByAlias(alias: KeyAlias): Key?Fetch and return a Key (includes contents, type and a KMS ARN) by its alias."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/-local-config-key-resolver/","title":"LocalConfigKeyResolver - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver/LocalConfigKeyResolver
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/-local-config-key-resolver/#localconfigkeyresolver","title":"LocalConfigKeyResolver","text":"[jvm]\\ constructor(keys: List<Key>, defaultKmsUri: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ open override val allKeyAliases: Map<KeyAlias, KeyType>
All resolved key aliases and their respective KeyTypes.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/get-key-by-alias/","title":"getKeyByAlias - Misk","text":"//misk-crypto/misk.crypto/LocalConfigKeyResolver/getKeyByAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-local-config-key-resolver/get-key-by-alias/#getkeybyalias","title":"getKeyByAlias","text":"[jvm]\\ open override fun getKeyByAlias(alias: KeyAlias): Key?
Fetch and return a Key (includes contents, type and a KMS ARN) by its alias.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mac-key-manager/","title":"MacKeyManager - Misk","text":"//misk-crypto/misk.crypto/MacKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mac-key-manager/#mackeymanager","title":"MacKeyManager","text":"[jvm]\\ @Singleton
class MacKeyManager : MappedKeyManager<Mac>
Holds a map of every Mac key name to its primitive listed in the configuration for this app.
Users may use this class to obtain a Mac object dynamically:
val hmac: Mac = macKeyManager[\"myHmac\"]\n//misk-crypto/misk.crypto/MappedKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/#mappedkeymanager","title":"MappedKeyManager","text":"sealed class MappedKeyManager<KeyT>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/#inheritors","title":"Inheritors","text":"AeadKeyManager DeterministicAeadKeyManager MacKeyManager DigitalSignatureKeyManager HybridEncryptKeyManager HybridDecryptKeyManager StreamingAeadKeyManager PgpEncrypterManager PgpDecrypterManager"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): KeyT"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto/MappedKeyManager/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-mapped-key-manager/get/#get","title":"get","text":"[jvm]\\ operator fun get(name: String): KeyT
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-a-w-s-k-m-s/","title":"MiskAWSKMS - Misk","text":"//misk-crypto/misk.crypto/MiskAWSKMS
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-a-w-s-k-m-s/#miskawskms","title":"MiskAWSKMS","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class MiskAWSKMS
This annotation is used to specify which com.amazonaws.services.kms.AWSKMS instance should be used by misk to construct a KmsClient and communicate with the KMS service
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-kms-client/","title":"MiskKmsClient - Misk","text":"//misk-crypto/misk.crypto/MiskKmsClient
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-misk-kms-client/#miskkmsclient","title":"MiskKmsClient","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class MiskKmsClient
This annotation is used to specify the KmsClient that\u2019s being used by misk to load encryption keys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-decrypter-manager/","title":"PgpDecrypterManager - Misk","text":"//misk-crypto/misk.crypto/PgpDecrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-decrypter-manager/#pgpdecryptermanager","title":"PgpDecrypterManager","text":"[jvm]\\ @Singleton
class PgpDecrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpDecrypter>
Holds a map of every PgpDecrypter key name to its primitive listed in the configuration for this app.
val myKey: PgpDecrypter = pgpDecrypterManager[\"myKey\"]\n//misk-crypto/misk.crypto/PgpDecrypterManager/PgpDecrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-decrypter-manager/-pgp-decrypter-manager/#pgpdecryptermanager","title":"PgpDecrypterManager","text":"[jvm]\\
@Inject
constructor(injector: Injector)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-encrypter-manager/","title":"PgpEncrypterManager - Misk","text":"//misk-crypto/misk.crypto/PgpEncrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-encrypter-manager/#pgpencryptermanager","title":"PgpEncrypterManager","text":"[jvm]\\ @Singleton
class PgpEncrypterManager@Injectconstructor(injector: Injector) : MappedKeyManager<PgpEncrypter>
Holds a map of every PgpEncrypter key name to its primitive listed in the configuration for this app.
val myKey: PgpEncrypter = pgpEncrypterManager[\"myKey\"]\n//misk-crypto/misk.crypto/PgpEncrypterManager/PgpEncrypterManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-pgp-encrypter-manager/-pgp-encrypter-manager/#pgpencryptermanager","title":"PgpEncrypterManager","text":"[jvm]\\
@Inject
constructor(injector: Injector)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/","title":"S3KeySource - Misk","text":"//misk-crypto/misk.crypto/S3KeySource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#s3keysource","title":"S3KeySource","text":"[jvm]\\ class S3KeySource@Injectconstructor(deployment: Deployment, defaultS3: AmazonS3, val allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider) : ExternalKeySource
S3KeySource implements an ExternalKeySource that fetches Tink keysets from an S3 bucket. Keysets are indexed by an alias and a region, and are encrypted with a key in the KMS using an envelope key encryption scheme. Each Keyset is protected by a KMS key in each service region.
For example, if we are to load a key aliased by \"example_key\" in the staging environment, we\u2019d expect the following layout:
bucket \u21b3 example_key \u21b3 us-east-1 \u21b3 us-west-2
And the metadata of the region-specified object will contain the KMS key arn that was used to protect it under the key x-amz-meta-kms-key-arn, and the type of the key under x-amz-meta-key-type. These keys are exposed in the S3 api without the x-amz-meta- prefix.
The envelope scheme itself is from misk-crypto and is defined in KeyReader
If a requested key alias does not exist, this will raise a ExternalKeyManagerException
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#constructors","title":"Constructors","text":"S3KeySource [jvm]@Injectconstructor(deployment: Deployment, defaultS3: AmazonS3, allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#properties","title":"Properties","text":"Name Summary allKeyAliases [jvm]val allKeyAliases: Map<KeyAlias, KeyType>"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/#functions","title":"Functions","text":"Name Summary getKey [jvm]open override fun getKey(alias: KeyAlias): KeyReturn a Key from an external key source. keyExists [jvm]open override fun keyExists(alias: KeyAlias): BooleanCheck if a key alias exists in the key source."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-s3-key-source/","title":"S3KeySource - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/S3KeySource
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-s3-key-source/#s3keysource","title":"S3KeySource","text":"[jvm]\\
@Inject
constructor(deployment: Deployment, defaultS3: AmazonS3, allKeyAliases: Map<KeyAlias, KeyType>, bucketNameSource: BucketNameSource = object : BucketNameSource { override fun getBucketName(deployment: Deployment) = deployment.mapToEnvironmentName() }, awsCredentials: AWSCredentialsProvider)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/all-key-aliases/","title":"allKeyAliases - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/allKeyAliases
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/all-key-aliases/#allkeyaliases","title":"allKeyAliases","text":"[jvm]\\ val allKeyAliases: Map<KeyAlias, KeyType>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/get-key/","title":"getKey - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/getKey
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/get-key/#getkey","title":"getKey","text":"[jvm]\\ open override fun getKey(alias: KeyAlias): Key
Return a Key from an external key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/key-exists/","title":"keyExists - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/keyExists
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/key-exists/#keyexists","title":"keyExists","text":"[jvm]\\ open override fun keyExists(alias: KeyAlias): Boolean
Check if a key alias exists in the key source.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-companion/","title":"Companion - Misk","text":"//misk-crypto/misk.crypto/S3KeySource/Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-s3-key-source/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-service-keys/","title":"ServiceKeys - Misk","text":"//misk-crypto/misk.crypto/ServiceKeys
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-service-keys/#servicekeys","title":"ServiceKeys","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER])
annotation class ServiceKeys
This annotation is used to decorate the collection of service keys used in the service.
This annotation can be useful for cases where one would need access to all service keys as a Map<KeyAlias, KeyType>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/","title":"StreamingAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/StreamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/#streamingaeadkeymanager","title":"StreamingAeadKeyManager","text":"[jvm]\\ @Singleton
class StreamingAeadKeyManager@Injectconstructor(injector: Injector) : MappedKeyManager<StreamingAead>
Holds a map of every StreamingAead key name to its primitive listed in the configuration for this app.
Users may use this object to obtain an StreamingAead dynamically:
val myKey: StreamingAead = streamingAeadKeyManager[\"myKey\"]\nNote: StreamingAead is useful when the data to be encrypted is too large to be processed in a single step. Typical use cases include encryption of large files or encryption of live data streams
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/#constructors","title":"Constructors","text":"StreamingAeadKeyManager [jvm]@Injectconstructor(injector: Injector)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/#functions","title":"Functions","text":"Name Summary get [jvm]operator fun get(name: String): StreamingAead"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/-streaming-aead-key-manager/","title":"StreamingAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto/StreamingAeadKeyManager/StreamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto/-streaming-aead-key-manager/-streaming-aead-key-manager/#streamingaeadkeymanager","title":"StreamingAeadKeyManager","text":"[jvm]\\
@Inject
constructor(injector: Injector)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto.internal
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/#types","title":"Types","text":"Name Summary AeadEnvelopeProvider [jvm]class AeadEnvelopeProvider(val key: KeyAlias) : KeyReader, Provider<Aead> We only support AEAD keys via envelope encryption. DeterministicAeadProvider [jvm]class DeterministicAeadProvider(val key: KeyAlias) : KeyReader, Provider<DeterministicAead> DigitalSignatureSignerProvider [jvm]class DigitalSignatureSignerProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeySign> DigitalSignatureVerifierProvider [jvm]class DigitalSignatureVerifierProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeyVerify> HybridDecryptProvider [jvm]class HybridDecryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridDecrypt> HybridEncryptProvider [jvm]class HybridEncryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridEncrypt> MacProvider [jvm]class MacProvider(val key: KeyAlias) : KeyReader, Provider<Mac> StreamingAeadProvider [jvm]class StreamingAeadProvider(val key: KeyAlias) : KeyReader, Provider<StreamingAead>"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/","title":"AeadEnvelopeProvider - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#aeadenvelopeprovider","title":"AeadEnvelopeProvider","text":"[jvm]\\ class AeadEnvelopeProvider(val key: KeyAlias) : KeyReader, Provider<Aead>
We only support AEAD keys via envelope encryption.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#constructors","title":"Constructors","text":"AeadEnvelopeProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: AeadKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Aead readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/-aead-envelope-provider/","title":"AeadEnvelopeProvider - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/AeadEnvelopeProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/-aead-envelope-provider/#aeadenvelopeprovider","title":"AeadEnvelopeProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Aead
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: AeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/AeadEnvelopeProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-aead-envelope-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/","title":"DeterministicAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#deterministicaeadprovider","title":"DeterministicAeadProvider","text":"[jvm]\\ class DeterministicAeadProvider(val key: KeyAlias) : KeyReader, Provider<DeterministicAead>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#constructors","title":"Constructors","text":"DeterministicAeadProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: DeterministicAeadKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): DeterministicAead readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/-deterministic-aead-provider/","title":"DeterministicAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/DeterministicAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/-deterministic-aead-provider/#deterministicaeadprovider","title":"DeterministicAeadProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DeterministicAead
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: DeterministicAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/DeterministicAeadProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-deterministic-aead-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/","title":"DigitalSignatureSignerProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#digitalsignaturesignerprovider","title":"DigitalSignatureSignerProvider","text":"[jvm]\\ class DigitalSignatureSignerProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeySign>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#constructors","title":"Constructors","text":"DigitalSignatureSignerProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: DigitalSignatureKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PublicKeySign readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/-digital-signature-signer-provider/","title":"DigitalSignatureSignerProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/DigitalSignatureSignerProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/-digital-signature-signer-provider/#digitalsignaturesignerprovider","title":"DigitalSignatureSignerProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PublicKeySign
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: DigitalSignatureKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureSignerProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-signer-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/","title":"DigitalSignatureVerifierProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#digitalsignatureverifierprovider","title":"DigitalSignatureVerifierProvider","text":"[jvm]\\ class DigitalSignatureVerifierProvider(val key: KeyAlias) : KeyReader, Provider<PublicKeyVerify>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#constructors","title":"Constructors","text":"DigitalSignatureVerifierProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: DigitalSignatureKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PublicKeyVerify readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/-digital-signature-verifier-provider/","title":"DigitalSignatureVerifierProvider - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/DigitalSignatureVerifierProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/-digital-signature-verifier-provider/#digitalsignatureverifierprovider","title":"DigitalSignatureVerifierProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PublicKeyVerify
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: DigitalSignatureKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/DigitalSignatureVerifierProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-digital-signature-verifier-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/","title":"HybridDecryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#hybriddecryptprovider","title":"HybridDecryptProvider","text":"[jvm]\\ class HybridDecryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridDecrypt>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#constructors","title":"Constructors","text":"HybridDecryptProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyDecryptManager [jvm]@Injectlateinit var keyDecryptManager: HybridDecryptKeyManager keyEncryptManager [jvm]@Injectlateinit var keyEncryptManager: HybridEncryptKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): HybridDecrypt readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/-hybrid-decrypt-provider/","title":"HybridDecryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/HybridDecryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/-hybrid-decrypt-provider/#hybriddecryptprovider","title":"HybridDecryptProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): HybridDecrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-decrypt-manager/","title":"keyDecryptManager - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/keyDecryptManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-decrypt-manager/#keydecryptmanager","title":"keyDecryptManager","text":"[jvm]\\
@Inject
lateinit var keyDecryptManager: HybridDecryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-encrypt-manager/","title":"keyEncryptManager - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/keyEncryptManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key-encrypt-manager/#keyencryptmanager","title":"keyEncryptManager","text":"[jvm]\\
@Inject
lateinit var keyEncryptManager: HybridEncryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/HybridDecryptProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-decrypt-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/","title":"HybridEncryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#hybridencryptprovider","title":"HybridEncryptProvider","text":"[jvm]\\ class HybridEncryptProvider(val key: KeyAlias) : KeyReader, Provider<HybridEncrypt>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#constructors","title":"Constructors","text":"HybridEncryptProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: HybridEncryptKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): HybridEncrypt readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/-hybrid-encrypt-provider/","title":"HybridEncryptProvider - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/HybridEncryptProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/-hybrid-encrypt-provider/#hybridencryptprovider","title":"HybridEncryptProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): HybridEncrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: HybridEncryptKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/HybridEncryptProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-hybrid-encrypt-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/","title":"MacProvider - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#macprovider","title":"MacProvider","text":"[jvm]\\ class MacProvider(val key: KeyAlias) : KeyReader, Provider<Mac>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#constructors","title":"Constructors","text":"MacProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keyManager [jvm]@Injectlateinit var keyManager: MacKeyManager keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): Mac readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/-mac-provider/","title":"MacProvider - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/MacProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/-mac-provider/#macprovider","title":"MacProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): Mac
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key-manager/","title":"keyManager - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/keyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key-manager/#keymanager","title":"keyManager","text":"[jvm]\\
@Inject
lateinit var keyManager: MacKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/MacProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-mac-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/","title":"StreamingAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#streamingaeadprovider","title":"StreamingAeadProvider","text":"[jvm]\\ class StreamingAeadProvider(val key: KeyAlias) : KeyReader, Provider<StreamingAead>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#constructors","title":"Constructors","text":"StreamingAeadProvider [jvm]constructor(key: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#properties","title":"Properties","text":"Name Summary key [jvm]val key: KeyAlias keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient streamingAeadKeyManager [jvm]@Injectlateinit var streamingAeadKeyManager: StreamingAeadKeyManager"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): StreamingAead readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/-streaming-aead-provider/","title":"StreamingAeadProvider - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/StreamingAeadProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/-streaming-aead-provider/#streamingaeadprovider","title":"StreamingAeadProvider","text":"[jvm]\\ constructor(key: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): StreamingAead
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/key/","title":"key - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/key/#key","title":"key","text":"[jvm]\\ val key: KeyAlias
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/streaming-aead-key-manager/","title":"streamingAeadKeyManager - Misk","text":"//misk-crypto/misk.crypto.internal/StreamingAeadProvider/streamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.internal/-streaming-aead-provider/streaming-aead-key-manager/#streamingaeadkeymanager","title":"streamingAeadKeyManager","text":"[jvm]\\
@Inject
lateinit var streamingAeadKeyManager: StreamingAeadKeyManager
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto.pgp
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/#types","title":"Types","text":"Name Summary PgpDecrypter [jvm]interface PgpDecrypterA PgpDecrypter is tied to a private PGP key which it uses to decrypt messages. PgpEncrypter [jvm]interface PgpEncrypterA PgpEncrypter is tied to a public PGP key which it uses to encrypt messages."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/","title":"PgpDecrypter - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpDecrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/#pgpdecrypter","title":"PgpDecrypter","text":"[jvm]\\ interface PgpDecrypter
A PgpDecrypter is tied to a private PGP key which it uses to decrypt messages.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/#functions","title":"Functions","text":"Name Summary decrypt [jvm]abstract fun decrypt(ciphertext: ByteArray): ByteArray"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/decrypt/","title":"decrypt - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpDecrypter/decrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-decrypter/decrypt/#decrypt","title":"decrypt","text":"[jvm]\\ abstract fun decrypt(ciphertext: ByteArray): ByteArray
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/","title":"PgpEncrypter - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpEncrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/#pgpencrypter","title":"PgpEncrypter","text":"[jvm]\\ interface PgpEncrypter
A PgpEncrypter is tied to a public PGP key which it uses to encrypt messages.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/#functions","title":"Functions","text":"Name Summary encrypt [jvm]abstract fun encrypt(plaintext: ByteArray, armored: Boolean): ByteArrayEncrypts the given byte array. Armored refers to whether to output in a text format or not."},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/encrypt/","title":"encrypt - Misk","text":"//misk-crypto/misk.crypto.pgp/PgpEncrypter/encrypt
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp/-pgp-encrypter/encrypt/#encrypt","title":"encrypt","text":"[jvm]\\ abstract fun encrypt(plaintext: ByteArray, armored: Boolean): ByteArray
Encrypts the given byte array. Armored refers to whether to output in a text format or not.
For example, with armored we get output like:
-----BEGIN PGP MESSAGE----- Version: BCPG C# v1.6.1.0
hQIMA0tM4ZUzpKCkAQ//ZO8hVhp6LMxshCLqcqgPkXcU1kBHPQjiUBs6QPxaQFcg PIXJEdZWQ1RkMUKdCfzjvevizi/2NWAwZ797fELdbpVyH6JI2Me1Ov10f8qgYvbG V0GJ3loRt84KjKdVocKguJVfMvOeMVJanPpxfPt3Ak+Nt/voZHmJdTkV4cjWTmcU x31xqc5LZcvgF4Lv+ZcMw090b281yMENwALnvQJ9FQg5WTfZ+YautUMwWGk8W8XM H3tYkdh3jKizy8YTw+zfVDn1yhw2BgSFp0QIgHIQQ2Q2gyknRfj4zdfs/4bZYcu1 KNgj9op/IejZNstP9JWw4labC78nTIW5s1f0LWF5hhZUkxeAOEyVluUVJgEw44B4 LKb0p/8jb4J/dVrsmaTDOONZ48wtNjZOTV61DhCnn+UiNVSfQe6I7XMtFpEH0PN4 WzermmeEgjw1MADeh0jg/9wMM/p9UnTxihGQrPRgHYUu45jI3ys3qArsD2GvAi9y QYqsuRJNB7EEu2clBRASA3zoWkpqbs3H9S2fB9Sf9ZzZTPCzowOdK1oe0vlMVt3A mCILe05s2nowwBrBWu4PHUTkllsnLliHhrihu9sqXCHy6u1pdNQMvJgY6kbgQmsG bVY+brdkLdQ1BxbTT1YixzLm//zqMqGC1ZJUsr5PAIbNtyKK6u6+mCkZj0Y3fU3J Il0x5V09QcC9AHyxJ8VMOxzhQZjwVYNtD6SGeY8jOyfUScY= =DHKq -----END PGP MESSAGE-----
Without the armored encoding we would get binary data which isn\u2019t viewable in text format.
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/","title":"Package-level declarations - Misk","text":"//misk-crypto/misk.crypto.pgp.internal
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/#types","title":"Types","text":"Name Summary PgpDecrypterProvider [jvm]class PgpDecrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpDecrypter> PgpEncrypterProvider [jvm]class PgpEncrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpEncrypter> PgpKeyJsonFile [jvm]data class PgpKeyJsonFile(val region: String, val encrypted_private_key: String, val public_key: String, val pgp: PgpKeyJsonFileMetadata, val aws_kms_key_id: String) PgpKeyJsonFileMetadata [jvm]data class PgpKeyJsonFileMetadata(val name: String, val email: String, val comment: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/","title":"PgpDecrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpDecrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#pgpdecrypterprovider","title":"PgpDecrypterProvider","text":"[jvm]\\ class PgpDecrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpDecrypter>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#constructors","title":"Constructors","text":"PgpDecrypterProvider [jvm]constructor(alias: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#properties","title":"Properties","text":"Name Summary keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PgpDecrypter readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/-pgp-decrypter-provider/","title":"PgpDecrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpDecrypterProvider/PgpDecrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/-pgp-decrypter-provider/#pgpdecrypterprovider","title":"PgpDecrypterProvider","text":"[jvm]\\ constructor(alias: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpDecrypterProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-decrypter-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PgpDecrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/","title":"PgpEncrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpEncrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#pgpencrypterprovider","title":"PgpEncrypterProvider","text":"[jvm]\\ class PgpEncrypterProvider(alias: KeyAlias) : KeyReader, Provider<PgpEncrypter>
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#constructors","title":"Constructors","text":"PgpEncrypterProvider [jvm]constructor(alias: KeyAlias)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#properties","title":"Properties","text":"Name Summary keySources [jvm]@Injectlateinit var keySources: Set<KeyResolver> kmsClient [jvm]@Injectlateinit var kmsClient: KmsClient"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(): PgpEncrypter readKey [jvm]fun readKey(alias: KeyAlias): KeysetHandle"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/-pgp-encrypter-provider/","title":"PgpEncrypterProvider - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpEncrypterProvider/PgpEncrypterProvider
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/-pgp-encrypter-provider/#pgpencrypterprovider","title":"PgpEncrypterProvider","text":"[jvm]\\ constructor(alias: KeyAlias)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/get/","title":"get - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpEncrypterProvider/get
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-encrypter-provider/get/#get","title":"get","text":"[jvm]\\ open override fun get(): PgpEncrypter
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/","title":"PgpKeyJsonFile - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/#pgpkeyjsonfile","title":"PgpKeyJsonFile","text":"[jvm]\\ data class PgpKeyJsonFile(val region: String, val encrypted_private_key: String, val public_key: String, val pgp: PgpKeyJsonFileMetadata, val aws_kms_key_id: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/#constructors","title":"Constructors","text":"PgpKeyJsonFile [jvm]constructor(region: String, encrypted_private_key: String, public_key: String, pgp: PgpKeyJsonFileMetadata, aws_kms_key_id: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/#properties","title":"Properties","text":"Name Summary aws_kms_key_id [jvm]val aws_kms_key_id: String encrypted_private_key [jvm]val encrypted_private_key: String pgp [jvm]val pgp: PgpKeyJsonFileMetadata public_key [jvm]val public_key: String region [jvm]val region: String"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/-pgp-key-json-file/","title":"PgpKeyJsonFile - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/PgpKeyJsonFile
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/-pgp-key-json-file/#pgpkeyjsonfile","title":"PgpKeyJsonFile","text":"[jvm]\\ constructor(region: String, encrypted_private_key: String, public_key: String, pgp: PgpKeyJsonFileMetadata, aws_kms_key_id: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/aws_kms_key_id/","title":"aws_kms_key_id - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/aws_kms_key_id
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/aws_kms_key_id/#aws_kms_key_id","title":"aws_kms_key_id","text":"[jvm]\\ val aws_kms_key_id: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/encrypted_private_key/","title":"encrypted_private_key - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/encrypted_private_key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/encrypted_private_key/#encrypted_private_key","title":"encrypted_private_key","text":"[jvm]\\ val encrypted_private_key: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/pgp/","title":"pgp - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/pgp
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/pgp/#pgp","title":"pgp","text":"[jvm]\\ val pgp: PgpKeyJsonFileMetadata
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/public_key/","title":"public_key - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/public_key
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/public_key/#public_key","title":"public_key","text":"[jvm]\\ val public_key: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/region/","title":"region - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFile/region
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file/region/#region","title":"region","text":"[jvm]\\ val region: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/","title":"PgpKeyJsonFileMetadata - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/#pgpkeyjsonfilemetadata","title":"PgpKeyJsonFileMetadata","text":"[jvm]\\ data class PgpKeyJsonFileMetadata(val name: String, val email: String, val comment: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/#constructors","title":"Constructors","text":"PgpKeyJsonFileMetadata [jvm]constructor(name: String, email: String, comment: String)"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/#properties","title":"Properties","text":"Name Summary comment [jvm]val comment: String email [jvm]val email: String name [jvm]val name: String"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/-pgp-key-json-file-metadata/","title":"PgpKeyJsonFileMetadata - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/PgpKeyJsonFileMetadata
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/-pgp-key-json-file-metadata/#pgpkeyjsonfilemetadata","title":"PgpKeyJsonFileMetadata","text":"[jvm]\\ constructor(name: String, email: String, comment: String)
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/comment/","title":"comment - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/comment
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/comment/#comment","title":"comment","text":"[jvm]\\ val comment: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/email/","title":"email - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/email
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/email/#email","title":"email","text":"[jvm]\\ val email: String
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/name/","title":"name - Misk","text":"//misk-crypto/misk.crypto.pgp.internal/PgpKeyJsonFileMetadata/name
"},{"location":"0.x/misk-crypto/misk-crypto/misk.crypto.pgp.internal/-pgp-key-json-file-metadata/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-datadog/","title":"misk-datadog - Misk","text":"//misk-datadog
"},{"location":"0.x/misk-datadog/#misk-datadog","title":"misk-datadog","text":""},{"location":"0.x/misk-datadog/#packages","title":"Packages","text":"Name com.squareup.cash.tracing.datadog misk.tracing.backends.datadog"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/","title":"Package-level declarations - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/#types","title":"Types","text":"Name Summary MDCScopeListener [jvm]class MDCScopeListenerA scope listener that updates the MDC with the trace and span reference anytime a new scope is activated or closed."},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/","title":"MDCScopeListener - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#mdcscopelistener","title":"MDCScopeListener","text":"[jvm]\\ class MDCScopeListener
A scope listener that updates the MDC with the trace and span reference anytime a new scope is activated or closed.
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#constructors","title":"Constructors","text":"MDCScopeListener [jvm]constructor()"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/#functions","title":"Functions","text":"Name Summary afterScopeActivated [jvm]fun afterScopeActivated() afterScopeClosed [jvm]fun afterScopeClosed()"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-m-d-c-scope-listener/","title":"MDCScopeListener - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/MDCScopeListener
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-m-d-c-scope-listener/#mdcscopelistener","title":"MDCScopeListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-activated/","title":"afterScopeActivated - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/afterScopeActivated
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-activated/#afterscopeactivated","title":"afterScopeActivated","text":"[jvm]\\ fun afterScopeActivated()
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-closed/","title":"afterScopeClosed - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/afterScopeClosed
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/after-scope-closed/#afterscopeclosed","title":"afterScopeClosed","text":"[jvm]\\ fun afterScopeClosed()
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/","title":"Companion - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger MDC_DD_SPAN_ID [jvm]const val MDC_DD_SPAN_ID: String MDC_DD_TRACE_ID [jvm]const val MDC_DD_TRACE_ID: String MDC_SPAN_ID [jvm]const val MDC_SPAN_ID: String MDC_TRACE_ID [jvm]const val MDC_TRACE_ID: String"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-s-p-a-n_-i-d/","title":"MDC_DD_SPAN_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_DD_SPAN_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-s-p-a-n_-i-d/#mdc_dd_span_id","title":"MDC_DD_SPAN_ID","text":"[jvm]\\ const val MDC_DD_SPAN_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-t-r-a-c-e_-i-d/","title":"MDC_DD_TRACE_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_DD_TRACE_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-d-d_-t-r-a-c-e_-i-d/#mdc_dd_trace_id","title":"MDC_DD_TRACE_ID","text":"[jvm]\\ const val MDC_DD_TRACE_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-s-p-a-n_-i-d/","title":"MDC_SPAN_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_SPAN_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-s-p-a-n_-i-d/#mdc_span_id","title":"MDC_SPAN_ID","text":"[jvm]\\ const val MDC_SPAN_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-t-r-a-c-e_-i-d/","title":"MDC_TRACE_ID - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/MDC_TRACE_ID
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/-m-d-c_-t-r-a-c-e_-i-d/#mdc_trace_id","title":"MDC_TRACE_ID","text":"[jvm]\\ const val MDC_TRACE_ID: String
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/log/","title":"log - Misk","text":"//misk-datadog/com.squareup.cash.tracing.datadog/MDCScopeListener/Companion/log
"},{"location":"0.x/misk-datadog/misk-datadog/com.squareup.cash.tracing.datadog/-m-d-c-scope-listener/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/","title":"Package-level declarations - Misk","text":"//misk-datadog/misk.tracing.backends.datadog
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/#types","title":"Types","text":"Name Summary DatadogTracingBackendModule [jvm]class DatadogTracingBackendModule : KAbstractModuleBinds the datadog tracer to opentracing\u2019s Tracer"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/","title":"DatadogTracingBackendModule - Misk","text":"//misk-datadog/misk.tracing.backends.datadog/DatadogTracingBackendModule
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/#datadogtracingbackendmodule","title":"DatadogTracingBackendModule","text":"[jvm]\\ class DatadogTracingBackendModule : KAbstractModule
Binds the datadog tracer to opentracing\u2019s Tracer
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/#constructors","title":"Constructors","text":"DatadogTracingBackendModule [jvm]constructor()"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/-datadog-tracing-backend-module/","title":"DatadogTracingBackendModule - Misk","text":"//misk-datadog/misk.tracing.backends.datadog/DatadogTracingBackendModule/DatadogTracingBackendModule
"},{"location":"0.x/misk-datadog/misk-datadog/misk.tracing.backends.datadog/-datadog-tracing-backend-module/-datadog-tracing-backend-module/#datadogtracingbackendmodule","title":"DatadogTracingBackendModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/","title":"misk-exceptions-dynamodb - Misk","text":"//misk-exceptions-dynamodb
"},{"location":"0.x/misk-exceptions-dynamodb/#misk-exceptions-dynamodb","title":"misk-exceptions-dynamodb","text":""},{"location":"0.x/misk-exceptions-dynamodb/#packages","title":"Packages","text":"Name misk.exceptions.dynamodb"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/","title":"Package-level declarations - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/#types","title":"Types","text":"Name Summary ClientExecutionTimeoutExceptionMapper [jvm]class ClientExecutionTimeoutExceptionMapper@Injectconstructor : ExceptionMapper<ClientExecutionTimeoutException> Maps ClientExecutionTimeoutException to 503 responses because the exception is concurrency related DynamoDbExceptionMapperModule [jvm]class DynamoDbExceptionMapperModule : KAbstractModule TransactionCanceledExceptionMapper [jvm]class TransactionCanceledExceptionMapper@Injectconstructor : ExceptionMapper<TransactionCanceledException> Maps certain TransactionCanceledExceptionMapper to 503 responses when the exception is concurrency related"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/","title":"ClientExecutionTimeoutExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/ClientExecutionTimeoutExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/#clientexecutiontimeoutexceptionmapper","title":"ClientExecutionTimeoutExceptionMapper","text":"[jvm]\\ class ClientExecutionTimeoutExceptionMapper@Injectconstructor : ExceptionMapper<ClientExecutionTimeoutException>
Maps ClientExecutionTimeoutException to 503 responses because the exception is concurrency related
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/#constructors","title":"Constructors","text":"ClientExecutionTimeoutExceptionMapper [jvm]@Injectconstructor()"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open fun loggingLevel(th: ClientExecutionTimeoutException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: ClientExecutionTimeoutException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: ClientExecutionTimeoutException): Response<ResponseBody>"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/-client-execution-timeout-exception-mapper/","title":"ClientExecutionTimeoutExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/ClientExecutionTimeoutExceptionMapper/ClientExecutionTimeoutExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/-client-execution-timeout-exception-mapper/#clientexecutiontimeoutexceptionmapper","title":"ClientExecutionTimeoutExceptionMapper","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/ClientExecutionTimeoutExceptionMapper/toResponse
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-client-execution-timeout-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ open override fun toResponse(th: ClientExecutionTimeoutException): Response<ResponseBody>
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/","title":"DynamoDbExceptionMapperModule - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/DynamoDbExceptionMapperModule
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/#dynamodbexceptionmappermodule","title":"DynamoDbExceptionMapperModule","text":"[jvm]\\ class DynamoDbExceptionMapperModule : KAbstractModule
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/#constructors","title":"Constructors","text":"DynamoDbExceptionMapperModule [jvm]constructor()"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/-dynamo-db-exception-mapper-module/","title":"DynamoDbExceptionMapperModule - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/DynamoDbExceptionMapperModule/DynamoDbExceptionMapperModule
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-dynamo-db-exception-mapper-module/-dynamo-db-exception-mapper-module/#dynamodbexceptionmappermodule","title":"DynamoDbExceptionMapperModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/","title":"TransactionCanceledExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/#transactioncanceledexceptionmapper","title":"TransactionCanceledExceptionMapper","text":"[jvm]\\ class TransactionCanceledExceptionMapper@Injectconstructor : ExceptionMapper<TransactionCanceledException>
Maps certain TransactionCanceledExceptionMapper to 503 responses when the exception is concurrency related
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/#constructors","title":"Constructors","text":"TransactionCanceledExceptionMapper [jvm]@Injectconstructor()"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/#functions","title":"Functions","text":"Name Summary loggingLevel [jvm]open override fun loggingLevel(th: TransactionCanceledException): Level toGrpcResponse [jvm]open fun toGrpcResponse(th: TransactionCanceledException): GrpcErrorResponse? toResponse [jvm]open override fun toResponse(th: TransactionCanceledException): Response<ResponseBody>"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/-transaction-canceled-exception-mapper/","title":"TransactionCanceledExceptionMapper - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper/TransactionCanceledExceptionMapper
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/-transaction-canceled-exception-mapper/#transactioncanceledexceptionmapper","title":"TransactionCanceledExceptionMapper","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/logging-level/","title":"loggingLevel - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper/loggingLevel
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/logging-level/#logginglevel","title":"loggingLevel","text":"[jvm]\\ open override fun loggingLevel(th: TransactionCanceledException): Level
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/to-response/","title":"toResponse - Misk","text":"//misk-exceptions-dynamodb/misk.exceptions.dynamodb/TransactionCanceledExceptionMapper/toResponse
"},{"location":"0.x/misk-exceptions-dynamodb/misk-exceptions-dynamodb/misk.exceptions.dynamodb/-transaction-canceled-exception-mapper/to-response/#toresponse","title":"toResponse","text":"[jvm]\\ open override fun toResponse(th: TransactionCanceledException): Response<ResponseBody>
"},{"location":"0.x/misk-feature/","title":"misk-feature - Misk","text":"//misk-feature
"},{"location":"0.x/misk-feature/#misk-feature","title":"misk-feature","text":""},{"location":"0.x/misk-feature/#packages","title":"Packages","text":"Name misk.feature"},{"location":"0.x/misk-feature/misk-feature/misk.feature/","title":"Package-level declarations - Misk","text":"//misk-feature/misk.feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-feature/misk-feature/misk.feature/#types","title":"Types","text":"Name Summary Attributes [jvm]class Attributes@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false) : Attributes DynamicConfig [jvm]interface DynamicConfigInterface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys. Feature [jvm]class Feature(name: String) : Feature FeatureFlags [jvm]interface FeatureFlagsInterface for evaluating feature flags. FeatureService [jvm]interface FeatureService : ServiceMarker interface to integrate with the misk service graph. TrackerReference [jvm]interface TrackerReference : TrackerReference"},{"location":"0.x/misk-feature/misk-feature/misk.feature/#functions","title":"Functions","text":"Name Summary getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): Tinline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): Tinline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T toMisk [jvm]fun TrackerReference.toMisk(): TrackerReference trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-enum/","title":"getEnum - Misk","text":"//misk-feature/misk.feature/getEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T
inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-json/","title":"getJson - Misk","text":"//misk-feature/misk.feature/getJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/get-json/#getjson","title":"getJson","text":"[jvm]\\ inline fun <T> DynamicConfig.getJson(feature: Feature): T
inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/to-misk/","title":"toMisk - Misk","text":"//misk-feature/misk.feature/toMisk
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/to-misk/#tomisk","title":"toMisk","text":"[jvm]\\ fun TrackerReference.toMisk(): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-enum/","title":"trackEnum - Misk","text":"//misk-feature/misk.feature/trackEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-json/","title":"trackJson - Misk","text":"//misk-feature/misk.feature/trackJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/","title":"Attributes - Misk","text":"//misk-feature/misk.feature/Attributes
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#attributes","title":"Attributes","text":"[jvm]\\ class Attributes@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false) : Attributes
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#constructors","title":"Constructors","text":"Attributes [jvm]@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#properties","title":"Properties","text":"Name Summary anonymous [jvm]val anonymous: Boolean number [jvm]val number: Map<String, Number>? text [jvm]val text: Map<String, String>"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/#functions","title":"Functions","text":"Name Summary copy [jvm]fun copy(text: Map<String, String>, number: Map<String, Number>?, anonymous: Boolean): Attributes equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String with [jvm]fun with(name: String, value: Number): Attributesfun with(name: String, value: String): Attributes"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/-attributes/","title":"Attributes - Misk","text":"//misk-feature/misk.feature/Attributes/Attributes
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-attributes/-attributes/#attributes","title":"Attributes","text":"[jvm]\\
@JvmOverloads
constructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/","title":"DynamicConfig - Misk","text":"//misk-feature/misk.feature/DynamicConfig
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/#dynamicconfig","title":"DynamicConfig","text":"[jvm]\\ interface DynamicConfig
Interface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]abstract fun getBoolean(feature: Feature): BooleanReturns the value of a boolean dynamic flag. getDouble [jvm]abstract fun getDouble(feature: Feature): DoubleReturns the value of a double dynamic flag. getEnum [jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): TReturns the value of an enumerated dynamic flag. getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T getInt [jvm]abstract fun getInt(feature: Feature): IntReturns the value of an integer dynamic flag. getJson [jvm]abstract fun <T> getJson(feature: Feature, clazz: Class<T>): TReturns the value of a JSON dynamic flag. getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): T getString [jvm]abstract fun getString(feature: Feature): StringReturns the value of a string dynamic flag. trackBoolean [jvm]abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value. trackDouble [jvm]abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a double dynamic config tracker which will be invoked whenever the double dynamic config changes value. trackEnum [jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value. trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value. trackJson [jvm]abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a json dynamic config tracker which will be invoked whenever the json dynamic config changes value. trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a string dynamic config tracker which will be invoked whenever the string dynamic config changes value."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature): Boolean
Returns the value of a boolean dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-double/","title":"getDouble - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature): Double
Returns the value of a double dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
Returns the value of an enumerated dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-int/","title":"getInt - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature): Int
Returns the value of an integer dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-json/","title":"getJson - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, clazz: Class<T>): T
Returns the value of a JSON dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-string/","title":"getString - Misk","text":"//misk-feature/misk.feature/DynamicConfig/getString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature): String
Returns the value of a string dynamic flag.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a double dynamic config tracker which will be invoked whenever the double dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-int/","title":"trackInt - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-json/","title":"trackJson - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a json dynamic config tracker which will be invoked whenever the json dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-string/","title":"trackString - Misk","text":"//misk-feature/misk.feature/DynamicConfig/trackString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a string dynamic config tracker which will be invoked whenever the string dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/","title":"Feature - Misk","text":"//misk-feature/misk.feature/Feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#feature","title":"Feature","text":"[jvm]\\ class Feature(name: String) : Feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#constructors","title":"Constructors","text":"Feature [jvm]constructor(name: String)"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/#functions","title":"Functions","text":"Name Summary equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/-feature/","title":"Feature - Misk","text":"//misk-feature/misk.feature/Feature/Feature
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature/-feature/#feature","title":"Feature","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/","title":"FeatureFlags - Misk","text":"//misk-feature/misk.feature/FeatureFlags
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/#featureflags","title":"FeatureFlags","text":"[jvm]\\ interface FeatureFlags
Interface for evaluating feature flags.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(flag: BooleanFeatureFlag): BooleanCalculates the value of a boolean feature flag[jvm]abstract fun get(flag: DoubleFeatureFlag): DoubleCalculates the value of a double feature flag[jvm]abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): TCalculates the value of an enum feature flag[jvm]abstract fun get(flag: IntFeatureFlag): IntCalculates the value of an int feature flag[jvm]abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): TCalculates the value of a json feature flag[jvm]abstract fun get(flag: StringFeatureFlag): StringCalculates the value of a string feature flag getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Boolean[jvm]abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): BooleanCalculates the value of an boolean feature flag for the given key and attributes. getDouble [jvm]open fun getDouble(feature: Feature, key: String): Double[jvm]abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): DoubleCalculates the value of a double feature flag for the given key and attributes. getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of an enumerated feature flag for the given key and attributes. getEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getInt [jvm]open fun getInt(feature: Feature, key: String): Int[jvm]abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): IntCalculates the value of an integer feature flag for the given key and attributes. getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of a JSON feature flag for the given key and attributes. getJson [jvm]inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T getString [jvm]open fun getString(feature: Feature, key: String): String[jvm]abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a string feature flag for the given key and attributes. trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference[jvm]abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a tracker for the value of a boolean feature flag for the given key and attributes. trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference[jvm]abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a tracker for the value of a double feature flag for the given key and attributes. trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of an enumerated feature flag for the given key and attributes. trackEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference[jvm]abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a tracker for the value of an integer feature flag for the given key and attributes. trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of a JSON feature flag for the given key and attributes. trackJson [jvm]inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference[jvm]abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a tracker for the value of a string feature flag for the given key and attributes."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): Boolean
Calculates the value of an boolean feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-boolean/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getBoolean(feature: Feature, key: String): Boolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-double/","title":"getDouble - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): Double
Calculates the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-double/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getDouble(feature: Feature, key: String): Double
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/","title":"getEnum - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-int/","title":"getInt - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): Int
Calculates the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-int/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getInt(feature: Feature, key: String): Int
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/","title":"getJson - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-json/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-string/","title":"getString - Misk","text":"//misk-feature/misk.feature/FeatureFlags/getString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): String
Calculates the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get-string/#see-also","title":"See also","text":"FeatureFlags.getEnum for param details[jvm]\\ open fun getString(feature: Feature, key: String): String
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/","title":"get - Misk","text":"//misk-feature/misk.feature/FeatureFlags/get
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#get","title":"get","text":"[jvm]\\ abstract fun get(flag: BooleanFeatureFlag): Boolean
Calculates the value of a boolean feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: StringFeatureFlag): String
Calculates the value of a string feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_1","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_1","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: IntFeatureFlag): Int
Calculates the value of an int feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_2","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_2","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: DoubleFeatureFlag): Double
Calculates the value of a double feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_3","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_3","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
Calculates the value of an enum feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_4","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_4","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): T
Calculates the value of a json feature flag
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#parameters_5","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/get/#throws_5","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackBoolean
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a tracker for the value of a boolean feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-boolean/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-double/","title":"trackDouble - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackDouble
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a tracker for the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-double/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackEnum
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#return","title":"Return","text":"a reference to the registered tracker allowing to un-register it
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation. tracker a tracker to be registered for processing of changed values"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-int/","title":"trackInt - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackInt
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a tracker for the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-int/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/","title":"trackJson - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackJson
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-json/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-string/","title":"trackString - Misk","text":"//misk-feature/misk.feature/FeatureFlags/trackString
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a tracker for the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-flags/track-string/#see-also","title":"See also","text":"FeatureFlags.trackEnum for param details[jvm]\\ open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-service/","title":"FeatureService - Misk","text":"//misk-feature/misk.feature/FeatureService
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-service/#featureservice","title":"FeatureService","text":"[jvm]\\ interface FeatureService : Service
Marker interface to integrate with the misk service graph.
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-feature-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-tracker-reference/","title":"TrackerReference - Misk","text":"//misk-feature/misk.feature/TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-tracker-reference/#trackerreference","title":"TrackerReference","text":"[jvm]\\ interface TrackerReference : TrackerReference
"},{"location":"0.x/misk-feature/misk-feature/misk.feature/-tracker-reference/#functions","title":"Functions","text":"Name Summary toMisk [jvm]fun TrackerReference.toMisk(): TrackerReference unregister [jvm]abstract fun unregister()"},{"location":"0.x/misk-gcp/","title":"misk-gcp - Misk","text":"//misk-gcp
"},{"location":"0.x/misk-gcp/#misk-gcp","title":"misk-gcp","text":""},{"location":"0.x/misk-gcp/#packages","title":"Packages","text":"Name misk.cloud.gcp misk.cloud.gcp.datastore misk.cloud.gcp.logging misk.cloud.gcp.security.keys misk.cloud.gcp.spanner misk.cloud.gcp.storage misk.cloud.gcp.tracing misk.logging"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/#types","title":"Types","text":"Name Summary GoogleCloudModule [jvm]class GoogleCloudModule(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig) : KAbstractModuleInstalls support for talking to real GCP services, either direct or via emulator TransportConfig [jvm]data class TransportConfig@JvmOverloadsconstructor(val connect_timeout_ms: Int = -1, val read_timeout_ms: Int = -1, val host: String? = null)Transport configuration for GCP services."},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/","title":"GoogleCloudModule - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/#googlecloudmodule","title":"GoogleCloudModule","text":"[jvm]\\ class GoogleCloudModule(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig) : KAbstractModule
Installs support for talking to real GCP services, either direct or via emulator
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/#constructors","title":"Constructors","text":"GoogleCloudModule [jvm]constructor(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideCloudDatastore [jvm]@Provides@Singletonfun provideCloudDatastore(credentials: Credentials, config: DatastoreConfig): Datastore provideCloudStorage [jvm]@Provides@Singletonfun provideCloudStorage(credentials: Credentials, config: StorageConfig): Storage provideServiceCredentials [jvm]@Provides@Singletonfun provideServiceCredentials(deployment: Deployment): Credentials"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/-google-cloud-module/","title":"GoogleCloudModule - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/GoogleCloudModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/-google-cloud-module/#googlecloudmodule","title":"GoogleCloudModule","text":"[jvm]\\ constructor(datastoreConfig: DatastoreConfig, storageConfig: StorageConfig)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-datastore/","title":"provideCloudDatastore - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/provideCloudDatastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-datastore/#provideclouddatastore","title":"provideCloudDatastore","text":"[jvm]\\
@Provides
@Singleton
fun provideCloudDatastore(credentials: Credentials, config: DatastoreConfig): Datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-storage/","title":"provideCloudStorage - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/provideCloudStorage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-cloud-storage/#providecloudstorage","title":"provideCloudStorage","text":"[jvm]\\
@Provides
@Singleton
fun provideCloudStorage(credentials: Credentials, config: StorageConfig): Storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-service-credentials/","title":"provideServiceCredentials - Misk","text":"//misk-gcp/misk.cloud.gcp/GoogleCloudModule/provideServiceCredentials
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-google-cloud-module/provide-service-credentials/#provideservicecredentials","title":"provideServiceCredentials","text":"[jvm]\\
@Provides
@Singleton
fun provideServiceCredentials(deployment: Deployment): Credentials
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/","title":"TransportConfig - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/#transportconfig","title":"TransportConfig","text":"[jvm]\\ data class TransportConfig@JvmOverloadsconstructor(val connect_timeout_ms: Int = -1, val read_timeout_ms: Int = -1, val host: String? = null)
Transport configuration for GCP services.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/#constructors","title":"Constructors","text":"TransportConfig [jvm]@JvmOverloadsconstructor(connect_timeout_ms: Int = -1, read_timeout_ms: Int = -1, host: String? = null)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/#properties","title":"Properties","text":"Name Summary connect_timeout_ms [jvm]val connect_timeout_ms: Int host [jvm]val host: String? = null read_timeout_ms [jvm]val read_timeout_ms: Int"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/-transport-config/","title":"TransportConfig - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/-transport-config/#transportconfig","title":"TransportConfig","text":"[jvm]\\
@JvmOverloads
constructor(connect_timeout_ms: Int = -1, read_timeout_ms: Int = -1, host: String? = null)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/connect_timeout_ms/","title":"connect_timeout_ms - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/connect_timeout_ms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/connect_timeout_ms/#connect_timeout_ms","title":"connect_timeout_ms","text":"[jvm]\\ val connect_timeout_ms: Int
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/host/","title":"host - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/host
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/host/#host","title":"host","text":"[jvm]\\ val host: String? = null
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/read_timeout_ms/","title":"read_timeout_ms - Misk","text":"//misk-gcp/misk.cloud.gcp/TransportConfig/read_timeout_ms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp/-transport-config/read_timeout_ms/#read_timeout_ms","title":"read_timeout_ms","text":"[jvm]\\ val read_timeout_ms: Int
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/#types","title":"Types","text":"Name Summary DatastoreConfig [jvm]data class DatastoreConfig@JvmOverloadsconstructor(val transport: TransportConfig = TransportConfig()) : ConfigConfiguration for talking to Google datastore Keys [jvm]object Keys"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/#functions","title":"Functions","text":"Name Summary asList [jvm]fun <T> QueryResults<T>.asList(): List<T> getByteString [jvm]fun Entity.getByteString(name: String): ByteString getProto [jvm]fun <T> Entity.getProto(name: String, protoAdapter: ProtoAdapter<T>): T set [jvm]fun Entity.Builder.set(name: String, bytes: ByteString): Entity.Builder toByteString [jvm]fun Blob.toByteString(): ByteString"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/as-list/","title":"asList - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/asList
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/as-list/#aslist","title":"asList","text":"[jvm]\\ fun <T> QueryResults<T>.asList(): List<T>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-byte-string/","title":"getByteString - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/getByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-byte-string/#getbytestring","title":"getByteString","text":"[jvm]\\ fun Entity.getByteString(name: String): ByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-proto/","title":"getProto - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/getProto
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/get-proto/#getproto","title":"getProto","text":"[jvm]\\ fun <T> Entity.getProto(name: String, protoAdapter: ProtoAdapter<T>): T
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/set/","title":"set - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/set
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/set/#set","title":"set","text":"[jvm]\\ fun Entity.Builder.set(name: String, bytes: ByteString): Entity.Builder
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/to-byte-string/","title":"toByteString - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/toByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/to-byte-string/#tobytestring","title":"toByteString","text":"[jvm]\\ fun Blob.toByteString(): ByteString
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/","title":"DatastoreConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/DatastoreConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/#datastoreconfig","title":"DatastoreConfig","text":"[jvm]\\ data class DatastoreConfig@JvmOverloadsconstructor(val transport: TransportConfig = TransportConfig()) : Config
Configuration for talking to Google datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/#constructors","title":"Constructors","text":"DatastoreConfig [jvm]@JvmOverloadsconstructor(transport: TransportConfig = TransportConfig())"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/#properties","title":"Properties","text":"Name Summary transport [jvm]val transport: TransportConfig"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/-datastore-config/","title":"DatastoreConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/DatastoreConfig/DatastoreConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/-datastore-config/#datastoreconfig","title":"DatastoreConfig","text":"[jvm]\\
@JvmOverloads
constructor(transport: TransportConfig = TransportConfig())
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/transport/","title":"transport - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/DatastoreConfig/transport
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-datastore-config/transport/#transport","title":"transport","text":"[jvm]\\ val transport: TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/","title":"Keys - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/Keys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/#keys","title":"Keys","text":"[jvm]\\ object Keys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/#functions","title":"Functions","text":"Name Summary newKey [jvm]fun newKey(projectId: String, kind: String, id: Long): Keyfun newKey(projectId: String, kind: String, name: String): Key"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/new-key/","title":"newKey - Misk","text":"//misk-gcp/misk.cloud.gcp.datastore/Keys/newKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.datastore/-keys/new-key/#newkey","title":"newKey","text":"[jvm]\\ fun newKey(projectId: String, kind: String, id: Long): Key
fun newKey(projectId: String, kind: String, name: String): Key
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.logging
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/#types","title":"Types","text":"Name Summary StackDriverLoggingConfig [jvm]data class StackDriverLoggingConfig@JvmOverloadsconstructor(val flush_level: Level = Level.ERROR, val filter_level: Level = Level.INFO, val resource_type: String?, val log: String = \"java.log\") : Config"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/","title":"StackDriverLoggingConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/#stackdriverloggingconfig","title":"StackDriverLoggingConfig","text":"[jvm]\\ data class StackDriverLoggingConfig@JvmOverloadsconstructor(val flush_level: Level = Level.ERROR, val filter_level: Level = Level.INFO, val resource_type: String?, val log: String = \"java.log\") : Config
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/#constructors","title":"Constructors","text":"StackDriverLoggingConfig [jvm]@JvmOverloadsconstructor(flush_level: Level = Level.ERROR, filter_level: Level = Level.INFO, resource_type: String?, log: String = \"java.log\")"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/#properties","title":"Properties","text":"Name Summary filter_level [jvm]val filter_level: Level flush_level [jvm]val flush_level: Level log [jvm]val log: String resource_type [jvm]val resource_type: String?"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/-stack-driver-logging-config/","title":"StackDriverLoggingConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/StackDriverLoggingConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/-stack-driver-logging-config/#stackdriverloggingconfig","title":"StackDriverLoggingConfig","text":"[jvm]\\
@JvmOverloads
constructor(flush_level: Level = Level.ERROR, filter_level: Level = Level.INFO, resource_type: String?, log: String = \"java.log\")
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/filter_level/","title":"filter_level - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/filter_level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/filter_level/#filter_level","title":"filter_level","text":"[jvm]\\ val filter_level: Level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/flush_level/","title":"flush_level - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/flush_level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/flush_level/#flush_level","title":"flush_level","text":"[jvm]\\ val flush_level: Level
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/log/","title":"log - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/log
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/log/#log","title":"log","text":"[jvm]\\ val log: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/resource_type/","title":"resource_type - Misk","text":"//misk-gcp/misk.cloud.gcp.logging/StackDriverLoggingConfig/resource_type
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.logging/-stack-driver-logging-config/resource_type/#resource_type","title":"resource_type","text":"[jvm]\\ val resource_type: String?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/#types","title":"Types","text":"Name Summary GcpKeyLocation [jvm]data class GcpKeyLocation(val location: String, val key_ring: String, val key_name: String) GcpKeyManagementModule [jvm]class GcpKeyManagementModule(config: GcpKmsConfig) : KAbstractModule GcpKmsConfig [jvm]data class GcpKmsConfig(val project_id: String, val key_locations: Map<String, GcpKeyLocation>) : Config"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/","title":"GcpKeyLocation - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/#gcpkeylocation","title":"GcpKeyLocation","text":"[jvm]\\ data class GcpKeyLocation(val location: String, val key_ring: String, val key_name: String)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/#constructors","title":"Constructors","text":"GcpKeyLocation [jvm]constructor(location: String, key_ring: String, key_name: String)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/#properties","title":"Properties","text":"Name Summary key_name [jvm]val key_name: String key_ring [jvm]val key_ring: String location [jvm]val location: String path [jvm]val path: String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/-gcp-key-location/","title":"GcpKeyLocation - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/GcpKeyLocation
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/-gcp-key-location/#gcpkeylocation","title":"GcpKeyLocation","text":"[jvm]\\ constructor(location: String, key_ring: String, key_name: String)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_name/","title":"key_name - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/key_name
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_name/#key_name","title":"key_name","text":"[jvm]\\ val key_name: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_ring/","title":"key_ring - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/key_ring
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/key_ring/#key_ring","title":"key_ring","text":"[jvm]\\ val key_ring: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/location/","title":"location - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/location
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/location/#location","title":"location","text":"[jvm]\\ val location: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/path/","title":"path - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyLocation/path
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-location/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/","title":"GcpKeyManagementModule - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyManagementModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/#gcpkeymanagementmodule","title":"GcpKeyManagementModule","text":"[jvm]\\ class GcpKeyManagementModule(config: GcpKmsConfig) : KAbstractModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/#constructors","title":"Constructors","text":"GcpKeyManagementModule [jvm]constructor(config: GcpKmsConfig)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providesKms [jvm]@Provides@Singletonfun providesKms(appName: String): CloudKMS"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/-gcp-key-management-module/","title":"GcpKeyManagementModule - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyManagementModule/GcpKeyManagementModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/-gcp-key-management-module/#gcpkeymanagementmodule","title":"GcpKeyManagementModule","text":"[jvm]\\ constructor(config: GcpKmsConfig)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/provides-kms/","title":"providesKms - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKeyManagementModule/providesKms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-key-management-module/provides-kms/#provideskms","title":"providesKms","text":"[jvm]\\
@Provides
@Singleton
fun providesKms(appName: String): CloudKMS
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/","title":"GcpKmsConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/#gcpkmsconfig","title":"GcpKmsConfig","text":"[jvm]\\ data class GcpKmsConfig(val project_id: String, val key_locations: Map<String, GcpKeyLocation>) : Config
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/#constructors","title":"Constructors","text":"GcpKmsConfig [jvm]constructor(project_id: String, key_locations: Map<String, GcpKeyLocation>)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/#properties","title":"Properties","text":"Name Summary key_locations [jvm]val key_locations: Map<String, GcpKeyLocation> project_id [jvm]val project_id: String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/-gcp-kms-config/","title":"GcpKmsConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig/GcpKmsConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/-gcp-kms-config/#gcpkmsconfig","title":"GcpKmsConfig","text":"[jvm]\\ constructor(project_id: String, key_locations: Map<String, GcpKeyLocation>)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/key_locations/","title":"key_locations - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig/key_locations
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/key_locations/#key_locations","title":"key_locations","text":"[jvm]\\ val key_locations: Map<String, GcpKeyLocation>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/project_id/","title":"project_id - Misk","text":"//misk-gcp/misk.cloud.gcp.security.keys/GcpKmsConfig/project_id
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.security.keys/-gcp-kms-config/project_id/#project_id","title":"project_id","text":"[jvm]\\ val project_id: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/#types","title":"Types","text":"Name Summary GoogleSpannerModule [jvm]class GoogleSpannerModule(spannerConfig: SpannerConfig) : KAbstractModuleGoogleSpannerModule provides a Google Spanner client for your app. GoogleSpannerService [jvm]@Singletonclass GoogleSpannerService@Injectconstructor(spanner: Spanner) : AbstractIdleService SpannerConfig [jvm]data class SpannerConfig@JvmOverloadsconstructor(val credentials: Credentials? = null, val database: String, val emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), val instance_id: String, val project_id: String, val initial_retry_delay_ms: Long? = null, val max_retry_delay_s: Long? = null, val retry_delay_multiplier: Double? = null, val initial_rpc_timeout_s: Long? = null, val max_rpc_timeout_s: Long? = null, val rpc_timeout_multipler: Double? = null, val total_timeout_s: Long? = null, val max_attempts: Int? = null) : ConfigConfiguration for talking to Google datastore SpannerEmulatorConfig [jvm]data class SpannerEmulatorConfig@JvmOverloadsconstructor(val enabled: Boolean = false, val hostname: String = \"localhost\", val port: Int = 9010, val version: String? = null)Options for configuring the Spanner emulator."},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/","title":"GoogleSpannerModule - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/#googlespannermodule","title":"GoogleSpannerModule","text":"[jvm]\\ class GoogleSpannerModule(spannerConfig: SpannerConfig) : KAbstractModule
GoogleSpannerModule provides a Google Spanner client for your app.
For testing, install the emulator
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/#constructors","title":"Constructors","text":"GoogleSpannerModule [jvm]constructor(spannerConfig: SpannerConfig)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideCloudSpanner [jvm]@Provides@Singletonfun provideCloudSpanner(config: SpannerConfig): Spanner"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/-google-spanner-module/","title":"GoogleSpannerModule - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerModule/GoogleSpannerModule
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/-google-spanner-module/#googlespannermodule","title":"GoogleSpannerModule","text":"[jvm]\\ constructor(spannerConfig: SpannerConfig)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/provide-cloud-spanner/","title":"provideCloudSpanner - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerModule/provideCloudSpanner
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-module/provide-cloud-spanner/#providecloudspanner","title":"provideCloudSpanner","text":"[jvm]\\
@Provides
@Singleton
fun provideCloudSpanner(config: SpannerConfig): Spanner
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/","title":"GoogleSpannerService - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerService
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#googlespannerservice","title":"GoogleSpannerService","text":"[jvm]\\ @Singleton
class GoogleSpannerService@Injectconstructor(spanner: Spanner) : AbstractIdleService
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#constructors","title":"Constructors","text":"GoogleSpannerService [jvm]@Injectconstructor(spanner: Spanner)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-google-spanner-service/","title":"GoogleSpannerService - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerService/GoogleSpannerService
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-google-spanner-service/#googlespannerservice","title":"GoogleSpannerService","text":"[jvm]\\
@Inject
constructor(spanner: Spanner)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-companion/","title":"Companion - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/GoogleSpannerService/Companion
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-google-spanner-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/","title":"SpannerConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/#spannerconfig","title":"SpannerConfig","text":"[jvm]\\ data class SpannerConfig@JvmOverloadsconstructor(val credentials: Credentials? = null, val database: String, val emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), val instance_id: String, val project_id: String, val initial_retry_delay_ms: Long? = null, val max_retry_delay_s: Long? = null, val retry_delay_multiplier: Double? = null, val initial_rpc_timeout_s: Long? = null, val max_rpc_timeout_s: Long? = null, val rpc_timeout_multipler: Double? = null, val total_timeout_s: Long? = null, val max_attempts: Int? = null) : Config
Configuration for talking to Google datastore
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/#constructors","title":"Constructors","text":"SpannerConfig [jvm]@JvmOverloadsconstructor(credentials: Credentials? = null, database: String, emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), instance_id: String, project_id: String, initial_retry_delay_ms: Long? = null, max_retry_delay_s: Long? = null, retry_delay_multiplier: Double? = null, initial_rpc_timeout_s: Long? = null, max_rpc_timeout_s: Long? = null, rpc_timeout_multipler: Double? = null, total_timeout_s: Long? = null, max_attempts: Int? = null)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/#properties","title":"Properties","text":"Name Summary credentials [jvm]val credentials: Credentials? = nullA set of Google Cloud credentials to use for making requests to Spanner. database [jvm]val database: StringName of the database to connect to within the Spanner instance. emulator [jvm]val emulator: SpannerEmulatorConfigConfiguration for the included Spanner emulator. initial_retry_delay_ms [jvm]val initial_retry_delay_ms: Long? = nullThe initial amount of time to wait before retrying the request. initial_rpc_timeout_s [jvm]val initial_rpc_timeout_s: Long? = nullConfigure RPC and total timeout settings. Timeout for the first RPC call. Subsequent retries will be based off this value. instance_id [jvm]val instance_id: StringID of the Spanner instance to connect to. max_attempts [jvm]val max_attempts: Int? = nullTotal number of attempts for an RPC. Setting to 1 means no retries will be attempted. max_retry_delay_s [jvm]val max_retry_delay_s: Long? = nullThe maximum amount of time to wait before retrying. I.e. after this value is reached, the wait time will not increase further by the multiplier. max_rpc_timeout_s [jvm]val max_rpc_timeout_s: Long? = nullThe max for the per RPC timeout. project_id [jvm]val project_id: StringID of the GCP project the Spanner instance is located in. retry_delay_multiplier [jvm]val retry_delay_multiplier: Double? = nullThe previous wait time is multiplied by this multiplier to come up with the next wait time, until the max is reached. rpc_timeout_multipler [jvm]val rpc_timeout_multipler: Double? = nullControls the change of timeout for each retry. total_timeout_s [jvm]val total_timeout_s: Long? = nullThe timeout for all calls (first call + all retries)."},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/-spanner-config/","title":"SpannerConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/SpannerConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/-spanner-config/#spannerconfig","title":"SpannerConfig","text":"[jvm]\\
@JvmOverloads
constructor(credentials: Credentials? = null, database: String, emulator: SpannerEmulatorConfig = SpannerEmulatorConfig(), instance_id: String, project_id: String, initial_retry_delay_ms: Long? = null, max_retry_delay_s: Long? = null, retry_delay_multiplier: Double? = null, initial_rpc_timeout_s: Long? = null, max_rpc_timeout_s: Long? = null, rpc_timeout_multipler: Double? = null, total_timeout_s: Long? = null, max_attempts: Int? = null)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/credentials/","title":"credentials - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/credentials
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/credentials/#credentials","title":"credentials","text":"[jvm]\\ val credentials: Credentials? = null
A set of Google Cloud credentials to use for making requests to Spanner.
If you have special behavior around managing service credentials in production environments, this is the place to configure that.
Note: We will attempt to automatically grab credentials from the environment where applicable, or ignore setting credentials for emulator development.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/database/","title":"database - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/database
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/database/#database","title":"database","text":"[jvm]\\ val database: String
Name of the database to connect to within the Spanner instance.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/emulator/","title":"emulator - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/emulator
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/emulator/#emulator","title":"emulator","text":"[jvm]\\ val emulator: SpannerEmulatorConfig
Configuration for the included Spanner emulator.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_retry_delay_ms/","title":"initial_retry_delay_ms - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/initial_retry_delay_ms
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_retry_delay_ms/#initial_retry_delay_ms","title":"initial_retry_delay_ms","text":"[jvm]\\ val initial_retry_delay_ms: Long? = null
The initial amount of time to wait before retrying the request.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_rpc_timeout_s/","title":"initial_rpc_timeout_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/initial_rpc_timeout_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/initial_rpc_timeout_s/#initial_rpc_timeout_s","title":"initial_rpc_timeout_s","text":"[jvm]\\ val initial_rpc_timeout_s: Long? = null
Configure RPC and total timeout settings. Timeout for the first RPC call. Subsequent retries will be based off this value.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/instance_id/","title":"instance_id - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/instance_id
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/instance_id/#instance_id","title":"instance_id","text":"[jvm]\\ val instance_id: String
ID of the Spanner instance to connect to.
Note: your local dev instance ID doesn\u2019t have to be related to an actual Spanner instance - any string will do.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_attempts/","title":"max_attempts - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/max_attempts
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_attempts/#max_attempts","title":"max_attempts","text":"[jvm]\\ val max_attempts: Int? = null
Total number of attempts for an RPC. Setting to 1 means no retries will be attempted.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_retry_delay_s/","title":"max_retry_delay_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/max_retry_delay_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_retry_delay_s/#max_retry_delay_s","title":"max_retry_delay_s","text":"[jvm]\\ val max_retry_delay_s: Long? = null
The maximum amount of time to wait before retrying. I.e. after this value is reached, the wait time will not increase further by the multiplier.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_rpc_timeout_s/","title":"max_rpc_timeout_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/max_rpc_timeout_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/max_rpc_timeout_s/#max_rpc_timeout_s","title":"max_rpc_timeout_s","text":"[jvm]\\ val max_rpc_timeout_s: Long? = null
The max for the per RPC timeout.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/project_id/","title":"project_id - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/project_id
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/project_id/#project_id","title":"project_id","text":"[jvm]\\ val project_id: String
ID of the GCP project the Spanner instance is located in.
Note: your local dev project ID doesn\u2019t have to be related to an actual GCP project - any string will do.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/retry_delay_multiplier/","title":"retry_delay_multiplier - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/retry_delay_multiplier
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/retry_delay_multiplier/#retry_delay_multiplier","title":"retry_delay_multiplier","text":"[jvm]\\ val retry_delay_multiplier: Double? = null
The previous wait time is multiplied by this multiplier to come up with the next wait time, until the max is reached.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/rpc_timeout_multipler/","title":"rpc_timeout_multipler - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/rpc_timeout_multipler
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/rpc_timeout_multipler/#rpc_timeout_multipler","title":"rpc_timeout_multipler","text":"[jvm]\\ val rpc_timeout_multipler: Double? = null
Controls the change of timeout for each retry.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/total_timeout_s/","title":"total_timeout_s - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerConfig/total_timeout_s
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-config/total_timeout_s/#total_timeout_s","title":"total_timeout_s","text":"[jvm]\\ val total_timeout_s: Long? = null
The timeout for all calls (first call + all retries).
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/","title":"SpannerEmulatorConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/#spanneremulatorconfig","title":"SpannerEmulatorConfig","text":"[jvm]\\ data class SpannerEmulatorConfig@JvmOverloadsconstructor(val enabled: Boolean = false, val hostname: String = \"localhost\", val port: Int = 9010, val version: String? = null)
Options for configuring the Spanner emulator.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/#constructors","title":"Constructors","text":"SpannerEmulatorConfig [jvm]@JvmOverloadsconstructor(enabled: Boolean = false, hostname: String = \"localhost\", port: Int = 9010, version: String? = null)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/#properties","title":"Properties","text":"Name Summary enabled [jvm]val enabled: Boolean = falseWhether or not to start the Spanner emulator when the GoogleSpannerModule is installed. hostname [jvm]val hostname: StringThe hostname where the Spanner emulator is hosted. In almost all cases, this should be left as \"localhost\". port [jvm]val port: Int = 9010The port where the Spanner emulator\u2019s gRPC port is hosted. version [jvm]val version: String? = null"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/-spanner-emulator-config/","title":"SpannerEmulatorConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/SpannerEmulatorConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/-spanner-emulator-config/#spanneremulatorconfig","title":"SpannerEmulatorConfig","text":"[jvm]\\
@JvmOverloads
constructor(enabled: Boolean = false, hostname: String = \"localhost\", port: Int = 9010, version: String? = null)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/enabled/","title":"enabled - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/enabled
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/enabled/#enabled","title":"enabled","text":"[jvm]\\ val enabled: Boolean = false
Whether or not to start the Spanner emulator when the GoogleSpannerModule is installed.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/hostname/","title":"hostname - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/hostname
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/hostname/#hostname","title":"hostname","text":"[jvm]\\ val hostname: String
The hostname where the Spanner emulator is hosted. In almost all cases, this should be left as \"localhost\".
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/port/","title":"port - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/port
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/port/#port","title":"port","text":"[jvm]\\ val port: Int = 9010
The port where the Spanner emulator\u2019s gRPC port is hosted.
By default, Spanner emulators run a gRPC port on 9010 and a REST / HTTP port on 9020. When spinning up an emulator, we will automatically reserve this port \"+ 10\" as the REST / HTTP port for Docker to bind to.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/version/","title":"version - Misk","text":"//misk-gcp/misk.cloud.gcp.spanner/SpannerEmulatorConfig/version
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.spanner/-spanner-emulator-config/version/#version","title":"version","text":"[jvm]\\ val version: String? = null
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#types","title":"Types","text":"Name Summary BaseCustomStorageRpc [jvm]abstract class BaseCustomStorageRpc : StorageRpcBase for custom storage implementations. Most operations on custom storage are unsupported; only those minimal methods requiring implementation are left abstract. LocalStorageConfig [jvm]data class LocalStorageConfig(val data_dir: String)Configuration for local (emulated) storage LocalStorageRpc [jvm]class LocalStorageRpc@JvmOverloadsconstructor(root: Path, moshi: Moshi = defaultKotlinMoshi) : BaseCustomStorageRpcImplementation of StorageRpc that is backed by local disk storage. Useful for running in development mode on local machines, since there is no GCS emulator available. Files are stored with the generation version appended as an extension suffix, with a symlink existing for the latest generation. To preserve GCS atomicity semantics, progressive uploads are handled by storing the interim uploaded data in a temporary file based off the latest generation, then doing a rename to the new generation once the upload is complete. StorageConfig [jvm]data class StorageConfig@JvmOverloadsconstructor(val use_local_storage: Boolean = false, val local_storage: LocalStorageConfig? = null, val transport: TransportConfig = TransportConfig()) : ConfigConfiguration for talking to Google Cloud Storage"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#properties","title":"Properties","text":"Name Summary blobIds [jvm]val Page<Blob>.blobIds: List<BlobId>"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/#functions","title":"Functions","text":"Name Summary compareTo [jvm]fun BlobId.compareTo(other: BlobId): Int forEachChunk [jvm]fun ReadChannel.forEachChunk(buffer: ByteBuffer, action: (ByteBuffer, Int) -> Unit)Runs the given block for each chunk on a given channel[jvm]fun ReadChannel.forEachChunk(chunkSize: Int, action: (ByteBuffer, Int) -> Unit) toList [jvm]fun <T> Page<T>.toList(): List<T> withLock [jvm]fun <T> FileChannel.withLock(shared: Boolean, action: () -> T): T"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/blob-ids/","title":"blobIds - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/blobIds
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/blob-ids/#blobids","title":"blobIds","text":"[jvm]\\ val Page<Blob>.blobIds: List<BlobId>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/blob-ids/#return","title":"Return","text":"a list containing just the ids of the blobs in the page
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/compare-to/","title":"compareTo - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/compareTo
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ fun BlobId.compareTo(other: BlobId): Int
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/compare-to/#return","title":"Return","text":"compares one blob id to another; orders by bucket, then name, then generation
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/for-each-chunk/","title":"forEachChunk - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/forEachChunk
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/for-each-chunk/#foreachchunk","title":"forEachChunk","text":"[jvm]\\ fun ReadChannel.forEachChunk(buffer: ByteBuffer, action: (ByteBuffer, Int) -> Unit)
Runs the given block for each chunk on a given channel
[jvm]\\ fun ReadChannel.forEachChunk(chunkSize: Int, action: (ByteBuffer, Int) -> Unit)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/to-list/","title":"toList - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/toList
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/to-list/#tolist","title":"toList","text":"[jvm]\\ fun <T> Page<T>.toList(): List<T>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/to-list/#return","title":"Return","text":"a list containing all of the elements in this page
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/with-lock/","title":"withLock - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/withLock
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/with-lock/#withlock","title":"withLock","text":"[jvm]\\ fun <T> FileChannel.withLock(shared: Boolean, action: () -> T): T
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/","title":"BaseCustomStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#basecustomstoragerpc","title":"BaseCustomStorageRpc","text":"abstract class BaseCustomStorageRpc : StorageRpc
Base for custom storage implementations. Most operations on custom storage are unsupported; only those minimal methods requiring implementation are left abstract.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#inheritors","title":"Inheritors","text":"LocalStorageRpc"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#constructors","title":"Constructors","text":"BaseCustomStorageRpc [jvm]constructor()"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/#functions","title":"Functions","text":"Name Summary compose [jvm]open override fun compose(sources: Iterable<StorageObject>?, target: StorageObject?, targetOptions: Map<StorageRpc.Option, *>?): StorageObject continueRewrite [jvm]open override fun continueRewrite(previousResponse: StorageRpc.RewriteResponse): StorageRpc.RewriteResponse create [jvm]abstract fun create(p0: StorageObject, p1: InputStream, p2: MutableMap<StorageRpc.Option, *>): StorageObjectopen override fun create(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket createAcl [jvm]open override fun createAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun createAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl createBatch [jvm]open override fun createBatch(): RpcBatch createDefaultAcl [jvm]open override fun createDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl createHmacKey [jvm]open override fun createHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKey createNotification [jvm]open override fun createNotification(bucket: String?, notification: Notification?): Notification delete [jvm]abstract fun delete(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): Booleanopen override fun delete(bucket: Bucket, options: Map<StorageRpc.Option, *>): Boolean deleteAcl [jvm]open override fun deleteAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): Booleanopen override fun deleteAcl(bucket: String?, object: String?, generation: Long?, entity: String?): Boolean deleteDefaultAcl [jvm]open override fun deleteDefaultAcl(bucket: String?, entity: String?): Boolean deleteHmacKey [jvm]open override fun deleteHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?) deleteNotification [jvm]open override fun deleteNotification(bucket: String?, notification: String?): Boolean get [jvm]abstract operator fun get(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): StorageObjectopen operator override fun get(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket? getAcl [jvm]open override fun getAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): BucketAccessControlopen override fun getAcl(bucket: String?, obj: String?, generation: Long?, entity: String?): ObjectAccessControl getCurrentUploadOffset [jvm]open override fun getCurrentUploadOffset(p0: String?): Long getDefaultAcl [jvm]open override fun getDefaultAcl(bucket: String?, entity: String?): ObjectAccessControl getHmacKey [jvm]open override fun getHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata getIamPolicy [jvm]open override fun getIamPolicy(bucket: String?, options: Map<StorageRpc.Option, *>?): Policy getServiceAccount [jvm]open override fun getServiceAccount(projectId: String?): ServiceAccount list [jvm]abstract fun list(p0: String, p1: MutableMap<StorageRpc.Option, *>): Tuple<String, MutableIterable<StorageObject>>open override fun list(options: Map<StorageRpc.Option, *>?): Tuple<String, Iterable<Bucket>> listAcls [jvm]open override fun listAcls(bucket: String?, options: Map<StorageRpc.Option, *>?): List<BucketAccessControl>open override fun listAcls(bucket: String?, obj: String?, generation: Long?): List<ObjectAccessControl> listDefaultAcls [jvm]open override fun listDefaultAcls(bucket: String?): MutableList<ObjectAccessControl> listHmacKeys [jvm]open override fun listHmacKeys(p0: MutableMap<StorageRpc.Option, *>?): Tuple<String, MutableIterable<HmacKeyMetadata>> listNotifications [jvm]open override fun listNotifications(bucket: String?): List<Notification> load [jvm]abstract fun load(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): ByteArray lockRetentionPolicy [jvm]open override fun lockRetentionPolicy(bucket: Bucket?, options: Map<StorageRpc.Option, *>?): Bucket open [jvm]abstract fun open(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>): Stringopen override fun open(signedURL: String?): String openRewrite [jvm]abstract fun openRewrite(p0: StorageRpc.RewriteRequest): StorageRpc.RewriteResponse patch [jvm]open override fun patch(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?open override fun patch(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject? patchAcl [jvm]open override fun patchAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun patchAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl patchDefaultAcl [jvm]open override fun patchDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl read [jvm]abstract fun read(p0: StorageObject, p1: MutableMap<StorageRpc.Option, *>, p2: Long, p3: OutputStream): Longopen override fun read(from: StorageObject?, options: Map<StorageRpc.Option, *>?, position: Long, bytes: Int): Tuple<String, ByteArray> setIamPolicy [jvm]open override fun setIamPolicy(bucket: String?, policy: Policy?, options: Map<StorageRpc.Option, *>?): Policy testIamPermissions [jvm]open override fun testIamPermissions(bucket: String, permissions: List<String>, options: Map<StorageRpc.Option, *>): TestIamPermissionsResponse updateHmacKey [jvm]open override fun updateHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata write [jvm]abstract fun write(p0: String, p1: ByteArray, p2: Int, p3: Long, p4: Int, p5: Boolean) writeWithResponse [jvm]open override fun writeWithResponse(p0: String?, p1: ByteArray?, p2: Int, p3: Long, p4: Int, p5: Boolean): StorageObject"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/-base-custom-storage-rpc/","title":"BaseCustomStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/BaseCustomStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/-base-custom-storage-rpc/#basecustomstoragerpc","title":"BaseCustomStorageRpc","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/compose/","title":"compose - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/compose
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/compose/#compose","title":"compose","text":"[jvm]\\ open override fun compose(sources: Iterable<StorageObject>?, target: StorageObject?, targetOptions: Map<StorageRpc.Option, *>?): StorageObject
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/continue-rewrite/","title":"continueRewrite - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/continueRewrite
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/continue-rewrite/#continuerewrite","title":"continueRewrite","text":"[jvm]\\ open override fun continueRewrite(previousResponse: StorageRpc.RewriteResponse): StorageRpc.RewriteResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-acl/","title":"createAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-acl/#createacl","title":"createAcl","text":"[jvm]\\ open override fun createAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl
open override fun createAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-batch/","title":"createBatch - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createBatch
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-batch/#createbatch","title":"createBatch","text":"[jvm]\\ open override fun createBatch(): RpcBatch
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-default-acl/","title":"createDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-default-acl/#createdefaultacl","title":"createDefaultAcl","text":"[jvm]\\ open override fun createDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-hmac-key/","title":"createHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-hmac-key/#createhmackey","title":"createHmacKey","text":"[jvm]\\ open override fun createHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-notification/","title":"createNotification - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/createNotification
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create-notification/#createnotification","title":"createNotification","text":"[jvm]\\ open override fun createNotification(bucket: String?, notification: Notification?): Notification
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create/","title":"create - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/create
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/create/#create","title":"create","text":"[jvm]\\ open override fun create(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-acl/","title":"deleteAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-acl/#deleteacl","title":"deleteAcl","text":"[jvm]\\ open override fun deleteAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): Boolean
open override fun deleteAcl(bucket: String?, object: String?, generation: Long?, entity: String?): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-default-acl/","title":"deleteDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-default-acl/#deletedefaultacl","title":"deleteDefaultAcl","text":"[jvm]\\ open override fun deleteDefaultAcl(bucket: String?, entity: String?): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-hmac-key/","title":"deleteHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-hmac-key/#deletehmackey","title":"deleteHmacKey","text":"[jvm]\\ open override fun deleteHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-notification/","title":"deleteNotification - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/deleteNotification
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete-notification/#deletenotification","title":"deleteNotification","text":"[jvm]\\ open override fun deleteNotification(bucket: String?, notification: String?): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete/","title":"delete - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/delete
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/delete/#delete","title":"delete","text":"[jvm]\\ open override fun delete(bucket: Bucket, options: Map<StorageRpc.Option, *>): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-acl/","title":"getAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-acl/#getacl","title":"getAcl","text":"[jvm]\\ open override fun getAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): BucketAccessControl
open override fun getAcl(bucket: String?, obj: String?, generation: Long?, entity: String?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-current-upload-offset/","title":"getCurrentUploadOffset - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getCurrentUploadOffset
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-current-upload-offset/#getcurrentuploadoffset","title":"getCurrentUploadOffset","text":"[jvm]\\ open override fun getCurrentUploadOffset(p0: String?): Long
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-default-acl/","title":"getDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-default-acl/#getdefaultacl","title":"getDefaultAcl","text":"[jvm]\\ open override fun getDefaultAcl(bucket: String?, entity: String?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-hmac-key/","title":"getHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-hmac-key/#gethmackey","title":"getHmacKey","text":"[jvm]\\ open override fun getHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-iam-policy/","title":"getIamPolicy - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getIamPolicy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-iam-policy/#getiampolicy","title":"getIamPolicy","text":"[jvm]\\ open override fun getIamPolicy(bucket: String?, options: Map<StorageRpc.Option, *>?): Policy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-service-account/","title":"getServiceAccount - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/getServiceAccount
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get-service-account/#getserviceaccount","title":"getServiceAccount","text":"[jvm]\\ open override fun getServiceAccount(projectId: String?): ServiceAccount
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get/","title":"get - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/get
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-acls/","title":"listAcls - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listAcls
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-acls/#listacls","title":"listAcls","text":"[jvm]\\ open override fun listAcls(bucket: String?, options: Map<StorageRpc.Option, *>?): List<BucketAccessControl>
open override fun listAcls(bucket: String?, obj: String?, generation: Long?): List<ObjectAccessControl>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-default-acls/","title":"listDefaultAcls - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listDefaultAcls
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-default-acls/#listdefaultacls","title":"listDefaultAcls","text":"[jvm]\\ open override fun listDefaultAcls(bucket: String?): MutableList<ObjectAccessControl>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-hmac-keys/","title":"listHmacKeys - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listHmacKeys
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-hmac-keys/#listhmackeys","title":"listHmacKeys","text":"[jvm]\\ open override fun listHmacKeys(p0: MutableMap<StorageRpc.Option, *>?): Tuple<String, MutableIterable<HmacKeyMetadata>>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-notifications/","title":"listNotifications - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/listNotifications
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list-notifications/#listnotifications","title":"listNotifications","text":"[jvm]\\ open override fun listNotifications(bucket: String?): List<Notification>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list/","title":"list - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/list
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/list/#list","title":"list","text":"[jvm]\\ open override fun list(options: Map<StorageRpc.Option, *>?): Tuple<String, Iterable<Bucket>>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/lock-retention-policy/","title":"lockRetentionPolicy - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/lockRetentionPolicy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/lock-retention-policy/#lockretentionpolicy","title":"lockRetentionPolicy","text":"[jvm]\\ open override fun lockRetentionPolicy(bucket: Bucket?, options: Map<StorageRpc.Option, *>?): Bucket
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/open/","title":"open - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/open
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/open/#open","title":"open","text":"[jvm]\\ open override fun open(signedURL: String?): String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-acl/","title":"patchAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/patchAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-acl/#patchacl","title":"patchAcl","text":"[jvm]\\ open override fun patchAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl
open override fun patchAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-default-acl/","title":"patchDefaultAcl - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/patchDefaultAcl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch-default-acl/#patchdefaultacl","title":"patchDefaultAcl","text":"[jvm]\\ open override fun patchDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch/","title":"patch - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/patch
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/patch/#patch","title":"patch","text":"[jvm]\\ open override fun patch(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?
open override fun patch(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/read/","title":"read - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/read
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/read/#read","title":"read","text":"[jvm]\\ open override fun read(from: StorageObject?, options: Map<StorageRpc.Option, *>?, position: Long, bytes: Int): Tuple<String, ByteArray>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/set-iam-policy/","title":"setIamPolicy - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/setIamPolicy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/set-iam-policy/#setiampolicy","title":"setIamPolicy","text":"[jvm]\\ open override fun setIamPolicy(bucket: String?, policy: Policy?, options: Map<StorageRpc.Option, *>?): Policy
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/test-iam-permissions/","title":"testIamPermissions - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/testIamPermissions
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/test-iam-permissions/#testiampermissions","title":"testIamPermissions","text":"[jvm]\\ open override fun testIamPermissions(bucket: String, permissions: List<String>, options: Map<StorageRpc.Option, *>): TestIamPermissionsResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/update-hmac-key/","title":"updateHmacKey - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/updateHmacKey
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/update-hmac-key/#updatehmackey","title":"updateHmacKey","text":"[jvm]\\ open override fun updateHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/write-with-response/","title":"writeWithResponse - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/BaseCustomStorageRpc/writeWithResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-base-custom-storage-rpc/write-with-response/#writewithresponse","title":"writeWithResponse","text":"[jvm]\\ open override fun writeWithResponse(p0: String?, p1: ByteArray?, p2: Int, p3: Long, p4: Int, p5: Boolean): StorageObject
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/","title":"LocalStorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/#localstorageconfig","title":"LocalStorageConfig","text":"[jvm]\\ data class LocalStorageConfig(val data_dir: String)
Configuration for local (emulated) storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/#constructors","title":"Constructors","text":"LocalStorageConfig [jvm]constructor(data_dir: String)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/#properties","title":"Properties","text":"Name Summary data_dir [jvm]val data_dir: String"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/-local-storage-config/","title":"LocalStorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageConfig/LocalStorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/-local-storage-config/#localstorageconfig","title":"LocalStorageConfig","text":"[jvm]\\ constructor(data_dir: String)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/data_dir/","title":"data_dir - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageConfig/data_dir
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-config/data_dir/#data_dir","title":"data_dir","text":"[jvm]\\ val data_dir: String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/","title":"LocalStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/#localstoragerpc","title":"LocalStorageRpc","text":"[jvm]\\ class LocalStorageRpc@JvmOverloadsconstructor(root: Path, moshi: Moshi = defaultKotlinMoshi) : BaseCustomStorageRpc
Implementation of StorageRpc that is backed by local disk storage. Useful for running in development mode on local machines, since there is no GCS emulator available. Files are stored with the generation version appended as an extension suffix, with a symlink existing for the latest generation. To preserve GCS atomicity semantics, progressive uploads are handled by storing the interim uploaded data in a temporary file based off the latest generation, then doing a rename to the new generation once the upload is complete.
The implementation uses file locks to support multiple local processes accessing the same storage directory. Whenever a blob is updated, the local store will acquire an exclusive lock on a corresponding lock file, releasing that lock when the update is complete (or when the process dies). It\u2019s slightly more complicated since we need to deal with the possibility that writer stops partway through without the process failing; in those cases we don\u2019t want to prevent subsequent updates from other processes.
Write process:
acquire a read lock
read metadata constraints, and create a new target metadata object for the next generation
release read lock
create a new temp file for receiving the update
generate an upload id, save the temp file location + target metadata + constraints in-memory associated with the upload id
write to the temp file for that upload id
acquire a write lock, read the latest metadata for the blob and re-check constraints to make sure nothing changed underneath (e.g. a concurrent upload for that blob did not complete)
copy from the temp file to a new file in the content directory, appending the new generation number. This is done as an atomic move + overwrite
write updated metadata to the metadata file. This is done as an atomic move + overwrite. Until this is complete, the new version of the content is not accessible to readers.
release the write lock
remove the content file for the prior generation
If a writer fails between open and finish, all that happens is we have abandoned temp files If a writer fails after moving the temp file to the contents directory but before updating the metadata, then we have a bad content file for that generation sitting in the content directory. Since the metadata hasn\u2019t been updated with the new generation, this content is not readable, and a subsequent write will overwrite it. If a writer fails after updating the metadata but before removing the prior generation content file, we\u2019ll have left an abandoned content file. A garbage collection process can be run to clean these up eventually
Read process
Clients use etags to detect when a blob is updated while a progressive download is in place; the etag returned from a prior read is sent in subsequent reads. We simply use the generation number as the etag value.
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/#constructors","title":"Constructors","text":"LocalStorageRpc [jvm]@JvmOverloadsconstructor(root: Path, moshi: Moshi = defaultKotlinMoshi)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/#functions","title":"Functions","text":"Name Summary compose [jvm]open override fun compose(sources: Iterable<StorageObject>?, target: StorageObject?, targetOptions: Map<StorageRpc.Option, *>?): StorageObject continueRewrite [jvm]open override fun continueRewrite(previousResponse: StorageRpc.RewriteResponse): StorageRpc.RewriteResponse create [jvm]open override fun create(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucketopen override fun create(obj: StorageObject, content: InputStream, options: Map<StorageRpc.Option, *>): StorageObject? createAcl [jvm]open override fun createAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun createAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl createBatch [jvm]open override fun createBatch(): RpcBatch createDefaultAcl [jvm]open override fun createDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl createHmacKey [jvm]open override fun createHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKey createNotification [jvm]open override fun createNotification(bucket: String?, notification: Notification?): Notification delete [jvm]open override fun delete(bucket: Bucket, options: Map<StorageRpc.Option, *>): Booleanopen override fun delete(obj: StorageObject, options: Map<StorageRpc.Option, *>): Boolean deleteAcl [jvm]open override fun deleteAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): Booleanopen override fun deleteAcl(bucket: String?, object: String?, generation: Long?, entity: String?): Boolean deleteDefaultAcl [jvm]open override fun deleteDefaultAcl(bucket: String?, entity: String?): Boolean deleteHmacKey [jvm]open override fun deleteHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?) deleteNotification [jvm]open override fun deleteNotification(bucket: String?, notification: String?): Boolean get [jvm]open operator override fun get(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?open operator override fun get(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject? getAcl [jvm]open override fun getAcl(bucket: String?, entity: String?, options: Map<StorageRpc.Option, *>?): BucketAccessControlopen override fun getAcl(bucket: String?, obj: String?, generation: Long?, entity: String?): ObjectAccessControl getCurrentUploadOffset [jvm]open override fun getCurrentUploadOffset(p0: String?): Long getDefaultAcl [jvm]open override fun getDefaultAcl(bucket: String?, entity: String?): ObjectAccessControl getHmacKey [jvm]open override fun getHmacKey(p0: String?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata getIamPolicy [jvm]open override fun getIamPolicy(bucket: String?, options: Map<StorageRpc.Option, *>?): Policy getServiceAccount [jvm]open override fun getServiceAccount(projectId: String?): ServiceAccount list [jvm]open override fun list(options: Map<StorageRpc.Option, *>?): Tuple<String, Iterable<Bucket>>open override fun list(bucket: String, options: Map<StorageRpc.Option, *>): Tuple<String, Iterable<StorageObject>> listAcls [jvm]open override fun listAcls(bucket: String?, options: Map<StorageRpc.Option, *>?): List<BucketAccessControl>open override fun listAcls(bucket: String?, obj: String?, generation: Long?): List<ObjectAccessControl> listDefaultAcls [jvm]open override fun listDefaultAcls(bucket: String?): MutableList<ObjectAccessControl> listHmacKeys [jvm]open override fun listHmacKeys(p0: MutableMap<StorageRpc.Option, *>?): Tuple<String, MutableIterable<HmacKeyMetadata>> listNotifications [jvm]open override fun listNotifications(bucket: String?): List<Notification> load [jvm]open override fun load(obj: StorageObject, options: Map<StorageRpc.Option, *>): ByteArray lockRetentionPolicy [jvm]open override fun lockRetentionPolicy(bucket: Bucket?, options: Map<StorageRpc.Option, *>?): Bucket open [jvm]open override fun open(signedURL: String?): Stringopen override fun open(obj: StorageObject, options: Map<StorageRpc.Option, *>): String openRewrite [jvm]open override fun openRewrite(request: StorageRpc.RewriteRequest): StorageRpc.RewriteResponse patch [jvm]open override fun patch(bucket: Bucket, options: Map<StorageRpc.Option, *>): Bucket?open override fun patch(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject? patchAcl [jvm]open override fun patchAcl(acl: ObjectAccessControl?): ObjectAccessControlopen override fun patchAcl(acl: BucketAccessControl?, options: Map<StorageRpc.Option, *>?): BucketAccessControl patchDefaultAcl [jvm]open override fun patchDefaultAcl(acl: ObjectAccessControl?): ObjectAccessControl read [jvm]open override fun read(from: StorageObject?, options: Map<StorageRpc.Option, *>?, position: Long, bytes: Int): Tuple<String, ByteArray>open override fun read(from: StorageObject, options: Map<StorageRpc.Option, *>, zposition: Long, outputStream: OutputStream): Long setIamPolicy [jvm]open override fun setIamPolicy(bucket: String?, policy: Policy?, options: Map<StorageRpc.Option, *>?): Policy testIamPermissions [jvm]open override fun testIamPermissions(bucket: String, permissions: List<String>, options: Map<StorageRpc.Option, *>): TestIamPermissionsResponse updateHmacKey [jvm]open override fun updateHmacKey(p0: HmacKeyMetadata?, p1: MutableMap<StorageRpc.Option, *>?): HmacKeyMetadata write [jvm]open override fun write(uploadId: String, toWrite: ByteArray, toWriteOffset: Int, destOffset: Long, length: Int, last: Boolean) writeWithResponse [jvm]open override fun writeWithResponse(p0: String?, p1: ByteArray?, p2: Int, p3: Long, p4: Int, p5: Boolean): StorageObject"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/-local-storage-rpc/","title":"LocalStorageRpc - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/LocalStorageRpc
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/-local-storage-rpc/#localstoragerpc","title":"LocalStorageRpc","text":"[jvm]\\
@JvmOverloads
constructor(root: Path, moshi: Moshi = defaultKotlinMoshi)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/create/","title":"create - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/create
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/create/#create","title":"create","text":"[jvm]\\ open override fun create(obj: StorageObject, content: InputStream, options: Map<StorageRpc.Option, *>): StorageObject?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/delete/","title":"delete - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/delete
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/delete/#delete","title":"delete","text":"[jvm]\\ open override fun delete(obj: StorageObject, options: Map<StorageRpc.Option, *>): Boolean
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/get/","title":"get - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/get
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(obj: StorageObject, options: Map<StorageRpc.Option, *>): StorageObject?
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/list/","title":"list - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/list
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/list/#list","title":"list","text":"[jvm]\\ open override fun list(bucket: String, options: Map<StorageRpc.Option, *>): Tuple<String, Iterable<StorageObject>>
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/load/","title":"load - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/load
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/load/#load","title":"load","text":"[jvm]\\ open override fun load(obj: StorageObject, options: Map<StorageRpc.Option, *>): ByteArray
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open-rewrite/","title":"openRewrite - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/openRewrite
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open-rewrite/#openrewrite","title":"openRewrite","text":"[jvm]\\ open override fun openRewrite(request: StorageRpc.RewriteRequest): StorageRpc.RewriteResponse
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open/","title":"open - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/open
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/open/#open","title":"open","text":"[jvm]\\ open override fun open(obj: StorageObject, options: Map<StorageRpc.Option, *>): String
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/read/","title":"read - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/read
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/read/#read","title":"read","text":"[jvm]\\ open override fun read(from: StorageObject, options: Map<StorageRpc.Option, *>, zposition: Long, outputStream: OutputStream): Long
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/write/","title":"write - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/LocalStorageRpc/write
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-local-storage-rpc/write/#write","title":"write","text":"[jvm]\\ open override fun write(uploadId: String, toWrite: ByteArray, toWriteOffset: Int, destOffset: Long, length: Int, last: Boolean)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/","title":"StorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/#storageconfig","title":"StorageConfig","text":"[jvm]\\ data class StorageConfig@JvmOverloadsconstructor(val use_local_storage: Boolean = false, val local_storage: LocalStorageConfig? = null, val transport: TransportConfig = TransportConfig()) : Config
Configuration for talking to Google Cloud Storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/#constructors","title":"Constructors","text":"StorageConfig [jvm]@JvmOverloadsconstructor(use_local_storage: Boolean = false, local_storage: LocalStorageConfig? = null, transport: TransportConfig = TransportConfig())"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/#properties","title":"Properties","text":"Name Summary local_storage [jvm]val local_storage: LocalStorageConfig? = null transport [jvm]val transport: TransportConfig use_local_storage [jvm]val use_local_storage: Boolean = false"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/-storage-config/","title":"StorageConfig - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/StorageConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/-storage-config/#storageconfig","title":"StorageConfig","text":"[jvm]\\
@JvmOverloads
constructor(use_local_storage: Boolean = false, local_storage: LocalStorageConfig? = null, transport: TransportConfig = TransportConfig())
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/local_storage/","title":"local_storage - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/local_storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/local_storage/#local_storage","title":"local_storage","text":"[jvm]\\ val local_storage: LocalStorageConfig? = null
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/transport/","title":"transport - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/transport
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/transport/#transport","title":"transport","text":"[jvm]\\ val transport: TransportConfig
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/use_local_storage/","title":"use_local_storage - Misk","text":"//misk-gcp/misk.cloud.gcp.storage/StorageConfig/use_local_storage
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.storage/-storage-config/use_local_storage/#use_local_storage","title":"use_local_storage","text":"[jvm]\\ val use_local_storage: Boolean = false
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/#types","title":"Types","text":"Name Summary TracingLoggingEnhancer [jvm]class TracingLoggingEnhancer : LoggingEnhancerAdd this enhancer to your project\u2019s Logback configuration to add trace ids to logs generated by GCP\u2019s LoggingAppender"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/","title":"TracingLoggingEnhancer - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing/TracingLoggingEnhancer
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/#tracingloggingenhancer","title":"TracingLoggingEnhancer","text":"[jvm]\\ class TracingLoggingEnhancer : LoggingEnhancer
Add this enhancer to your project\u2019s Logback configuration to add trace ids to logs generated by GCP\u2019s LoggingAppender
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/#constructors","title":"Constructors","text":"TracingLoggingEnhancer [jvm]constructor()"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/#functions","title":"Functions","text":"Name Summary enhanceLogEntry [jvm]open override fun enhanceLogEntry(builder: LogEntry.Builder)fun enhanceLogEntry(tracer: Tracer, builder: LogEntry.Builder)"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/-tracing-logging-enhancer/","title":"TracingLoggingEnhancer - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing/TracingLoggingEnhancer/TracingLoggingEnhancer
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/-tracing-logging-enhancer/#tracingloggingenhancer","title":"TracingLoggingEnhancer","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/enhance-log-entry/","title":"enhanceLogEntry - Misk","text":"//misk-gcp/misk.cloud.gcp.tracing/TracingLoggingEnhancer/enhanceLogEntry
"},{"location":"0.x/misk-gcp/misk-gcp/misk.cloud.gcp.tracing/-tracing-logging-enhancer/enhance-log-entry/#enhancelogentry","title":"enhanceLogEntry","text":"[jvm]\\ open override fun enhanceLogEntry(builder: LogEntry.Builder)
fun enhanceLogEntry(tracer: Tracer, builder: LogEntry.Builder)
"},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-gcp/misk.logging
"},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/#functions","title":"Functions","text":"Name Summary enableStackDriverLogging [jvm]fun enableStackDriverLogging(config: StackDriverLoggingConfig)Configures Misk to send application logs to StackDriver. If credentials are required to send logging, set the GOOGLE_APPLICATION_CREDENTIALS environment variable with the path to the JSON credentials."},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/enable-stack-driver-logging/","title":"enableStackDriverLogging - Misk","text":"//misk-gcp/misk.logging/enableStackDriverLogging
"},{"location":"0.x/misk-gcp/misk-gcp/misk.logging/enable-stack-driver-logging/#enablestackdriverlogging","title":"enableStackDriverLogging","text":"[jvm]\\ fun enableStackDriverLogging(config: StackDriverLoggingConfig)
Configures Misk to send application logs to StackDriver. If credentials are required to send logging, set the GOOGLE_APPLICATION_CREDENTIALS environment variable with the path to the JSON credentials.
"},{"location":"0.x/misk-grpc-reflect/","title":"misk-grpc-reflect - Misk","text":"//misk-grpc-reflect
"},{"location":"0.x/misk-grpc-reflect/#misk-grpc-reflect","title":"misk-grpc-reflect","text":""},{"location":"0.x/misk-grpc-reflect/#packages","title":"Packages","text":"Name misk.grpc.reflect"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/","title":"Package-level declarations - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/#types","title":"Types","text":"Name Summary GrpcReflectModule [jvm]class GrpcReflectModule : KAbstractModuleImplements gRPC reflect for all gRPC actions installed in this Misk application. ServerReflectionApi [jvm]class ServerReflectionApi@Injectconstructor(reflector: SchemaReflector) : ServerReflectionServerReflectionInfoBlockingServer, WebAction"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/","title":"GrpcReflectModule - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/#grpcreflectmodule","title":"GrpcReflectModule","text":"[jvm]\\ class GrpcReflectModule : KAbstractModule
Implements gRPC reflect for all gRPC actions installed in this Misk application.
This relies on .proto files being included in the .jar file. If they\u2019re missing, reflection won\u2019t work for them.
//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/GrpcReflectModule
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/-grpc-reflect-module/#grpcreflectmodule","title":"GrpcReflectModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-schema/","title":"provideSchema - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/provideSchema
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-schema/#provideschema","title":"provideSchema","text":"[jvm]\\
@Provides
@Singleton
fun provideSchema(webActions: List<WebActionEntry>): Schema
Interrogate the installed gRPC actions and create a Wire schema from that.
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-service-reflector/","title":"provideServiceReflector - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/provideServiceReflector
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/provide-service-reflector/#provideservicereflector","title":"provideServiceReflector","text":"[jvm]\\
@Provides
@Singleton
fun provideServiceReflector(schema: Schema): SchemaReflector
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/-companion/","title":"Companion - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/GrpcReflectModule/Companion
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-grpc-reflect-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/","title":"ServerReflectionApi - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/ServerReflectionApi
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/#serverreflectionapi","title":"ServerReflectionApi","text":"[jvm]\\ class ServerReflectionApi@Injectconstructor(reflector: SchemaReflector) : ServerReflectionServerReflectionInfoBlockingServer, WebAction
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/#constructors","title":"Constructors","text":"ServerReflectionApi [jvm]@Injectconstructor(reflector: SchemaReflector)"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/#functions","title":"Functions","text":"Name Summary ServerReflectionInfo [jvm]open override fun ServerReflectionInfo(requests: MessageSource<ServerReflectionRequest>, responses: MessageSink<ServerReflectionResponse>)The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server."},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-api/","title":"ServerReflectionApi - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/ServerReflectionApi/ServerReflectionApi
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-api/#serverreflectionapi","title":"ServerReflectionApi","text":"[jvm]\\
@Inject
constructor(reflector: SchemaReflector)
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-info/","title":"ServerReflectionInfo - Misk","text":"//misk-grpc-reflect/misk.grpc.reflect/ServerReflectionApi/ServerReflectionInfo
"},{"location":"0.x/misk-grpc-reflect/misk-grpc-reflect/misk.grpc.reflect/-server-reflection-api/-server-reflection-info/#serverreflectioninfo","title":"ServerReflectionInfo","text":"[jvm]\\ open override fun ServerReflectionInfo(requests: MessageSource<ServerReflectionRequest>, responses: MessageSink<ServerReflectionResponse>)
The reflection service is structured as a bidirectional stream, ensuring all related requests go to a single server.
"},{"location":"0.x/misk-grpc-tests/","title":"misk-grpc-tests - Misk","text":"//misk-grpc-tests
"},{"location":"0.x/misk-grpc-tests/#misk-grpc-tests","title":"misk-grpc-tests","text":""},{"location":"0.x/misk-grpc-tests/#packages","title":"Packages","text":"Name misk.grpc.miskclient misk.grpc.miskserver misk.grpc.protocclient misk.grpc.protocserver"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/#types","title":"Types","text":"Name Summary MiskGrpcClientModule [jvm]class MiskGrpcClientModule(val url: HttpUrl) : KAbstractModule RouteGuideCallCounter [jvm]@Singletonclass RouteGuideCallCounter@Injectconstructor : ClientNetworkInterceptor.FactorySample network interceptor to confirm they\u2019re executed for outbound gRPC calls."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/","title":"MiskGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#miskgrpcclientmodule","title":"MiskGrpcClientModule","text":"[jvm]\\ class MiskGrpcClientModule(val url: HttpUrl) : KAbstractModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#constructors","title":"Constructors","text":"MiskGrpcClientModule [jvm]constructor(url: HttpUrl)"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#properties","title":"Properties","text":"Name Summary url [jvm]val url: HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideHttpClientsConfig [jvm]@Provides@Singletonfun provideHttpClientsConfig(): HttpClientsConfig"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/-misk-grpc-client-module/","title":"MiskGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule/MiskGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/-misk-grpc-client-module/#miskgrpcclientmodule","title":"MiskGrpcClientModule","text":"[jvm]\\ constructor(url: HttpUrl)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/provide-http-clients-config/","title":"provideHttpClientsConfig - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule/provideHttpClientsConfig
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/provide-http-clients-config/#providehttpclientsconfig","title":"provideHttpClientsConfig","text":"[jvm]\\
@Provides
@Singleton
fun provideHttpClientsConfig(): HttpClientsConfig
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/url/","title":"url - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/MiskGrpcClientModule/url
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-misk-grpc-client-module/url/#url","title":"url","text":"[jvm]\\ val url: HttpUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/","title":"RouteGuideCallCounter - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#routeguidecallcounter","title":"RouteGuideCallCounter","text":"[jvm]\\ @Singleton
class RouteGuideCallCounter@Injectconstructor : ClientNetworkInterceptor.Factory
Sample network interceptor to confirm they\u2019re executed for outbound gRPC calls.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#constructors","title":"Constructors","text":"RouteGuideCallCounter [jvm]@Injectconstructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#properties","title":"Properties","text":"Name Summary actionNameToCount [jvm]val actionNameToCount: MutableMap<String, AtomicInteger>"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/#functions","title":"Functions","text":"Name Summary counter [jvm]fun counter(name: String): AtomicInteger create [jvm]open override fun create(action: ClientAction): ClientNetworkInterceptor?"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/-route-guide-call-counter/","title":"RouteGuideCallCounter - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/RouteGuideCallCounter
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/-route-guide-call-counter/#routeguidecallcounter","title":"RouteGuideCallCounter","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/action-name-to-count/","title":"actionNameToCount - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/actionNameToCount
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/action-name-to-count/#actionnametocount","title":"actionNameToCount","text":"[jvm]\\ val actionNameToCount: MutableMap<String, AtomicInteger>
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/counter/","title":"counter - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/counter
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/counter/#counter","title":"counter","text":"[jvm]\\ fun counter(name: String): AtomicInteger
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/create/","title":"create - Misk","text":"//misk-grpc-tests/misk.grpc.miskclient/RouteGuideCallCounter/create
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskclient/-route-guide-call-counter/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: ClientAction): ClientNetworkInterceptor?
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/#types","title":"Types","text":"Name Summary GetFeatureGrpcAction [jvm]class GetFeatureGrpcAction@Injectconstructor : WebAction, RouteGuideGetFeatureBlockingServer RouteChatGrpcAction [jvm]@Singletonclass RouteChatGrpcAction@Injectconstructor : WebAction, RouteGuideRouteChatBlockingServer RouteGuideMiskServiceModule [jvm]class RouteGuideMiskServiceModule : KAbstractModuleA module that runs a Misk gRPC server: Wire protos and a Jetty backend."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/","title":"GetFeatureGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/GetFeatureGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/#getfeaturegrpcaction","title":"GetFeatureGrpcAction","text":"[jvm]\\ class GetFeatureGrpcAction@Injectconstructor : WebAction, RouteGuideGetFeatureBlockingServer
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/#constructors","title":"Constructors","text":"GetFeatureGrpcAction [jvm]@Injectconstructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/#functions","title":"Functions","text":"Name Summary GetFeature [jvm]open override fun GetFeature(request: Point): FeatureA simple RPC."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature-grpc-action/","title":"GetFeatureGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/GetFeatureGrpcAction/GetFeatureGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature-grpc-action/#getfeaturegrpcaction","title":"GetFeatureGrpcAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature/","title":"GetFeature - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/GetFeatureGrpcAction/GetFeature
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-get-feature-grpc-action/-get-feature/#getfeature","title":"GetFeature","text":"[jvm]\\ open override fun GetFeature(request: Point): Feature
A simple RPC.
Obtains the feature at a given position.
A feature with an empty name is returned if there\u2019s no feature at the given position.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/","title":"RouteChatGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#routechatgrpcaction","title":"RouteChatGrpcAction","text":"[jvm]\\ @Singleton
class RouteChatGrpcAction@Injectconstructor : WebAction, RouteGuideRouteChatBlockingServer
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#constructors","title":"Constructors","text":"RouteChatGrpcAction [jvm]@Injectconstructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#properties","title":"Properties","text":"Name Summary welcomeMessage [jvm]var welcomeMessage: String?"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/#functions","title":"Functions","text":"Name Summary RouteChat [jvm]open override fun RouteChat(request: MessageSource<RouteNote>, response: MessageSink<RouteNote>)A Bidirectional streaming RPC."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat-grpc-action/","title":"RouteChatGrpcAction - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction/RouteChatGrpcAction
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat-grpc-action/#routechatgrpcaction","title":"RouteChatGrpcAction","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat/","title":"RouteChat - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction/RouteChat
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/-route-chat/#routechat","title":"RouteChat","text":"[jvm]\\ open override fun RouteChat(request: MessageSource<RouteNote>, response: MessageSink<RouteNote>)
A Bidirectional streaming RPC.
Accepts a stream of RouteNotes sent while a route is being traversed, while receiving other RouteNotes (e.g. from other users).
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/welcome-message/","title":"welcomeMessage - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteChatGrpcAction/welcomeMessage
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-chat-grpc-action/welcome-message/#welcomemessage","title":"welcomeMessage","text":"[jvm]\\ var welcomeMessage: String?
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/","title":"RouteGuideMiskServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteGuideMiskServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/#routeguidemiskservicemodule","title":"RouteGuideMiskServiceModule","text":"[jvm]\\ class RouteGuideMiskServiceModule : KAbstractModule
A module that runs a Misk gRPC server: Wire protos and a Jetty backend.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/#constructors","title":"Constructors","text":"RouteGuideMiskServiceModule [jvm]constructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideServerUrl [jvm]@Provides@Named(value = \"grpc server\")fun provideServerUrl(jetty: JettyService): HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/-route-guide-misk-service-module/","title":"RouteGuideMiskServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteGuideMiskServiceModule/RouteGuideMiskServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/-route-guide-misk-service-module/#routeguidemiskservicemodule","title":"RouteGuideMiskServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/provide-server-url/","title":"provideServerUrl - Misk","text":"//misk-grpc-tests/misk.grpc.miskserver/RouteGuideMiskServiceModule/provideServerUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.miskserver/-route-guide-misk-service-module/provide-server-url/#provideserverurl","title":"provideServerUrl","text":"[jvm]\\
@Provides
@Named(value = \"grpc server\")
fun provideServerUrl(jetty: JettyService): HttpUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/#types","title":"Types","text":"Name Summary GrpcChannelFactory [jvm]@Singletonclass GrpcChannelFactory@Injectconstructor(val resourceLoader: ResourceLoader) ProtocGrpcClientModule [jvm]class ProtocGrpcClientModule : KAbstractModule"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/","title":"GrpcChannelFactory - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#grpcchannelfactory","title":"GrpcChannelFactory","text":"[jvm]\\ @Singleton
class GrpcChannelFactory@Injectconstructor(val resourceLoader: ResourceLoader)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#constructors","title":"Constructors","text":"GrpcChannelFactory [jvm]@Injectconstructor(resourceLoader: ResourceLoader)"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#properties","title":"Properties","text":"Name Summary resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/#functions","title":"Functions","text":"Name Summary createClientChannel [jvm]@JvmOverloadsfun createClientChannel(serverAddress: SocketAddress, serverCertResource: String = \"classpath:/ssl/server_cert.pem\"): ManagedChannel"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/-grpc-channel-factory/","title":"GrpcChannelFactory - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory/GrpcChannelFactory
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/-grpc-channel-factory/#grpcchannelfactory","title":"GrpcChannelFactory","text":"[jvm]\\
@Inject
constructor(resourceLoader: ResourceLoader)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/create-client-channel/","title":"createClientChannel - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory/createClientChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/create-client-channel/#createclientchannel","title":"createClientChannel","text":"[jvm]\\
@JvmOverloads
fun createClientChannel(serverAddress: SocketAddress, serverCertResource: String = \"classpath:/ssl/server_cert.pem\"): ManagedChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/resource-loader/","title":"resourceLoader - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/GrpcChannelFactory/resourceLoader
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-grpc-channel-factory/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/","title":"ProtocGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/ProtocGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/#protocgrpcclientmodule","title":"ProtocGrpcClientModule","text":"[jvm]\\ class ProtocGrpcClientModule : KAbstractModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/#constructors","title":"Constructors","text":"ProtocGrpcClientModule [jvm]constructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideChannel [jvm]@Provides@Singletonfun provideChannel(@Named(value = \"grpc server\")url: HttpUrl, grpcChannelFactory: GrpcChannelFactory): ManagedChannel"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/-protoc-grpc-client-module/","title":"ProtocGrpcClientModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/ProtocGrpcClientModule/ProtocGrpcClientModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/-protoc-grpc-client-module/#protocgrpcclientmodule","title":"ProtocGrpcClientModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/provide-channel/","title":"provideChannel - Misk","text":"//misk-grpc-tests/misk.grpc.protocclient/ProtocGrpcClientModule/provideChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocclient/-protoc-grpc-client-module/provide-channel/#providechannel","title":"provideChannel","text":"[jvm]\\
@Provides
@Singleton
fun provideChannel(@Named(value = \"grpc server\")url: HttpUrl, grpcChannelFactory: GrpcChannelFactory): ManagedChannel
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/","title":"Package-level declarations - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/#types","title":"Types","text":"Name Summary ProtocGrpcService [jvm]@Singletonclass ProtocGrpcService@Injectconstructor(services: List<BindableService>, resourceLoader: ResourceLoader) : AbstractIdleServiceRuns a standard gRPC server: generated protoc protos and a Netty backend. This isn\u2019t how Misk does gRPC, but it should be useful to confirm interoperability. RouteGuideProtocServiceModule [jvm]class RouteGuideProtocServiceModule : KAbstractModuleA module that runs a standard gRPC server: generated protoc protos and a Netty backend."},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/","title":"ProtocGrpcService - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#protocgrpcservice","title":"ProtocGrpcService","text":"[jvm]\\ @Singleton
class ProtocGrpcService@Injectconstructor(services: List<BindableService>, resourceLoader: ResourceLoader) : AbstractIdleService
Runs a standard gRPC server: generated protoc protos and a Netty backend. This isn\u2019t how Misk does gRPC, but it should be useful to confirm interoperability.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#constructors","title":"Constructors","text":"ProtocGrpcService [jvm]@Injectconstructor(services: List<BindableService>, resourceLoader: ResourceLoader)"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#properties","title":"Properties","text":"Name Summary server [jvm]lateinit var server: Server url [jvm]val url: HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/-protoc-grpc-service/","title":"ProtocGrpcService - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService/ProtocGrpcService
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/-protoc-grpc-service/#protocgrpcservice","title":"ProtocGrpcService","text":"[jvm]\\
@Inject
constructor(services: List<BindableService>, resourceLoader: ResourceLoader)
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/server/","title":"server - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService/server
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/server/#server","title":"server","text":"[jvm]\\ lateinit var server: Server
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/url/","title":"url - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/ProtocGrpcService/url
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-protoc-grpc-service/url/#url","title":"url","text":"[jvm]\\ val url: HttpUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/","title":"RouteGuideProtocServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/RouteGuideProtocServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/#routeguideprotocservicemodule","title":"RouteGuideProtocServiceModule","text":"[jvm]\\ class RouteGuideProtocServiceModule : KAbstractModule
A module that runs a standard gRPC server: generated protoc protos and a Netty backend.
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/#constructors","title":"Constructors","text":"RouteGuideProtocServiceModule [jvm]constructor()"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideServerUrl [jvm]@Provides@Named(value = \"grpc server\")fun provideServerUrl(protocGrpcService: ProtocGrpcService): HttpUrl"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/-route-guide-protoc-service-module/","title":"RouteGuideProtocServiceModule - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/RouteGuideProtocServiceModule/RouteGuideProtocServiceModule
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/-route-guide-protoc-service-module/#routeguideprotocservicemodule","title":"RouteGuideProtocServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/provide-server-url/","title":"provideServerUrl - Misk","text":"//misk-grpc-tests/misk.grpc.protocserver/RouteGuideProtocServiceModule/provideServerUrl
"},{"location":"0.x/misk-grpc-tests/misk-grpc-tests/misk.grpc.protocserver/-route-guide-protoc-service-module/provide-server-url/#provideserverurl","title":"provideServerUrl","text":"[jvm]\\
@Provides
@Named(value = \"grpc server\")
fun provideServerUrl(protocGrpcService: ProtocGrpcService): HttpUrl
"},{"location":"0.x/misk-hibernate/","title":"misk-hibernate - Misk","text":"//misk-hibernate
"},{"location":"0.x/misk-hibernate/#misk-hibernate","title":"misk-hibernate","text":""},{"location":"0.x/misk-hibernate/#packages","title":"Packages","text":"Name misk.hibernate misk.hibernate.annotation misk.hibernate.migrate misk.hibernate.pagination"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/#types","title":"Types","text":"Name Summary AggregationType [jvm]enum AggregationType : Enum<AggregationType> Available aggregations which can be applied to a single value Select query, or a Property of a projection. BindPolicy [jvm]enum BindPolicy : Enum<BindPolicy> Control how we register listeners. Check [jvm]typealias Check = misk.jdbc.Check Constraint [jvm]annotation class Constraint(val path: String, val operator: Operator = Operator.EQ)Annotates a function on a Query interface to indicate which column (or path of columns) it constrains and using which Operator. DbChild [jvm]interface DbChild<R : DbRoot<R>, T : DbChild<R, T>> : DbSharded<R, T> Marker interface for sharded entities that stay with their root inside an entity group. Entity group children will always stay inside the same shard regardless of shard splits and so on. That means transactions inside an entity group is always safe. A typical sharding strategy has aDbCustomer as a root and all of the entities that belong to that customer as children. DbEntity [jvm]interface DbEntity<T : DbEntity<T>>Marker interface for persistent entities. Ensures that only persistent entities can be passed into Session methods. DbRoot [jvm]interface DbRoot<T : DbRoot<T>> : DbSharded<T, T> Marker interface for sharded entity group roots. Entity group roots are spread out across shards they can also have children in the form of DbChild subclasses that always stay in the same shard as their roots. A typical root is for example DbCustomer. DbSharded [jvm]interface DbSharded<R : DbRoot<R>, T : DbSharded<R, T>> : DbEntity<T> Marker interface for sharded persistent entities. Do not subclass directly, instead subclass either DbRoot for entity group roots or DbChild for entity group children. DbTimestampedEntity [jvm]interface DbTimestampedEntityThis complements DbEntity for entities that keep updated_at and created_at timestamps. DbUnsharded [jvm]interface DbUnsharded<T : DbUnsharded<T>> : DbEntity<T> Marker interface for persistent entities that have a bounded growth and do not require sharding. Fetch [jvm]annotation class Fetch(val path: String = \"\", val joinType: JoinType = LEFT, val forProjection: Boolean = false)Annotates a function on a Query interface to specify that the association at the given path should be fetched in a single query. The type of join used will be specified by joinType, and defaults to a LEFT JOIN. Gid [jvm]@Embeddabledata class Gid<R : DbRoot<R>, T : DbSharded<R, T>>(val rootId: Id<R>, val id: Id<T>) : SerializableEntity group id, maps to two long columns one for the root id and one for the row GidGenerator [jvm]class GidGenerator : AbstractPostInsertGenerator, Configurable Group [jvm]annotation class Group(val paths: Array<String> = [])Annotates a function on a Query interface to indicate that the results should be grouped by the given paths. This is most useful with Projections and aggregations. HibernateEntityModule [jvm]abstract class HibernateEntityModule(qualifier: KClass<out Annotation>) : KAbstractModuleBinds hibernate entities and event listeners intended for the Transacter annotated by qualifier. HibernateExceptionLogLevelConfig [jvm]data class HibernateExceptionLogLevelConfig@JvmOverloadsconstructor(val log_level: Level = Level.WARN) : ConfigConfigures the log Level for a HibernateException. HibernateModule [jvm]class HibernateModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig()) : KAbstractModule Id [jvm]data class Id<T : DbEntity<T>>(val id: Long) : Serializable, Comparable<Id<T>> Type-safe persistent identifier, mapped to a long column. IdType [jvm]class IdType : UserType, ResultSetIdentifierConsumerBinds Id<*> in the DB to a bigint in MySQL. JsonColumn [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class JsonColumnPut this on a column field to get Hibernate to persist it as JSON using Moshi. It will use the injector\u2019s configured Moshi instance. Use misk.moshi.MoshiModule to customize. Operator [jvm]enum Operator : Enum<Operator> OrBuilder [jvm]interface OrBuilder<Q : Query<*>>This functional interface accepts a set of options. Each option lambda is executed within the scope of a query. It is inappropriate to call methods like list() and uniqueResult() on this query. Order [jvm]annotation class Order(val path: String, val asc: Boolean = true)Annotates a function on a Query interface to indicate by which columns to order the results. Defaults to ascending order. Path [jvm]data class Path(val schema: String?, val table: String?, val column: String?) PostCommitHookFailedException [jvm]class PostCommitHookFailedException(cause: Throwable) : ExceptionPostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook Projection [jvm]interface ProjectionMarker interface for query projections. Property [jvm]annotation class Property(val path: String, val aggregation: AggregationType = AggregationType.NONE)Annotates a parameter of a Projection data class to indicate which column (or path of columns) to populate the parameter with. ProtoColumn [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class ProtoColumnPut this on a column field for a class generated by Wire to get Hibernate to persist with protobuf serialization. Query [jvm]interface Query<T>Base class for SQL queries. RetryTransactionException [jvm]class RetryTransactionException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : ExceptionThrown to explicitly trigger a retry, subject to retry limits and config such as noRetries(). SecretColumn [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class SecretColumn(val keyName: String, val indexable: Boolean = true)SecretColumn is an annotation used to get Hibernate to encrypt a field before writing it to the database. Select [jvm]annotation class Select(val path: String = \"\", val aggregation: AggregationType = AggregationType.NONE)Annotates a function on a Query interface to execute a SELECT query. Functions with this annotation must return a List to fetch multiple rows results, or a regular type to fetch a unique result. Session [jvm]interface Session : Session Transacter [jvm]interface TransacterProvides explicit block-based transaction demarcation. TransacterService [jvm]interface TransacterService : ServiceMarker interface for services that provide database transactors. TransformedType [jvm]@Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])annotation class TransformedType(val transformer: KClass<out Transformer>, val targetType: KClass<*>)TransformedType is a meta-annotation for assigning arbitrary transformers to entity fields. Use it to annotate attributes that will mark a field to be transformed. Transformer [jvm]abstract class Transformer(val context: TransformerContext) TransformerContext [jvm]data class TransformerContext(val tableName: String, val columnName: String, var arguments: Map<String, >, var field: KClass<>) ValidationReport [jvm]data class ValidationReport(val schemas: Set<String>, val tables: Set<String>, val columns: Set<String>) VitessDialect [jvm]class VitessDialect : MySQL57Dialect"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/#functions","title":"Functions","text":"Name Summary allowFullScatter [jvm]inline fun <T, Q : Query<T>> Q.allowFullScatter(): Q allowTableScan [jvm]inline fun <T, Q : Query<T>> Q.allowTableScan(): Q constraint [jvm]fun <T, Q : Query<T>> Q.constraint(block: CriteriaBuilder.(root: Root<*>) -> Predicate): QEquivalent to Query.addConstraint, but takes the CriteriaBuilder as a receiver and returns this. This may be easier to use with method chaining. failSafeRead [jvm]fun <T> Transacter.failSafeRead(block: (session: Session) -> T): TRuns a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.[jvm]fun <T> Transacter.failSafeRead(shard: Shard, block: (session: Session) -> T): T getByType [jvm]fun ResultSet.getByType(klass: KClass<*>?, columnLabel: String): Serializable? load [jvm]inline fun <T : DbEntity<T>> Session.load(id: Id<T>): T loadOrNull [jvm]inline fun <T : DbEntity<T>> Session.loadOrNull(id: Id<T>): T? loadSharded [jvm]inline fun <R : DbRoot<R>, S : DbSharded<R, S>> Session.loadSharded(gid: Gid<R, S>): S newQuery [jvm]inline fun <T : Query<*>> Query.Factory.newQuery(): T or [jvm]inline fun <T, Q : Query<T>> Q.or(lambda: OrBuilder<Q>.() -> Unit): QCollects options that are all OR\u2019d together. If any are true the predicate matches. queryHint [jvm]fun <T, Q : Query<T>> Q.queryHint(hint: String): QAdds query hint to the query. (Chainable version of Query.addQueryHint.) setByType [jvm]fun PreparedStatement.setByType(klass: KClass<*>?, index: Int, value: Any) shards [jvm]fun Transacter.shards(): Set<Shard>fun Transacter.shards(keyspace: Keyspace): Collection<Shard> transaction [jvm]fun <T> Transacter.transaction(shard: Shard, block: (session: Session) -> T): TCommits a transaction with operations of block."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-full-scatter/","title":"allowFullScatter - Misk","text":"//misk-hibernate/misk.hibernate/allowFullScatter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-full-scatter/#allowfullscatter","title":"allowFullScatter","text":"[jvm]\\ inline fun <T, Q : Query<T>> Q.allowFullScatter(): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-table-scan/","title":"allowTableScan - Misk","text":"//misk-hibernate/misk.hibernate/allowTableScan
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/allow-table-scan/#allowtablescan","title":"allowTableScan","text":"[jvm]\\ inline fun <T, Q : Query<T>> Q.allowTableScan(): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/constraint/","title":"constraint - Misk","text":"//misk-hibernate/misk.hibernate/constraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/constraint/#constraint","title":"constraint","text":"[jvm]\\ fun <T, Q : Query<T>> Q.constraint(block: CriteriaBuilder.(root: Root<*>) -> Predicate): Q
Equivalent to Query.addConstraint, but takes the CriteriaBuilder as a receiver and returns this. This may be easier to use with method chaining.
The root parameter should be used to select which property of the target entity to match against.
queryFactory.newQuery<OperatorsMovieQuery>()\n .constraint { root -> like(root.get(\"name\"), \"Jurassic%\") }\n .count(session)\n//misk-hibernate/misk.hibernate/failSafeRead
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/fail-safe-read/#failsaferead","title":"failSafeRead","text":"[jvm]\\ fun <T> Transacter.failSafeRead(block: (session: Session) -> T): T
Runs a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.
[jvm]\\ fun <T> Transacter.failSafeRead(shard: Shard, block: (session: Session) -> T): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/get-by-type/","title":"getByType - Misk","text":"//misk-hibernate/misk.hibernate/getByType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/get-by-type/#getbytype","title":"getByType","text":"[jvm]\\ fun ResultSet.getByType(klass: KClass<*>?, columnLabel: String): Serializable?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-or-null/","title":"loadOrNull - Misk","text":"//misk-hibernate/misk.hibernate/loadOrNull
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-or-null/#loadornull","title":"loadOrNull","text":"[jvm]\\ inline fun <T : DbEntity<T>> Session.loadOrNull(id: Id<T>): T?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-sharded/","title":"loadSharded - Misk","text":"//misk-hibernate/misk.hibernate/loadSharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load-sharded/#loadsharded","title":"loadSharded","text":"[jvm]\\ inline fun <R : DbRoot<R>, S : DbSharded<R, S>> Session.loadSharded(gid: Gid<R, S>): S
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load/","title":"load - Misk","text":"//misk-hibernate/misk.hibernate/load
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/load/#load","title":"load","text":"[jvm]\\ inline fun <T : DbEntity<T>> Session.load(id: Id<T>): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/new-query/","title":"newQuery - Misk","text":"//misk-hibernate/misk.hibernate/newQuery
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/new-query/#newquery","title":"newQuery","text":"[jvm]\\ inline fun <T : Query<*>> Query.Factory.newQuery(): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/or/","title":"or - Misk","text":"//misk-hibernate/misk.hibernate/or
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/or/#or","title":"or","text":"[jvm]\\ inline fun <T, Q : Query<T>> Q.or(lambda: OrBuilder<Q>.() -> Unit): Q
Collects options that are all OR\u2019d together. If any are true the predicate matches.
queryFactory.newQuery<OperatorsMovieQuery>()\n .or {\n option { name(\"Rocky 1\") }\n option { name(\"Rocky 3\") }\n }\n .list()\nEach option has a list of constraints that are themselves AND\u2019d together.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/query-hint/","title":"queryHint - Misk","text":"//misk-hibernate/misk.hibernate/queryHint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/query-hint/#queryhint","title":"queryHint","text":"[jvm]\\ fun <T, Q : Query<T>> Q.queryHint(hint: String): Q
Adds query hint to the query. (Chainable version of Query.addQueryHint.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/set-by-type/","title":"setByType - Misk","text":"//misk-hibernate/misk.hibernate/setByType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/set-by-type/#setbytype","title":"setByType","text":"[jvm]\\ fun PreparedStatement.setByType(klass: KClass<*>?, index: Int, value: Any)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/shards/","title":"shards - Misk","text":"//misk-hibernate/misk.hibernate/shards
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/shards/#shards","title":"shards","text":"[jvm]\\ fun Transacter.shards(): Set<Shard>
fun Transacter.shards(keyspace: Keyspace): Collection<Shard>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/transaction/","title":"transaction - Misk","text":"//misk-hibernate/misk.hibernate/transaction
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/transaction/#transaction","title":"transaction","text":"[jvm]\\ fun <T> Transacter.transaction(shard: Shard, block: (session: Session) -> T): T
Commits a transaction with operations of block.
New objects must be persisted with an explicit call to Session.save. Updates are performed implicitly by modifying objects returned from a query.
For example if we were to save a new movie to a movie database, and update the revenue of an existing movie:
transacter.transaction { session ->\n // Saving a new entity to the database needs an explicit call.\n val starWars = DbMovie(name = \"Star Wars\", year = \"1977\", revenue = 775_400_000)\n session.save(starWars)\n\n // Updating a movie from the database is done by modifying the object.\n // Changes are saved implicitly.\n val movie: DbMovie = queryFactory.newQuery<MovieQuery>().id(id).uniqueResult(session)!!\n movie.revenue = 100_000_000\n}\n//misk-hibernate/misk.hibernate/AggregationType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#aggregationtype","title":"AggregationType","text":"[jvm]\\ enum AggregationType : Enum<AggregationType>
Available aggregations which can be applied to a single value Select query, or a Property of a projection.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#entries","title":"Entries","text":"NONE [jvm]NONENo aggregation is applied. Likeselect column. AVG [jvm]AVGLike select avg(column). COUNT [jvm]COUNTLike select count(column). COUNT_DISTINCT [jvm]COUNT_DISTINCTLike select count(distinct column). MAX [jvm]MAXLike select max(column). MIN [jvm]MINLike select min(column). SUM [jvm]SUMLike select sum(column)."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<AggregationType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AggregationTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AggregationType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/entries/","title":"entries - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/entries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AggregationType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/value-of/","title":"valueOf - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/valueOf
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AggregationType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/values/","title":"values - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/values
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AggregationType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-a-v-g/","title":"AVG - Misk","text":"//misk-hibernate/misk.hibernate/AggregationType/AVG
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-a-v-g/#avg","title":"AVG","text":"[jvm]\\ AVG
Like select avg(column).
//misk-hibernate/misk.hibernate/AggregationType/COUNT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-c-o-u-n-t/#count","title":"COUNT","text":"[jvm]\\ COUNT
Like select count(column).
//misk-hibernate/misk.hibernate/AggregationType/COUNT_DISTINCT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-c-o-u-n-t_-d-i-s-t-i-n-c-t/#count_distinct","title":"COUNT_DISTINCT","text":"[jvm]\\ COUNT_DISTINCT
Like select count(distinct column).
//misk-hibernate/misk.hibernate/AggregationType/MAX
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-m-a-x/#max","title":"MAX","text":"[jvm]\\ MAX
Like select max(column).
//misk-hibernate/misk.hibernate/AggregationType/MIN
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-m-i-n/#min","title":"MIN","text":"[jvm]\\ MIN
Like select min(column).
//misk-hibernate/misk.hibernate/AggregationType/NONE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-n-o-n-e/#none","title":"NONE","text":"[jvm]\\ NONE
No aggregation is applied. Like select column.
//misk-hibernate/misk.hibernate/AggregationType/SUM
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-aggregation-type/-s-u-m/#sum","title":"SUM","text":"[jvm]\\ SUM
Like select sum(column).
//misk-hibernate/misk.hibernate/BindPolicy
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#bindpolicy","title":"BindPolicy","text":"[jvm]\\ enum BindPolicy : Enum<BindPolicy>
Control how we register listeners.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#entries","title":"Entries","text":"PREPEND [jvm]PREPEND REPLACE [jvm]REPLACE APPEND [jvm]APPEND"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<BindPolicy>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): BindPolicyReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<BindPolicy>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/entries/","title":"entries - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/entries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<BindPolicy>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/value-of/","title":"valueOf - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/valueOf
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): BindPolicy
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/values/","title":"values - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/values
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<BindPolicy>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-a-p-p-e-n-d/","title":"APPEND - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/APPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-a-p-p-e-n-d/#append","title":"APPEND","text":"[jvm]\\ APPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-a-p-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-p-r-e-p-e-n-d/","title":"PREPEND - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/PREPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-p-r-e-p-e-n-d/#prepend","title":"PREPEND","text":"[jvm]\\ PREPEND
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-p-r-e-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-r-e-p-l-a-c-e/","title":"REPLACE - Misk","text":"//misk-hibernate/misk.hibernate/BindPolicy/REPLACE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-r-e-p-l-a-c-e/#replace","title":"REPLACE","text":"[jvm]\\ REPLACE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-bind-policy/-r-e-p-l-a-c-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-check/","title":"Check - Misk","text":"//misk-hibernate/misk.hibernate/Check
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-check/#check","title":"Check","text":"[jvm]\\ typealias Check = misk.jdbc.Check
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/","title":"Index","text":"//misk-hibernate/misk.hibernate/Constraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/#constraint","title":"Constraint","text":"[jvm]\\ annotation class Constraint(val path: String, val operator: Operator = Operator.EQ)
Annotates a function on a Query interface to indicate which column (or path of columns) it constrains and using which Operator.
You can think of Constraints as the rules used to build the where clause of a SQL query.
For example, you can query movies by title with a method like this:
@Constraint(path = \"name\") // Uses EQ as the default operator.\nfun matchesTitle(title: String): MovieQuery\nOr query for movies released after a certain date with a method like this:
@Constraint(path = \"release_date\", operator = Operator.GT)\nfun releasedAfter(date: LocalDate): MovieQuery\n//misk-hibernate/misk.hibernate/Constraint/operator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/operator/#operator","title":"operator","text":"[jvm]\\ val operator: Operator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Constraint/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-constraint/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-child/","title":"DbChild - Misk","text":"//misk-hibernate/misk.hibernate/DbChild
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-child/#dbchild","title":"DbChild","text":"[jvm]\\ interface DbChild<R : DbRoot<R>, T : DbChild<R, T>> : DbSharded<R, T>
Marker interface for sharded entities that stay with their root inside an entity group. Entity group children will always stay inside the same shard regardless of shard splits and so on. That means transactions inside an entity group is always safe. A typical sharding strategy has a DbCustomer as a root and all of the entities that belong to that customer as children.
//misk-hibernate/misk.hibernate/DbChild/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-child/id/#id","title":"id","text":"[jvm]\\ open override val id: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/","title":"DbEntity - Misk","text":"//misk-hibernate/misk.hibernate/DbEntity
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/#dbentity","title":"DbEntity","text":"interface DbEntity<T : DbEntity<T>>
Marker interface for persistent entities. Ensures that only persistent entities can be passed into Session methods.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/#inheritors","title":"Inheritors","text":"DbSharded DbUnsharded"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: Id<T>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/id/","title":"id - Misk","text":"//misk-hibernate/misk.hibernate/DbEntity/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-entity/id/#id","title":"id","text":"[jvm]\\ abstract val id: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/","title":"DbRoot - Misk","text":"//misk-hibernate/misk.hibernate/DbRoot
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/#dbroot","title":"DbRoot","text":"[jvm]\\ interface DbRoot<T : DbRoot<T>> : DbSharded<T, T>
Marker interface for sharded entity group roots. Entity group roots are spread out across shards they can also have children in the form of DbChild subclasses that always stay in the same shard as their roots. A typical root is for example DbCustomer.
//misk-hibernate/misk.hibernate/DbRoot/gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/gid/#gid","title":"gid","text":"[jvm]\\ open override val gid: Gid<T, T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/root-id/","title":"rootId - Misk","text":"//misk-hibernate/misk.hibernate/DbRoot/rootId
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-root/root-id/#rootid","title":"rootId","text":"[jvm]\\ open override val rootId: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/","title":"DbSharded - Misk","text":"//misk-hibernate/misk.hibernate/DbSharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/#dbsharded","title":"DbSharded","text":"interface DbSharded<R : DbRoot<R>, T : DbSharded<R, T>> : DbEntity<T>
Marker interface for sharded persistent entities. Do not subclass directly, instead subclass either DbRoot for entity group roots or DbChild for entity group children.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/#inheritors","title":"Inheritors","text":"DbChild DbRoot"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/#properties","title":"Properties","text":"Name Summary gid [jvm]abstract val gid: Gid<R, T> id [jvm]abstract val id: Id<T> rootId [jvm]abstract val rootId: Id<R>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/gid/","title":"gid - Misk","text":"//misk-hibernate/misk.hibernate/DbSharded/gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/gid/#gid","title":"gid","text":"[jvm]\\ abstract val gid: Gid<R, T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/root-id/","title":"rootId - Misk","text":"//misk-hibernate/misk.hibernate/DbSharded/rootId
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-sharded/root-id/#rootid","title":"rootId","text":"[jvm]\\ abstract val rootId: Id<R>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/","title":"DbTimestampedEntity - Misk","text":"//misk-hibernate/misk.hibernate/DbTimestampedEntity
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/#dbtimestampedentity","title":"DbTimestampedEntity","text":"[jvm]\\ interface DbTimestampedEntity
This complements DbEntity for entities that keep updated_at and created_at timestamps.
Misk uses the application\u2019s clock time to set created_at and updated_at. We prefer the application\u2019s (ie. JVM\u2019s) clock over the database\u2019s clock because only the application\u2019s clock can be faked in tests.
To use timestamped entities first add two columns in your CREATE TABLE statement. You may also add an optional index on updated_at:
CREATE TABLE movies(\n id bigint NOT NULL PRIMARY KEY AUTO_INCREMENT,\n created_at timestamp(3) NOT NULL DEFAULT NOW(3),\n updated_at timestamp(3) NOT NULL DEFAULT NOW(3) ON UPDATE NOW(3),\n ...\n KEY `idx_updated_at` (`updated_at`)\n);\nThe above SQL uses timestamp(3) and NOW(3) to get millisecond precision which interoperates nicely with Java. Although we declare DEFAULT NOW(3) and ON UPDATE NOW(3), these don\u2019t apply to writes from Hibernate because it always provides a value explicitly.
Next implement this interface and add the following declarations to your entity class:
@Entity\n@Table(name = \"movies\")\nclass DbMovie() : DbEntity<DbMovie>, DbTimestampedEntity {\n\n ...\n\n @Column\n override lateinit var updated_at: Instant\n\n @Column\n override lateinit var created_at: Instant\n\n ...\n\n}\nThe timestamp listener will automatically populate these values on save and update. (Incidentally, the @Columns are not marked nullable = false because the timestamp listener is triggered after the nullability check.)
//misk-hibernate/misk.hibernate/DbTimestampedEntity/created_at
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/created_at/#created_at","title":"created_at","text":"[jvm]\\ abstract var created_at: Instant
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/updated_at/","title":"updated_at - Misk","text":"//misk-hibernate/misk.hibernate/DbTimestampedEntity/updated_at
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-timestamped-entity/updated_at/#updated_at","title":"updated_at","text":"[jvm]\\ abstract var updated_at: Instant
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-unsharded/","title":"DbUnsharded - Misk","text":"//misk-hibernate/misk.hibernate/DbUnsharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-unsharded/#dbunsharded","title":"DbUnsharded","text":"[jvm]\\ interface DbUnsharded<T : DbUnsharded<T>> : DbEntity<T>
Marker interface for persistent entities that have a bounded growth and do not require sharding.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-db-unsharded/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: Id<T>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/","title":"Fetch - Misk","text":"//misk-hibernate/misk.hibernate/Fetch
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/#fetch","title":"Fetch","text":"[jvm]\\ annotation class Fetch(val path: String = \"\", val joinType: JoinType = LEFT, val forProjection: Boolean = false)
Annotates a function on a Query interface to specify that the association at the given path should be fetched in a single query. The type of join used will be specified by joinType, and defaults to a LEFT JOIN.
If the query will result in a Projection, and does not need to get the entire entity graph, set forProjection to true. This will make the query operate as a regular JOIN query, instead of a JOIN FETCH query.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/#properties","title":"Properties","text":"Name Summary forProjection [jvm]val forProjection: Boolean = false joinType [jvm]val joinType: JoinType path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/for-projection/","title":"forProjection - Misk","text":"//misk-hibernate/misk.hibernate/Fetch/forProjection
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/for-projection/#forprojection","title":"forProjection","text":"[jvm]\\ val forProjection: Boolean = false
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/join-type/","title":"joinType - Misk","text":"//misk-hibernate/misk.hibernate/Fetch/joinType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/join-type/#jointype","title":"joinType","text":"[jvm]\\ val joinType: JoinType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Fetch/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-fetch/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/","title":"Gid - Misk","text":"//misk-hibernate/misk.hibernate/Gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#gid","title":"Gid","text":"[jvm]\\ @Embeddable
data class Gid<R : DbRoot<R>, T : DbSharded<R, T>>(val rootId: Id<R>, val id: Id<T>) : Serializable
Entity group id, maps to two long columns one for the root id and one for the row
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#constructors","title":"Constructors","text":"Gid [jvm]constructor(rootId: Id<R>, id: Id<T>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#properties","title":"Properties","text":"Name Summary id [jvm]val id: Id<T> rootId [jvm]val rootId: Id<R>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/#functions","title":"Functions","text":"Name Summary shardKey [jvm]fun shardKey(): Shard.Key toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/-gid/","title":"Gid - Misk","text":"//misk-hibernate/misk.hibernate/Gid/Gid
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/-gid/#gid","title":"Gid","text":"[jvm]\\ constructor(rootId: Id<R>, id: Id<T>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/id/","title":"id - Misk","text":"//misk-hibernate/misk.hibernate/Gid/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/id/#id","title":"id","text":"[jvm]\\ val id: Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/root-id/","title":"rootId - Misk","text":"//misk-hibernate/misk.hibernate/Gid/rootId
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/root-id/#rootid","title":"rootId","text":"[jvm]\\ val rootId: Id<R>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/shard-key/","title":"shardKey - Misk","text":"//misk-hibernate/misk.hibernate/Gid/shardKey
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/shard-key/#shardkey","title":"shardKey","text":"[jvm]\\ fun shardKey(): Shard.Key
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/to-string/","title":"toString - Misk","text":"//misk-hibernate/misk.hibernate/Gid/toString
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/","title":"GidGenerator - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/#gidgenerator","title":"GidGenerator","text":"[jvm]\\ class GidGenerator : AbstractPostInsertGenerator, Configurable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/#constructors","title":"Constructors","text":"GidGenerator [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/#functions","title":"Functions","text":"Name Summary configure [jvm]open override fun configure(type: Type, params: Properties, serviceRegistry: ServiceRegistry) determineBulkInsertionIdentifierGenerationSelectFragment [jvm]open override fun determineBulkInsertionIdentifierGenerationSelectFragment(p0: SqlStringGenerationContext): Stringopen fun determineBulkInsertionIdentifierGenerationSelectFragment(p0: Dialect): String generate [jvm]open override fun generate(p0: SharedSessionContractImplementor, p1: Any): Serializable getInsertGeneratedIdentifierDelegate [jvm]open override fun getInsertGeneratedIdentifierDelegate(persister: PostInsertIdentityPersister, dialect: Dialect, isGetGeneratedKeysEnabled: Boolean): InsertGeneratedIdentifierDelegate initialize [jvm]open fun initialize(p0: SqlStringGenerationContext) registerExportables [jvm]open override fun registerExportables(p0: Database) supportsBulkInsertionIdentifierGeneration [jvm]open override fun supportsBulkInsertionIdentifierGeneration(): Boolean supportsJdbcBatchInserts [jvm]open override fun supportsJdbcBatchInserts(): Boolean"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/-gid-generator/","title":"GidGenerator - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator/GidGenerator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/-gid-generator/#gidgenerator","title":"GidGenerator","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/configure/","title":"configure - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator/configure
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/configure/#configure","title":"configure","text":"[jvm]\\ open override fun configure(type: Type, params: Properties, serviceRegistry: ServiceRegistry)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/get-insert-generated-identifier-delegate/","title":"getInsertGeneratedIdentifierDelegate - Misk","text":"//misk-hibernate/misk.hibernate/GidGenerator/getInsertGeneratedIdentifierDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-gid-generator/get-insert-generated-identifier-delegate/#getinsertgeneratedidentifierdelegate","title":"getInsertGeneratedIdentifierDelegate","text":"[jvm]\\ open override fun getInsertGeneratedIdentifierDelegate(persister: PostInsertIdentityPersister, dialect: Dialect, isGetGeneratedKeysEnabled: Boolean): InsertGeneratedIdentifierDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/","title":"Group - Misk","text":"//misk-hibernate/misk.hibernate/Group
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/#group","title":"Group","text":"[jvm]\\ annotation class Group(val paths: Array<String> = [])
Annotates a function on a Query interface to indicate that the results should be grouped by the given paths. This is most useful with Projections and aggregations.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/#properties","title":"Properties","text":"Name Summary paths [jvm]val paths: Array<String>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/paths/","title":"paths - Misk","text":"//misk-hibernate/misk.hibernate/Group/paths
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-group/paths/#paths","title":"paths","text":"[jvm]\\ val paths: Array<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/","title":"HibernateEntityModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateEntityModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/#hibernateentitymodule","title":"HibernateEntityModule","text":"[jvm]\\ abstract class HibernateEntityModule(qualifier: KClass<out Annotation>) : KAbstractModule
Binds hibernate entities and event listeners intended for the Transacter annotated by qualifier.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/#constructors","title":"Constructors","text":"HibernateEntityModule [jvm]constructor(qualifier: KClass<out Annotation>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) configureHibernate [jvm]abstract fun configureHibernate()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/-hibernate-entity-module/","title":"HibernateEntityModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateEntityModule/HibernateEntityModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/-hibernate-entity-module/#hibernateentitymodule","title":"HibernateEntityModule","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/configure-hibernate/","title":"configureHibernate - Misk","text":"//misk-hibernate/misk.hibernate/HibernateEntityModule/configureHibernate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-entity-module/configure-hibernate/#configurehibernate","title":"configureHibernate","text":"[jvm]\\ abstract fun configureHibernate()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/","title":"HibernateExceptionLogLevelConfig - Misk","text":"//misk-hibernate/misk.hibernate/HibernateExceptionLogLevelConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/#hibernateexceptionloglevelconfig","title":"HibernateExceptionLogLevelConfig","text":"[jvm]\\ data class HibernateExceptionLogLevelConfig@JvmOverloadsconstructor(val log_level: Level = Level.WARN) : Config
Configures the log Level for a HibernateException.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/#constructors","title":"Constructors","text":"HibernateExceptionLogLevelConfig [jvm]@JvmOverloadsconstructor(log_level: Level = Level.WARN)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/#properties","title":"Properties","text":"Name Summary log_level [jvm]val log_level: Level"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/-hibernate-exception-log-level-config/","title":"HibernateExceptionLogLevelConfig - Misk","text":"//misk-hibernate/misk.hibernate/HibernateExceptionLogLevelConfig/HibernateExceptionLogLevelConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/-hibernate-exception-log-level-config/#hibernateexceptionloglevelconfig","title":"HibernateExceptionLogLevelConfig","text":"[jvm]\\
@JvmOverloads
constructor(log_level: Level = Level.WARN)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/log_level/","title":"log_level - Misk","text":"//misk-hibernate/misk.hibernate/HibernateExceptionLogLevelConfig/log_level
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-exception-log-level-config/log_level/#log_level","title":"log_level","text":"[jvm]\\ val log_level: Level
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/","title":"HibernateModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#hibernatemodule","title":"HibernateModule","text":"[jvm]\\ class HibernateModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig()) : KAbstractModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#constructors","title":"Constructors","text":"HibernateModule [jvm]constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig)constructor(qualifier: KClass<out Annotation>, readerQualifier: KClass<out Annotation>, cluster: DataSourceClusterConfig, databasePool: DatabasePool = RealDatabasePool)@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig())"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig databasePool [jvm]val databasePool: DatabasePool readerConfig [jvm]val readerConfig: DataSourceConfig?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/-hibernate-module/","title":"HibernateModule - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/HibernateModule
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/-hibernate-module/#hibernatemodule","title":"HibernateModule","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)
constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig)
constructor(qualifier: KClass<out Annotation>, readerQualifier: KClass<out Annotation>, cluster: DataSourceClusterConfig, databasePool: DatabasePool = RealDatabasePool)
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, logLevelConfig: HibernateExceptionLogLevelConfig = HibernateExceptionLogLevelConfig())
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/config/","title":"config - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/config
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/database-pool/","title":"databasePool - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/databasePool
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/database-pool/#databasepool","title":"databasePool","text":"[jvm]\\ val databasePool: DatabasePool
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/reader-config/","title":"readerConfig - Misk","text":"//misk-hibernate/misk.hibernate/HibernateModule/readerConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-hibernate-module/reader-config/#readerconfig","title":"readerConfig","text":"[jvm]\\ val readerConfig: DataSourceConfig?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/","title":"Id - Misk","text":"//misk-hibernate/misk.hibernate/Id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#id","title":"Id","text":"[jvm]\\ data class Id<T : DbEntity<T>>(val id: Long) : Serializable, Comparable<Id<T>>
Type-safe persistent identifier, mapped to a long column.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#constructors","title":"Constructors","text":"Id [jvm]constructor(id: Long)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#properties","title":"Properties","text":"Name Summary id [jvm]val id: Long"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Id<T>): Int shardKey [jvm]fun shardKey(): Shard.Key toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/-id/","title":"Id - Misk","text":"//misk-hibernate/misk.hibernate/Id/Id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/-id/#id","title":"Id","text":"[jvm]\\ constructor(id: Long)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/compare-to/","title":"compareTo - Misk","text":"//misk-hibernate/misk.hibernate/Id/compareTo
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Id<T>): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/id/","title":"id - Misk","text":"//misk-hibernate/misk.hibernate/Id/id
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/id/#id","title":"id","text":"[jvm]\\ val id: Long
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/shard-key/","title":"shardKey - Misk","text":"//misk-hibernate/misk.hibernate/Id/shardKey
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/shard-key/#shardkey","title":"shardKey","text":"[jvm]\\ fun shardKey(): Shard.Key
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/to-string/","title":"toString - Misk","text":"//misk-hibernate/misk.hibernate/Id/toString
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/","title":"IdType - Misk","text":"//misk-hibernate/misk.hibernate/IdType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/#idtype","title":"IdType","text":"[jvm]\\ class IdType : UserType, ResultSetIdentifierConsumer
Binds Id<*> in the DB to a bigint in MySQL.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/#constructors","title":"Constructors","text":"IdType [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/#functions","title":"Functions","text":"Name Summary assemble [jvm]open override fun assemble(cached: Serializable, owner: Any?): Any consumeIdentifier [jvm]open override fun consumeIdentifier(resultSet: ResultSet): Serializable deepCopy [jvm]open override fun deepCopy(value: Any?): Any? disassemble [jvm]open override fun disassemble(value: Any?): Long equals [jvm]open override fun equals(x: Any?, y: Any?): Boolean hashCode [jvm]open override fun hashCode(x: Any?): Int isMutable [jvm]open override fun isMutable(): Boolean nullSafeGet [jvm]open override fun nullSafeGet(rs: ResultSet, names: Array<out String>, session: SharedSessionContractImplementor?, owner: Any?): Any? nullSafeSet [jvm]open override fun nullSafeSet(st: PreparedStatement, value: Any?, index: Int, session: SharedSessionContractImplementor?) replace [jvm]open override fun replace(original: Any, target: Any, owner: Any?): Any returnedClass [jvm]open override fun returnedClass(): Class<Id<*>> sqlTypes [jvm]open override fun sqlTypes(): IntArray"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/-id-type/","title":"IdType - Misk","text":"//misk-hibernate/misk.hibernate/IdType/IdType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/-id-type/#idtype","title":"IdType","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/assemble/","title":"assemble - Misk","text":"//misk-hibernate/misk.hibernate/IdType/assemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/assemble/#assemble","title":"assemble","text":"[jvm]\\ open override fun assemble(cached: Serializable, owner: Any?): Any
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/consume-identifier/","title":"consumeIdentifier - Misk","text":"//misk-hibernate/misk.hibernate/IdType/consumeIdentifier
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/consume-identifier/#consumeidentifier","title":"consumeIdentifier","text":"[jvm]\\ open override fun consumeIdentifier(resultSet: ResultSet): Serializable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/deep-copy/","title":"deepCopy - Misk","text":"//misk-hibernate/misk.hibernate/IdType/deepCopy
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/deep-copy/#deepcopy","title":"deepCopy","text":"[jvm]\\ open override fun deepCopy(value: Any?): Any?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/disassemble/","title":"disassemble - Misk","text":"//misk-hibernate/misk.hibernate/IdType/disassemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/disassemble/#disassemble","title":"disassemble","text":"[jvm]\\ open override fun disassemble(value: Any?): Long
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/equals/","title":"equals - Misk","text":"//misk-hibernate/misk.hibernate/IdType/equals
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/equals/#equals","title":"equals","text":"[jvm]\\ open override fun equals(x: Any?, y: Any?): Boolean
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/hash-code/","title":"hashCode - Misk","text":"//misk-hibernate/misk.hibernate/IdType/hashCode
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(x: Any?): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/is-mutable/","title":"isMutable - Misk","text":"//misk-hibernate/misk.hibernate/IdType/isMutable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/is-mutable/#ismutable","title":"isMutable","text":"[jvm]\\ open override fun isMutable(): Boolean
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-get/","title":"nullSafeGet - Misk","text":"//misk-hibernate/misk.hibernate/IdType/nullSafeGet
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-get/#nullsafeget","title":"nullSafeGet","text":"[jvm]\\ open override fun nullSafeGet(rs: ResultSet, names: Array<out String>, session: SharedSessionContractImplementor?, owner: Any?): Any?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-set/","title":"nullSafeSet - Misk","text":"//misk-hibernate/misk.hibernate/IdType/nullSafeSet
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/null-safe-set/#nullsafeset","title":"nullSafeSet","text":"[jvm]\\ open override fun nullSafeSet(st: PreparedStatement, value: Any?, index: Int, session: SharedSessionContractImplementor?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/replace/","title":"replace - Misk","text":"//misk-hibernate/misk.hibernate/IdType/replace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/replace/#replace","title":"replace","text":"[jvm]\\ open override fun replace(original: Any, target: Any, owner: Any?): Any
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/returned-class/","title":"returnedClass - Misk","text":"//misk-hibernate/misk.hibernate/IdType/returnedClass
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/returned-class/#returnedclass","title":"returnedClass","text":"[jvm]\\ open override fun returnedClass(): Class<Id<*>>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/sql-types/","title":"sqlTypes - Misk","text":"//misk-hibernate/misk.hibernate/IdType/sqlTypes
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-id-type/sql-types/#sqltypes","title":"sqlTypes","text":"[jvm]\\ open override fun sqlTypes(): IntArray
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-json-column/","title":"JsonColumn - Misk","text":"//misk-hibernate/misk.hibernate/JsonColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-json-column/#jsoncolumn","title":"JsonColumn","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class JsonColumn
Put this on a column field to get Hibernate to persist it as JSON using Moshi. It will use the injector\u2019s configured Moshi instance. Use misk.moshi.MoshiModule to customize.
It is an error to put this annotation on a mutable field. We don\u2019t defensively copy these when we read them out of the database.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/","title":"Operator - Misk","text":"//misk-hibernate/misk.hibernate/Operator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#operator","title":"Operator","text":"[jvm]\\ enum Operator : Enum<Operator>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#entries","title":"Entries","text":"LT [jvm]LTa < b LE [jvm]LEa <= b EQ [jvm]EQa = b EQ_OR_IS_NULL [jvm]EQ_OR_IS_NULLa = b if b is not null, a is null if b is null GE [jvm]GEa >= b GT [jvm]GTa > b NE [jvm]NEa != b IN [jvm]INa IN (b1, b2, b3, ...) NOT_IN [jvm]NOT_INa NOT IN (b1, b2, b3, ...) IS_NOT_NULL [jvm]IS_NOT_NULLa IS NOT NULL IS_NULL [jvm]IS_NULLa IS NULL"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Operator>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): OperatorReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Operator>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/entries/","title":"entries - Misk","text":"//misk-hibernate/misk.hibernate/Operator/entries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Operator>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/value-of/","title":"valueOf - Misk","text":"//misk-hibernate/misk.hibernate/Operator/valueOf
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Operator
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/values/","title":"values - Misk","text":"//misk-hibernate/misk.hibernate/Operator/values
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Operator>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-e-q/","title":"EQ - Misk","text":"//misk-hibernate/misk.hibernate/Operator/EQ
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-e-q/#eq","title":"EQ","text":"[jvm]\\ EQ
a = b
//misk-hibernate/misk.hibernate/Operator/EQ_OR_IS_NULL
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-e-q_-o-r_-i-s_-n-u-l-l/#eq_or_is_null","title":"EQ_OR_IS_NULL","text":"[jvm]\\ EQ_OR_IS_NULL
a = b if b is not null, a is null if b is null
//misk-hibernate/misk.hibernate/Operator/GE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-g-e/#ge","title":"GE","text":"[jvm]\\ GE
a >= b
//misk-hibernate/misk.hibernate/Operator/GT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-g-t/#gt","title":"GT","text":"[jvm]\\ GT
a > b
//misk-hibernate/misk.hibernate/Operator/IN
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-i-n/#in","title":"IN","text":"[jvm]\\ IN
a IN (b1, b2, b3, ...)
//misk-hibernate/misk.hibernate/Operator/IS_NOT_NULL
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-i-s_-n-o-t_-n-u-l-l/#is_not_null","title":"IS_NOT_NULL","text":"[jvm]\\ IS_NOT_NULL
a IS NOT NULL
//misk-hibernate/misk.hibernate/Operator/IS_NULL
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-i-s_-n-u-l-l/#is_null","title":"IS_NULL","text":"[jvm]\\ IS_NULL
a IS NULL
//misk-hibernate/misk.hibernate/Operator/LE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-l-e/#le","title":"LE","text":"[jvm]\\ LE
a <= b
//misk-hibernate/misk.hibernate/Operator/LT
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-l-t/#lt","title":"LT","text":"[jvm]\\ LT
a < b
//misk-hibernate/misk.hibernate/Operator/NE
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-n-e/#ne","title":"NE","text":"[jvm]\\ NE
a != b
//misk-hibernate/misk.hibernate/Operator/NOT_IN
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-operator/-n-o-t_-i-n/#not_in","title":"NOT_IN","text":"[jvm]\\ NOT_IN
a NOT IN (b1, b2, b3, ...)
//misk-hibernate/misk.hibernate/OrBuilder
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/#orbuilder","title":"OrBuilder","text":"[jvm]\\ interface OrBuilder<Q : Query<*>>
This functional interface accepts a set of options. Each option lambda is executed within the scope of a query. It is inappropriate to call methods like list() and uniqueResult() on this query.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/#functions","title":"Functions","text":"Name Summary option [jvm]abstract fun option(lambda: Q.() -> Unit)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/option/","title":"option - Misk","text":"//misk-hibernate/misk.hibernate/OrBuilder/option
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-or-builder/option/#option","title":"option","text":"[jvm]\\ abstract fun option(lambda: Q.() -> Unit)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/","title":"Order - Misk","text":"//misk-hibernate/misk.hibernate/Order
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/#order","title":"Order","text":"[jvm]\\ annotation class Order(val path: String, val asc: Boolean = true)
Annotates a function on a Query interface to indicate by which columns to order the results. Defaults to ascending order.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/#properties","title":"Properties","text":"Name Summary asc [jvm]val asc: Boolean = true path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/asc/","title":"asc - Misk","text":"//misk-hibernate/misk.hibernate/Order/asc
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/asc/#asc","title":"asc","text":"[jvm]\\ val asc: Boolean = true
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Order/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-order/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/","title":"Path - Misk","text":"//misk-hibernate/misk.hibernate/Path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#path","title":"Path","text":"[jvm]\\ data class Path(val schema: String?, val table: String?, val column: String?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#constructors","title":"Constructors","text":"Path [jvm]constructor(schema: String?, table: String?, column: String?)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#properties","title":"Properties","text":"Name Summary column [jvm]val column: String? schema [jvm]val schema: String? table [jvm]val table: String?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/-path/","title":"Path - Misk","text":"//misk-hibernate/misk.hibernate/Path/Path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/-path/#path","title":"Path","text":"[jvm]\\ constructor(schema: String?, table: String?, column: String?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/column/","title":"column - Misk","text":"//misk-hibernate/misk.hibernate/Path/column
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/column/#column","title":"column","text":"[jvm]\\ val column: String?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/schema/","title":"schema - Misk","text":"//misk-hibernate/misk.hibernate/Path/schema
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/schema/#schema","title":"schema","text":"[jvm]\\ val schema: String?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/table/","title":"table - Misk","text":"//misk-hibernate/misk.hibernate/Path/table
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/table/#table","title":"table","text":"[jvm]\\ val table: String?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/to-string/","title":"toString - Misk","text":"//misk-hibernate/misk.hibernate/Path/toString
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-path/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-hibernate/misk.hibernate/PostCommitHookFailedException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ class PostCommitHookFailedException(cause: Throwable) : Exception
PostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#constructors","title":"Constructors","text":"PostCommitHookFailedException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-hibernate/misk.hibernate/PostCommitHookFailedException/PostCommitHookFailedException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ constructor(cause: Throwable)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-projection/","title":"Projection - Misk","text":"//misk-hibernate/misk.hibernate/Projection
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-projection/#projection","title":"Projection","text":"[jvm]\\ interface Projection
Marker interface for query projections.
Projections are used to define the shape of the result set of a query, often as a subset of the properties of the entity or entities being queried.
For example, if we have a DbMovie entity with a name, release_date, and other properties we could use a projection to only select the name and release_date properties:
data class NameAndReleaseDate(\n @Property(\"name\") var name: String,\n @Property(\"release_date\") var releaseDate: LocalDate?\n) : Projection\n//misk-hibernate/misk.hibernate/Property
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/#property","title":"Property","text":"[jvm]\\ annotation class Property(val path: String, val aggregation: AggregationType = AggregationType.NONE)
Annotates a parameter of a Projection data class to indicate which column (or path of columns) to populate the parameter with.
Properties may be created from an aggregation function, which will be applied to the column. By default, no aggregation is applied.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/#properties","title":"Properties","text":"Name Summary aggregation [jvm]val aggregation: AggregationType path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/aggregation/","title":"aggregation - Misk","text":"//misk-hibernate/misk.hibernate/Property/aggregation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/aggregation/#aggregation","title":"aggregation","text":"[jvm]\\ val aggregation: AggregationType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Property/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-property/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-proto-column/","title":"ProtoColumn - Misk","text":"//misk-hibernate/misk.hibernate/ProtoColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-proto-column/#protocolumn","title":"ProtoColumn","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class ProtoColumn
Put this on a column field for a class generated by Wire to get Hibernate to persist with protobuf serialization.
There is no defensive copy when reading from the database as protobufs are assumed to be immutable.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/","title":"Query - Misk","text":"//misk-hibernate/misk.hibernate/Query
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#query","title":"Query","text":"[jvm]\\ interface Query<T>
Base class for SQL queries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#types","title":"Types","text":"Name Summary Factory [jvm]interface FactoryCreates instances of queries."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#properties","title":"Properties","text":"Name Summary firstResult [jvm]abstract var firstResult: IntSet the first row to retrieve. The default is 0. maxRows [jvm]abstract var maxRows: IntHow many rows to return. Must be -1 or in range 1..10_000."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/#functions","title":"Functions","text":"Name Summary addJpaConstraint [jvm]abstract fun addJpaConstraint(block: (root: Root<*>, builder: CriteriaBuilder) -> Predicate)Constrain a query by operating directly on the JPA criteria builder. addQueryHint [jvm]abstract fun addQueryHint(hint: String)Adds a SQL hint to the query. clone [jvm]abstract fun <Q : Query<*>> clone(): Q count [jvm]abstract fun count(session: Session): LongReturns the number of rows that match the query. delete [jvm]abstract fun delete(session: Session): IntReturns the number of entities deleted. disableCheck [jvm]abstract fun disableCheck(check: Check) dynamicAddConstraint [jvm]abstract fun dynamicAddConstraint(path: String, operator: Operator, value: Any? = null)Constrain a query using a path known only at runtime. dynamicAddFetch [jvm]abstract fun dynamicAddFetch(path: String, joinType: JoinType)Fetch the given path as a join, using the given joinType dynamicAddOrder [jvm]abstract fun dynamicAddOrder(path: String, asc: Boolean) dynamicList [jvm]abstract fun dynamicList(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<List<Any?>>Manual projections are returned as a list of rows containing a list of cells.[jvm]abstract fun dynamicList(session: Session, projectedPaths: List<String>): List<List<Any?>> dynamicUniqueResult [jvm]abstract fun dynamicUniqueResult(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<Any?>?Manual projections are returned as a list of cells. Returns null if there were no results.[jvm]abstract fun dynamicUniqueResult(session: Session, projectedPaths: List<String>): List<Any?>? list [jvm]abstract fun list(session: Session): List<T> newOrBuilder [jvm]abstract fun <T : Query<*>> newOrBuilder(): OrBuilder<T> uniqueResult [jvm]abstract fun uniqueResult(session: Session): T?Asserts that there is either zero or one results."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-jpa-constraint/","title":"addJpaConstraint - Misk","text":"//misk-hibernate/misk.hibernate/Query/addJpaConstraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-jpa-constraint/#addjpaconstraint","title":"addJpaConstraint","text":"[jvm]\\ abstract fun addJpaConstraint(block: (root: Root<*>, builder: CriteriaBuilder) -> Predicate)
Constrain a query by operating directly on the JPA criteria builder.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-query-hint/","title":"addQueryHint - Misk","text":"//misk-hibernate/misk.hibernate/Query/addQueryHint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/add-query-hint/#addqueryhint","title":"addQueryHint","text":"[jvm]\\ abstract fun addQueryHint(hint: String)
Adds a SQL hint to the query.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/clone/","title":"clone - Misk","text":"//misk-hibernate/misk.hibernate/Query/clone
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/clone/#clone","title":"clone","text":"[jvm]\\ abstract fun <Q : Query<*>> clone(): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/count/","title":"count - Misk","text":"//misk-hibernate/misk.hibernate/Query/count
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/count/#count","title":"count","text":"[jvm]\\ abstract fun count(session: Session): Long
Returns the number of rows that match the query.
Warning: The performance of this operation is comparable to a SELECT. MySQL scans all of the counted rows. A query that returns a count of 5000 is typically 10 times slower than a query that returns a count of 500.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/delete/","title":"delete - Misk","text":"//misk-hibernate/misk.hibernate/Query/delete
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/delete/#delete","title":"delete","text":"[jvm]\\ abstract fun delete(session: Session): Int
Returns the number of entities deleted.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/disable-check/","title":"disableCheck - Misk","text":"//misk-hibernate/misk.hibernate/Query/disableCheck
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/disable-check/#disablecheck","title":"disableCheck","text":"[jvm]\\ abstract fun disableCheck(check: Check)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-constraint/","title":"dynamicAddConstraint - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicAddConstraint
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-constraint/#dynamicaddconstraint","title":"dynamicAddConstraint","text":"[jvm]\\ abstract fun dynamicAddConstraint(path: String, operator: Operator, value: Any? = null)
Constrain a query using a path known only at runtime.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-fetch/","title":"dynamicAddFetch - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicAddFetch
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-fetch/#dynamicaddfetch","title":"dynamicAddFetch","text":"[jvm]\\ abstract fun dynamicAddFetch(path: String, joinType: JoinType)
Fetch the given path as a join, using the given joinType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-order/","title":"dynamicAddOrder - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicAddOrder
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-add-order/#dynamicaddorder","title":"dynamicAddOrder","text":"[jvm]\\ abstract fun dynamicAddOrder(path: String, asc: Boolean)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-list/","title":"dynamicList - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicList
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-list/#dynamiclist","title":"dynamicList","text":"[jvm]\\ abstract fun dynamicList(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<List<Any?>>
Manual projections are returned as a list of rows containing a list of cells.
[jvm]\\ abstract fun dynamicList(session: Session, projectedPaths: List<String>): List<List<Any?>>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-unique-result/","title":"dynamicUniqueResult - Misk","text":"//misk-hibernate/misk.hibernate/Query/dynamicUniqueResult
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/dynamic-unique-result/#dynamicuniqueresult","title":"dynamicUniqueResult","text":"[jvm]\\ abstract fun dynamicUniqueResult(session: Session, selection: (CriteriaBuilder, Root<T>) -> Selection<out Any>): List<Any?>?
Manual projections are returned as a list of cells. Returns null if there were no results.
[jvm]\\ abstract fun dynamicUniqueResult(session: Session, projectedPaths: List<String>): List<Any?>?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/first-result/","title":"firstResult - Misk","text":"//misk-hibernate/misk.hibernate/Query/firstResult
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/first-result/#firstresult","title":"firstResult","text":"[jvm]\\ abstract var firstResult: Int
Set the first row to retrieve. The default is 0.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/list/","title":"list - Misk","text":"//misk-hibernate/misk.hibernate/Query/list
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/list/#list","title":"list","text":"[jvm]\\ abstract fun list(session: Session): List<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/max-rows/","title":"maxRows - Misk","text":"//misk-hibernate/misk.hibernate/Query/maxRows
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/max-rows/#maxrows","title":"maxRows","text":"[jvm]\\ abstract var maxRows: Int
How many rows to return. Must be -1 or in range 1..10_000.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/new-or-builder/","title":"newOrBuilder - Misk","text":"//misk-hibernate/misk.hibernate/Query/newOrBuilder
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/new-or-builder/#neworbuilder","title":"newOrBuilder","text":"[jvm]\\ abstract fun <T : Query<*>> newOrBuilder(): OrBuilder<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/unique-result/","title":"uniqueResult - Misk","text":"//misk-hibernate/misk.hibernate/Query/uniqueResult
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/unique-result/#uniqueresult","title":"uniqueResult","text":"[jvm]\\ abstract fun uniqueResult(session: Session): T?
Asserts that there is either zero or one results.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/","title":"Factory - Misk","text":"//misk-hibernate/misk.hibernate/Query/Factory
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/#factory","title":"Factory","text":"[jvm]\\ interface Factory
Creates instances of queries.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/#functions","title":"Functions","text":"Name Summary dynamicQuery [jvm]abstract fun <E : DbEntity<E>> dynamicQuery(entityClass: KClass<E>): Query<E> newQuery [jvm]abstract fun <Q : Query<*>> newQuery(queryClass: KClass<Q>): Q newQuery [jvm]inline fun <T : Query<*>> Query.Factory.newQuery(): T"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/dynamic-query/","title":"dynamicQuery - Misk","text":"//misk-hibernate/misk.hibernate/Query/Factory/dynamicQuery
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/dynamic-query/#dynamicquery","title":"dynamicQuery","text":"[jvm]\\ abstract fun <E : DbEntity<E>> dynamicQuery(entityClass: KClass<E>): Query<E>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/new-query/","title":"newQuery - Misk","text":"//misk-hibernate/misk.hibernate/Query/Factory/newQuery
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-query/-factory/new-query/#newquery","title":"newQuery","text":"[jvm]\\ abstract fun <Q : Query<*>> newQuery(queryClass: KClass<Q>): Q
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/","title":"RetryTransactionException - Misk","text":"//misk-hibernate/misk.hibernate/RetryTransactionException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#retrytransactionexception","title":"RetryTransactionException","text":"[jvm]\\ class RetryTransactionException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : Exception
Thrown to explicitly trigger a retry, subject to retry limits and config such as noRetries().
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#constructors","title":"Constructors","text":"RetryTransactionException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/-retry-transaction-exception/","title":"RetryTransactionException - Misk","text":"//misk-hibernate/misk.hibernate/RetryTransactionException/RetryTransactionException
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-retry-transaction-exception/-retry-transaction-exception/#retrytransactionexception","title":"RetryTransactionException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/","title":"SecretColumn - Misk","text":"//misk-hibernate/misk.hibernate/SecretColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/#secretcolumn","title":"SecretColumn","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class SecretColumn(val keyName: String, val indexable: Boolean = true)
SecretColumn is an annotation used to get Hibernate to encrypt a field before writing it to the database.
The keyName string is used to specify the name of the key to be used to encrypt and decrypt the value.
The indexable attribute controls whether or not this data will be able to be indexed, defaulted to true. This uses deterministic encryption: encrypting the same plaintext will produce the same ciphertext. This is weaker than non-deterministic encryption, but makes searching for encrypted values possible. If searching for ciphertexts is not something your use case requires, set indexable to false for stronger security.
Install misk.crypto.CryptoModule to configure the keys the app uses. Example: In app-common.yaml:
crypto:\n keys:\n - key_name: \"secretColumnKey\"\nThen, in an entity class:
@Column\n@SecretColumn(keyName = \"secretColumnKey\")\nvar secret: String\nA Column annotated with SecretColumn has the following limitations:
VARBINARY() in its respective MySQL table. For example:CREATE TABLE my_table(\n id BIGINT NOT NULL AUTO_INCREMENT,\n secret VARBINARY(500)\nNote:
The resulting ciphertext that is persisted in the database may be much larger in size than the original plaintext because it also contains some metadata. Please make sure to allocate enough space when defining the column using VARBINARY().
//misk-hibernate/misk.hibernate/SecretColumn/indexable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/indexable/#indexable","title":"indexable","text":"[jvm]\\ val indexable: Boolean = true
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/key-name/","title":"keyName - Misk","text":"//misk-hibernate/misk.hibernate/SecretColumn/keyName
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-secret-column/key-name/#keyname","title":"keyName","text":"[jvm]\\ val keyName: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/","title":"Select - Misk","text":"//misk-hibernate/misk.hibernate/Select
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/#select","title":"Select","text":"[jvm]\\ annotation class Select(val path: String = \"\", val aggregation: AggregationType = AggregationType.NONE)
Annotates a function on a Query interface to execute a SELECT query. Functions with this annotation must return a List to fetch multiple rows results, or a regular type to fetch a unique result.
Select annotated methods may return single column values, or Projections of multiple columns.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/#properties","title":"Properties","text":"Name Summary aggregation [jvm]val aggregation: AggregationType path [jvm]val path: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/aggregation/","title":"aggregation - Misk","text":"//misk-hibernate/misk.hibernate/Select/aggregation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/aggregation/#aggregation","title":"aggregation","text":"[jvm]\\ val aggregation: AggregationType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/path/","title":"path - Misk","text":"//misk-hibernate/misk.hibernate/Select/path
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-select/path/#path","title":"path","text":"[jvm]\\ val path: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/","title":"Session - Misk","text":"//misk-hibernate/misk.hibernate/Session
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/#session","title":"Session","text":"[jvm]\\ interface Session : Session
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/#properties","title":"Properties","text":"Name Summary hibernateSession [jvm]abstract val hibernateSession: Session"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/#functions","title":"Functions","text":"Name Summary delete [jvm]abstract fun <T : DbEntity<T>> delete(entity: T) disableChecks [jvm]abstract fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T load [jvm]abstract fun <T : DbEntity<T>> load(id: Id<T>, type: KClass<T>): T load [jvm]inline fun <T : DbEntity<T>> Session.load(id: Id<T>): T loadOrNull [jvm]abstract fun <T : DbEntity<T>> loadOrNull(id: Id<T>, type: KClass<T>): T? loadOrNull [jvm]inline fun <T : DbEntity<T>> Session.loadOrNull(id: Id<T>): T? loadSharded [jvm]abstract fun <R : DbRoot<R>, T : DbSharded<R, T>> loadSharded(gid: Gid<R, T>, type: KClass<T>): T loadSharded [jvm]inline fun <R : DbRoot<R>, S : DbSharded<R, S>> Session.loadSharded(gid: Gid<R, S>): S onPostCommit [jvm]abstract fun onPostCommit(work: () -> Unit) onPreCommit [jvm]abstract fun onPreCommit(work: () -> Unit) onSessionClose [jvm]abstract fun onSessionClose(work: () -> Unit) save [jvm]abstract fun <T : DbEntity<T>> save(entity: T): Id<T> shards [jvm]abstract fun shards(): Set<Shard>abstract fun shards(keyspace: Keyspace): Collection<Shard> target [jvm]abstract fun <T> target(shard: Shard, function: () -> T): T useConnection [jvm]abstract fun <T> useConnection(work: (Connection) -> T): T withoutChecks [jvm]abstract fun <T> withoutChecks(vararg checks: Check, body: () -> T): TDisable one or more checks for the duration of the execution of body. The passed in checks will entirely replace the other ignored checks at this point, they will not be merged with whatever is there currently."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/delete/","title":"delete - Misk","text":"//misk-hibernate/misk.hibernate/Session/delete
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/delete/#delete","title":"delete","text":"[jvm]\\ abstract fun <T : DbEntity<T>> delete(entity: T)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/delete/#throws","title":"Throws","text":"IllegalStateException when delete is called on a read only session."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/disable-checks/","title":"disableChecks - Misk","text":"//misk-hibernate/misk.hibernate/Session/disableChecks
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/disable-checks/#disablechecks","title":"disableChecks","text":"[jvm]\\ abstract fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/hibernate-session/","title":"hibernateSession - Misk","text":"//misk-hibernate/misk.hibernate/Session/hibernateSession
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/hibernate-session/#hibernatesession","title":"hibernateSession","text":"[jvm]\\ abstract val hibernateSession: Session
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-or-null/","title":"loadOrNull - Misk","text":"//misk-hibernate/misk.hibernate/Session/loadOrNull
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-or-null/#loadornull","title":"loadOrNull","text":"[jvm]\\ abstract fun <T : DbEntity<T>> loadOrNull(id: Id<T>, type: KClass<T>): T?
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-sharded/","title":"loadSharded - Misk","text":"//misk-hibernate/misk.hibernate/Session/loadSharded
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load-sharded/#loadsharded","title":"loadSharded","text":"[jvm]\\ abstract fun <R : DbRoot<R>, T : DbSharded<R, T>> loadSharded(gid: Gid<R, T>, type: KClass<T>): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load/","title":"load - Misk","text":"//misk-hibernate/misk.hibernate/Session/load
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/load/#load","title":"load","text":"[jvm]\\ abstract fun <T : DbEntity<T>> load(id: Id<T>, type: KClass<T>): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/save/","title":"save - Misk","text":"//misk-hibernate/misk.hibernate/Session/save
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/save/#save","title":"save","text":"[jvm]\\ abstract fun <T : DbEntity<T>> save(entity: T): Id<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/save/#throws","title":"Throws","text":"IllegalStateException when save is called on a read only session."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/shards/","title":"shards - Misk","text":"//misk-hibernate/misk.hibernate/Session/shards
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/shards/#shards","title":"shards","text":"[jvm]\\ abstract fun shards(): Set<Shard>
abstract fun shards(keyspace: Keyspace): Collection<Shard>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/target/","title":"target - Misk","text":"//misk-hibernate/misk.hibernate/Session/target
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/target/#target","title":"target","text":"[jvm]\\ abstract fun <T> target(shard: Shard, function: () -> T): T
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/without-checks/","title":"withoutChecks - Misk","text":"//misk-hibernate/misk.hibernate/Session/withoutChecks
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-session/without-checks/#withoutchecks","title":"withoutChecks","text":"[jvm]\\ abstract fun <T> withoutChecks(vararg checks: Check, body: () -> T): T
Disable one or more checks for the duration of the execution of body. The passed in checks will entirely replace the other ignored checks at this point, they will not be merged with whatever is there currently.
TODO: Deprecate. This can enable checks as a side-effect. Prefer disableChecks() which is cumulative
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/","title":"Transacter - Misk","text":"//misk-hibernate/misk.hibernate/Transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/#transacter","title":"Transacter","text":"[jvm]\\ interface Transacter
Provides explicit block-based transaction demarcation.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/#properties","title":"Properties","text":"Name Summary inTransaction [jvm]abstract val inTransaction: BooleanReturns true if the calling thread is currently within a transaction block."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/#functions","title":"Functions","text":"Name Summary allowCowrites [jvm]abstract fun allowCowrites(): TransacterDisable cowrite checks for the duration of the session. Useful for quickly setting up test data in testing. config [jvm]abstract fun config(): DataSourceConfig entities [jvm]abstract fun entities(): Set<KClass<out DbEntity<*>>>Returns KClasses for the bound DbEntities for the transacter failSafeRead [jvm]fun <T> Transacter.failSafeRead(block: (session: Session) -> T): TRuns a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.[jvm]fun <T> Transacter.failSafeRead(shard: Shard, block: (session: Session) -> T): T isCheckEnabled [jvm]abstract fun isCheckEnabled(check: Check): BooleanIs the scalability check currently enabled. Use Session.withoutChecks to disable checks. noRetries [jvm]abstract fun noRetries(): Transacter readOnly [jvm]abstract fun readOnly(): TransacterCreates a new transacter that produces read only sessions. This does not mean the underlying datasource is read only, only that the session produced won\u2019t modify the database. replicaRead [jvm]abstract fun <T> replicaRead(block: (session: Session) -> T): TRuns a non-transactional session against a read replica. retries [jvm]abstract fun retries(maxAttempts: Int = 2): Transacter shards [jvm]fun Transacter.shards(): Set<Shard>fun Transacter.shards(keyspace: Keyspace): Collection<Shard> transaction [jvm]abstract fun <T> transaction(block: (session: Session) -> T): TStarts a transaction on the current thread, executes block, and commits the transaction. If the block raises an exception the transaction will be rolled back instead of committed. transaction [jvm]fun <T> Transacter.transaction(shard: Shard, block: (session: Session) -> T): TCommits a transaction with operations of block."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/allow-cowrites/","title":"allowCowrites - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/allowCowrites
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/allow-cowrites/#allowcowrites","title":"allowCowrites","text":"[jvm]\\ abstract fun allowCowrites(): Transacter
Disable cowrite checks for the duration of the session. Useful for quickly setting up test data in testing.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/config/","title":"config - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/config
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/config/#config","title":"config","text":"[jvm]\\ abstract fun config(): DataSourceConfig
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/entities/","title":"entities - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/entities
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/entities/#entities","title":"entities","text":"[jvm]\\ abstract fun entities(): Set<KClass<out DbEntity<*>>>
Returns KClasses for the bound DbEntities for the transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/in-transaction/","title":"inTransaction - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/inTransaction
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/in-transaction/#intransaction","title":"inTransaction","text":"[jvm]\\ abstract val inTransaction: Boolean
Returns true if the calling thread is currently within a transaction block.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/is-check-enabled/","title":"isCheckEnabled - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/isCheckEnabled
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/is-check-enabled/#ischeckenabled","title":"isCheckEnabled","text":"[jvm]\\ abstract fun isCheckEnabled(check: Check): Boolean
Is the scalability check currently enabled. Use Session.withoutChecks to disable checks.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/no-retries/","title":"noRetries - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/noRetries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/no-retries/#noretries","title":"noRetries","text":"[jvm]\\ abstract fun noRetries(): Transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/read-only/","title":"readOnly - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/readOnly
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/read-only/#readonly","title":"readOnly","text":"[jvm]\\ abstract fun readOnly(): Transacter
Creates a new transacter that produces read only sessions. This does not mean the underlying datasource is read only, only that the session produced won\u2019t modify the database.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/replica-read/","title":"replicaRead - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/replicaRead
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/replica-read/#replicaread","title":"replicaRead","text":"[jvm]\\ abstract fun <T> replicaRead(block: (session: Session) -> T): T
Runs a non-transactional session against a read replica.
A few things that are different with replica reads:
//misk-hibernate/misk.hibernate/Transacter/retries
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/retries/#retries","title":"retries","text":"[jvm]\\ abstract fun retries(maxAttempts: Int = 2): Transacter
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/transaction/","title":"transaction - Misk","text":"//misk-hibernate/misk.hibernate/Transacter/transaction
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\ abstract fun <T> transaction(block: (session: Session) -> T): T
Starts a transaction on the current thread, executes block, and commits the transaction. If the block raises an exception the transaction will be rolled back instead of committed.
If retries are permitted (the default), a failed but recoverable transaction will be reattempted after rolling back.
It is an error to start a transaction if another transaction is already in progress.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter-service/","title":"TransacterService - Misk","text":"//misk-hibernate/misk.hibernate/TransacterService
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transacter-service/#transacterservice","title":"TransacterService","text":"[jvm]\\ interface TransacterService : Service
Marker interface for services that provide database transactors.
Services that require a database connection should depend on this interface when they are installed in a module.
e.g.
install(ServiceModule<MoviesService>()\n .dependsOn<TransacterService>(Movies::class))\n//misk-hibernate/misk.hibernate/TransformedType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/#transformedtype","title":"TransformedType","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])
annotation class TransformedType(val transformer: KClass<out Transformer>, val targetType: KClass<*>)
TransformedType is a meta-annotation for assigning arbitrary transformers to entity fields. Use it to annotate attributes that will mark a field to be transformed.
transformer is a KClass instance of a class that implements assemble and disassemble methods. Assemble is called when a value is read from the table, or from cache. Disassemble is called when a value is about to be written to a table or cache.
targetType specifies a KClass instance of the type that the field should have when disassembled. It is used to determine the backing SQL type.
The methods of Transformer additionally take a field representing the annotated field and a TransformerContext, which contains limited entity state, including the name of the table and the column, the arguments the annotation received.
Note!: Wrapping basic numberic types may not behave as one would expect, especially when querying. This is partly due to Hibernate\u2019s inlining of primitive values.
For example, one can define a transformer that appends a value to a string prior to storage, and removes it after retrieval. First, define the Transformer itself
class AppendTransformer(val context: TransformerContext) { fun assemble(owner: Any?, value: Serializable): Any = (value as String).removeSuffix(context.arguments\"suffix\" as String))
fun disassemble(value: Any): Serializable = \"${value as String}${context.arguments\"suffix\" as String}\" }
Then, create the entity annotation:
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/#properties","title":"Properties","text":"Name Summary targetType [jvm]val targetType: KClass<*> transformer [jvm]val transformer: KClass<out Transformer>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/target-type/","title":"targetType - Misk","text":"//misk-hibernate/misk.hibernate/TransformedType/targetType
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/target-type/#targettype","title":"targetType","text":"[jvm]\\ val targetType: KClass<*>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/transformer/","title":"transformer - Misk","text":"//misk-hibernate/misk.hibernate/TransformedType/transformer
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformed-type/transformer/#transformer","title":"transformer","text":"[jvm]\\ val transformer: KClass<out Transformer>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/","title":"Transformer - Misk","text":"//misk-hibernate/misk.hibernate/Transformer
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#transformer","title":"Transformer","text":"[jvm]\\ abstract class Transformer(val context: TransformerContext)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#constructors","title":"Constructors","text":"Transformer [jvm]constructor(context: TransformerContext)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#properties","title":"Properties","text":"Name Summary context [jvm]val context: TransformerContext"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/#functions","title":"Functions","text":"Name Summary assemble [jvm]abstract fun assemble(owner: Any?, value: Serializable): Any disassemble [jvm]abstract fun disassemble(value: Any): Serializable"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/-transformer/","title":"Transformer - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/Transformer
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/-transformer/#transformer","title":"Transformer","text":"[jvm]\\ constructor(context: TransformerContext)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/assemble/","title":"assemble - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/assemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/assemble/#assemble","title":"assemble","text":"[jvm]\\ abstract fun assemble(owner: Any?, value: Serializable): Any
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/context/","title":"context - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/context
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/context/#context","title":"context","text":"[jvm]\\ val context: TransformerContext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/disassemble/","title":"disassemble - Misk","text":"//misk-hibernate/misk.hibernate/Transformer/disassemble
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer/disassemble/#disassemble","title":"disassemble","text":"[jvm]\\ abstract fun disassemble(value: Any): Serializable
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/","title":"TransformerContext - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/#transformercontext","title":"TransformerContext","text":"[jvm]\\ data class TransformerContext(val tableName: String, val columnName: String, var arguments: Map<String, >, var field: KClass<>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/#constructors","title":"Constructors","text":"TransformerContext [jvm]constructor(tableName: String, columnName: String, arguments: Map<String, >, field: KClass<>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/#properties","title":"Properties","text":"Name Summary arguments [jvm]var arguments: Map<String, *> columnName [jvm]val columnName: String field [jvm]var field: KClass<*> tableName [jvm]val tableName: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/-transformer-context/","title":"TransformerContext - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/TransformerContext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/-transformer-context/#transformercontext","title":"TransformerContext","text":"[jvm]\\ constructor(tableName: String, columnName: String, arguments: Map<String, >, field: KClass<>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/arguments/","title":"arguments - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/arguments
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/arguments/#arguments","title":"arguments","text":"[jvm]\\ var arguments: Map<String, *>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/column-name/","title":"columnName - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/columnName
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/column-name/#columnname","title":"columnName","text":"[jvm]\\ val columnName: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/field/","title":"field - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/field
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/field/#field","title":"field","text":"[jvm]\\ var field: KClass<*>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/table-name/","title":"tableName - Misk","text":"//misk-hibernate/misk.hibernate/TransformerContext/tableName
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-transformer-context/table-name/#tablename","title":"tableName","text":"[jvm]\\ val tableName: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/","title":"ValidationReport - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/#validationreport","title":"ValidationReport","text":"[jvm]\\ data class ValidationReport(val schemas: Set<String>, val tables: Set<String>, val columns: Set<String>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/#constructors","title":"Constructors","text":"ValidationReport [jvm]constructor(schemas: Set<String>, tables: Set<String>, columns: Set<String>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/#properties","title":"Properties","text":"Name Summary columns [jvm]val columns: Set<String> schemas [jvm]val schemas: Set<String> tables [jvm]val tables: Set<String>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/-validation-report/","title":"ValidationReport - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/ValidationReport
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/-validation-report/#validationreport","title":"ValidationReport","text":"[jvm]\\ constructor(schemas: Set<String>, tables: Set<String>, columns: Set<String>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/columns/","title":"columns - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/columns
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/columns/#columns","title":"columns","text":"[jvm]\\ val columns: Set<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/schemas/","title":"schemas - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/schemas
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/schemas/#schemas","title":"schemas","text":"[jvm]\\ val schemas: Set<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/tables/","title":"tables - Misk","text":"//misk-hibernate/misk.hibernate/ValidationReport/tables
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-validation-report/tables/#tables","title":"tables","text":"[jvm]\\ val tables: Set<String>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/","title":"VitessDialect - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#vitessdialect","title":"VitessDialect","text":"[jvm]\\ class VitessDialect : MySQL57Dialect
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#constructors","title":"Constructors","text":"VitessDialect [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#properties","title":"Properties","text":"Name Summary uniqueDelegate [jvm]val uniqueDelegate: UniqueDelegate"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/#functions","title":"Functions","text":"Name Summary addSqlHintOrComment [jvm]open fun addSqlHintOrComment(p0: String, p1: QueryParameters, p2: Boolean): String appendLockHint [jvm]open fun appendLockHint(p0: LockOptions, p1: String): String applyLocksToSql [jvm]open fun applyLocksToSql(p0: String, p1: LockOptions, p2: MutableMap<String, Array<String>>): String areStringComparisonsCaseInsensitive [jvm]open override fun areStringComparisonsCaseInsensitive(): Boolean augmentPhysicalTableTypes [jvm]open fun augmentPhysicalTableTypes(p0: MutableList<String>) augmentRecognizedTableTypes [jvm]open fun augmentRecognizedTableTypes(p0: MutableList<String>) buildIdentifierHelper [jvm]open override fun buildIdentifierHelper(p0: IdentifierHelperBuilder, p1: DatabaseMetaData): IdentifierHelper buildSQLExceptionConversionDelegate [jvm]open override fun buildSQLExceptionConversionDelegate(): SQLExceptionConversionDelegate canCreateCatalog [jvm]open override fun canCreateCatalog(): Boolean canCreateSchema [jvm]open override fun canCreateSchema(): Boolean cast [jvm]open fun cast(p0: String, p1: Int, p2: Int): Stringopen fun cast(p0: String, p1: Int, p2: Int, p3: Int): Stringopen fun cast(p0: String, p1: Int, p2: Int, p3: Int, p4: Int): String closeQuote [jvm]open override fun closeQuote(): Char contributeTypes [jvm]open fun contributeTypes(p0: TypeContributions, p1: ServiceRegistry) createCaseFragment [jvm]open fun createCaseFragment(): CaseFragment createOuterJoinFragment [jvm]open fun createOuterJoinFragment(): JoinFragment defaultScrollMode [jvm]open fun defaultScrollMode(): ScrollMode doesReadCommittedCauseWritersToBlockReaders [jvm]open fun doesReadCommittedCauseWritersToBlockReaders(): Boolean doesRepeatableReadCauseReadersToBlockWriters [jvm]open fun doesRepeatableReadCauseReadersToBlockWriters(): Boolean dropConstraints [jvm]open override fun dropConstraints(): Boolean equivalentTypes [jvm]open fun equivalentTypes(p0: Int, p1: Int): Boolean forceLobAsLastValue [jvm]open fun forceLobAsLastValue(): Boolean forUpdateOfColumns [jvm]open fun forUpdateOfColumns(): Boolean getAddColumnString [jvm]open override fun getAddColumnString(): String getAddColumnSuffixString [jvm]open fun getAddColumnSuffixString(): String getAddForeignKeyConstraintString [jvm]open fun getAddForeignKeyConstraintString(p0: String, p1: String): Stringopen override fun getAddForeignKeyConstraintString(p0: String, p1: Array<String>, p2: String, p3: Array<String>, p4: Boolean): String getAddPrimaryKeyConstraintString [jvm]open fun getAddPrimaryKeyConstraintString(p0: String): String getAlterTableString [jvm]open fun getAlterTableString(p0: String): String getAuxiliaryDatabaseObjectExporter [jvm]open fun getAuxiliaryDatabaseObjectExporter(): Exporter<AuxiliaryDatabaseObject> getCallableStatementSupport [jvm]open fun getCallableStatementSupport(): CallableStatementSupport getCascadeConstraintsString [jvm]open fun getCascadeConstraintsString(): String getCaseInsensitiveLike [jvm]open fun getCaseInsensitiveLike(): String getCastTypeName [jvm]open override fun getCastTypeName(p0: Int): String getColumnAliasExtractor [jvm]open fun getColumnAliasExtractor(): ColumnAliasExtractor getColumnComment [jvm]open override fun getColumnComment(p0: String): String getCreateCatalogCommand [jvm]open override fun getCreateCatalogCommand(p0: String): Array<String> getCreateMultisetTableString [jvm]open fun getCreateMultisetTableString(): String getCreateSchemaCommand [jvm]open override fun getCreateSchemaCommand(p0: String): Array<String> getCreateSequenceStrings [jvm]open fun getCreateSequenceStrings(p0: String, p1: Int, p2: Int): Array<String> getCreateTableString [jvm]open fun getCreateTableString(): String getCreateTemporaryTableColumnAnnotation [jvm]open fun getCreateTemporaryTableColumnAnnotation(p0: Int): String getCrossJoinSeparator [jvm]open fun getCrossJoinSeparator(): String getCurrentSchemaCommand [jvm]open fun getCurrentSchemaCommand(): String getCurrentTimestampSelectString [jvm]open override fun getCurrentTimestampSelectString(): String getCurrentTimestampSQLFunctionName [jvm]open fun getCurrentTimestampSQLFunctionName(): String getDefaultBatchLoadSizingStrategy [jvm]open fun getDefaultBatchLoadSizingStrategy(): BatchLoadSizingStrategy getDefaultMultiTableBulkIdStrategy [jvm]open override fun getDefaultMultiTableBulkIdStrategy(): MultiTableBulkIdStrategy getDefaultProperties [jvm]fun getDefaultProperties(): Properties getDropCatalogCommand [jvm]open override fun getDropCatalogCommand(p0: String): Array<String> getDropForeignKeyString [jvm]open override fun getDropForeignKeyString(): String getDropSchemaCommand [jvm]open override fun getDropSchemaCommand(p0: String): Array<String> getDropSequenceStrings [jvm]open fun getDropSequenceStrings(p0: String): Array<String> getDropTableString [jvm]open fun getDropTableString(p0: String): String getForeignKeyExporter [jvm]open fun getForeignKeyExporter(): Exporter<ForeignKey> getForUpdateNowaitString [jvm]open fun getForUpdateNowaitString(): Stringopen fun getForUpdateNowaitString(p0: String): String getForUpdateSkipLockedString [jvm]open fun getForUpdateSkipLockedString(): Stringopen fun getForUpdateSkipLockedString(p0: String): String getForUpdateString [jvm]open fun getForUpdateString(p0: String): Stringopen fun getForUpdateString(p0: LockMode): Stringopen fun getForUpdateString(p0: LockOptions): Stringopen fun getForUpdateString(p0: String, p1: LockOptions): Stringopen override fun getForUpdateString(): String getFunctions [jvm]fun getFunctions(): MutableMap<String, SQLFunction> getHibernateTypeName [jvm]open fun getHibernateTypeName(p0: Int): Stringopen fun getHibernateTypeName(p0: Int, p1: Int, p2: Int, p3: Int): String getIdentityColumnSupport [jvm]open override fun getIdentityColumnSupport(): IdentityColumnSupport getIndexExporter [jvm]open fun getIndexExporter(): Exporter<Index> getInExpressionCountLimit [jvm]open fun getInExpressionCountLimit(): Int getLimitHandler [jvm]open override fun getLimitHandler(): LimitHandler getLimitString [jvm]open override fun getLimitString(p0: String, p1: Boolean): String getLobMergeStrategy [jvm]open fun getLobMergeStrategy(): LobMergeStrategy getLockingStrategy [jvm]open fun getLockingStrategy(p0: Lockable, p1: LockMode): LockingStrategy getLowercaseFunction [jvm]open fun getLowercaseFunction(): String getMaxAliasLength [jvm]open fun getMaxAliasLength(): Int getNameQualifierSupport [jvm]open override fun getNameQualifierSupport(): NameQualifierSupport getNativeIdentifierGeneratorStrategy [jvm]open fun getNativeIdentifierGeneratorStrategy(): String getNoColumnsInsertString [jvm]open fun getNoColumnsInsertString(): String getNotExpression [jvm]open override fun getNotExpression(p0: String): String getNullColumnString [jvm]open fun getNullColumnString(): String getQueryHintString [jvm]open fun getQueryHintString(p0: String, p1: MutableList<String>): Stringopen override fun getQueryHintString(p0: String, p1: String): String getQuerySequencesString [jvm]open fun getQuerySequencesString(): String getReadLockString [jvm]open fun getReadLockString(p0: String, p1: Int): Stringopen override fun getReadLockString(p0: Int): String getResultSet [jvm]open fun getResultSet(p0: CallableStatement, p1: Int): ResultSetopen fun getResultSet(p0: CallableStatement, p1: String): ResultSetopen override fun getResultSet(p0: CallableStatement): ResultSet getSchemaNameResolver [jvm]open fun getSchemaNameResolver(): SchemaNameResolver getSelectClauseNullString [jvm]open fun getSelectClauseNullString(p0: Int): String getSelectGUIDString [jvm]open override fun getSelectGUIDString(): String getSelectSequenceNextValString [jvm]open fun getSelectSequenceNextValString(p0: String): String getSequenceExporter [jvm]open fun getSequenceExporter(): Exporter<Sequence> getSequenceInformationExtractor [jvm]open fun getSequenceInformationExtractor(): SequenceInformationExtractor getSequenceNextValString [jvm]open fun getSequenceNextValString(p0: String): String getTableComment [jvm]open override fun getTableComment(p0: String): String getTableExporter [jvm]open fun getTableExporter(): Exporter<Table> getTableTypeString [jvm]open override fun getTableTypeString(): String getTypeName [jvm]open fun getTypeName(p0: Int): Stringopen fun getTypeName(p0: Int, p1: Long, p2: Int, p3: Int): String getUniqueKeyExporter [jvm]open fun getUniqueKeyExporter(): Exporter<Constraint> getViolatedConstraintNameExtracter [jvm]open override fun getViolatedConstraintNameExtracter(): ViolatedConstraintNameExtracter getWriteLockString [jvm]open fun getWriteLockString(p0: String, p1: Int): Stringopen override fun getWriteLockString(p0: Int): String hasAlterTable [jvm]open fun hasAlterTable(): Boolean hasSelfReferentialForeignKeyBug [jvm]open override fun hasSelfReferentialForeignKeyBug(): Boolean inlineLiteral [jvm]open fun inlineLiteral(p0: String): String isCurrentTimestampSelectStringCallable [jvm]open override fun isCurrentTimestampSelectStringCallable(): Boolean isJdbcLogWarningsEnabledByDefault [jvm]open override fun isJdbcLogWarningsEnabledByDefault(): Boolean isLegacyLimitHandlerBehaviorEnabled [jvm]open fun isLegacyLimitHandlerBehaviorEnabled(): Boolean isLockTimeoutParameterized [jvm]open fun isLockTimeoutParameterized(): Boolean isTypeNameRegistered [jvm]open fun isTypeNameRegistered(p0: String): Boolean openQuote [jvm]open override fun openQuote(): Char qualifyIndexName [jvm]open override fun qualifyIndexName(): Boolean quote [jvm]fun quote(p0: String): String registerResultSetOutParameter [jvm]open fun registerResultSetOutParameter(p0: CallableStatement, p1: String): Intopen override fun registerResultSetOutParameter(p0: CallableStatement, p1: Int): Int remapSqlTypeDescriptor [jvm]open fun remapSqlTypeDescriptor(p0: SqlTypeDescriptor): SqlTypeDescriptor renderOrderByElement [jvm]open override fun renderOrderByElement(p0: String, p1: String, p2: String, p3: NullPrecedence): String replaceResultVariableInOrderByClauseWithPosition [jvm]open fun replaceResultVariableInOrderByClauseWithPosition(): Boolean requiresCastingOfParametersInSelectClause [jvm]open fun requiresCastingOfParametersInSelectClause(): Boolean requiresParensForTupleDistinctCounts [jvm]open fun requiresParensForTupleDistinctCounts(): Boolean supportsBindAsCallableArgument [jvm]open fun supportsBindAsCallableArgument(): Boolean supportsCascadeDelete [jvm]open override fun supportsCascadeDelete(): Boolean supportsCaseInsensitiveLike [jvm]open fun supportsCaseInsensitiveLike(): Boolean supportsCircularCascadeDeleteConstraints [jvm]open fun supportsCircularCascadeDeleteConstraints(): Boolean supportsColumnCheck [jvm]open override fun supportsColumnCheck(): Boolean supportsCommentOn [jvm]open fun supportsCommentOn(): Boolean supportsCurrentTimestampSelection [jvm]open override fun supportsCurrentTimestampSelection(): Boolean supportsEmptyInList [jvm]open override fun supportsEmptyInList(): Boolean supportsExistsInSelect [jvm]open fun supportsExistsInSelect(): Boolean supportsExpectedLobUsagePattern [jvm]open fun supportsExpectedLobUsagePattern(): Boolean supportsIfExistsAfterAlterTable [jvm]open fun supportsIfExistsAfterAlterTable(): Boolean supportsIfExistsAfterConstraintName [jvm]open fun supportsIfExistsAfterConstraintName(): Boolean supportsIfExistsAfterTableName [jvm]open fun supportsIfExistsAfterTableName(): Boolean supportsIfExistsBeforeConstraintName [jvm]open fun supportsIfExistsBeforeConstraintName(): Boolean supportsIfExistsBeforeTableName [jvm]open override fun supportsIfExistsBeforeTableName(): Boolean supportsJdbcConnectionLobCreation [jvm]open fun supportsJdbcConnectionLobCreation(p0: DatabaseMetaData): Boolean supportsLimit [jvm]open override fun supportsLimit(): Boolean supportsLobValueChangePropogation [jvm]open override fun supportsLobValueChangePropogation(): Boolean supportsLockTimeouts [jvm]open override fun supportsLockTimeouts(): Boolean supportsNamedParameters [jvm]open fun supportsNamedParameters(p0: DatabaseMetaData): Boolean supportsNationalizedTypes [jvm]open fun supportsNationalizedTypes(): Boolean supportsNoColumnsInsert [jvm]open fun supportsNoColumnsInsert(): Boolean supportsNonQueryWithCTE [jvm]open fun supportsNonQueryWithCTE(): Boolean supportsNoWait [jvm]open fun supportsNoWait(): Boolean supportsOuterJoinForUpdate [jvm]open fun supportsOuterJoinForUpdate(): Boolean supportsParametersInInsertSelect [jvm]open fun supportsParametersInInsertSelect(): Boolean supportsPartitionBy [jvm]open fun supportsPartitionBy(): Boolean supportsPooledSequences [jvm]open fun supportsPooledSequences(): Boolean supportsResultSetPositionQueryMethodsOnForwardOnlyCursor [jvm]open fun supportsResultSetPositionQueryMethodsOnForwardOnlyCursor(): Boolean supportsRowValueConstructorSyntax [jvm]open override fun supportsRowValueConstructorSyntax(): Boolean supportsRowValueConstructorSyntaxInInList [jvm]open override fun supportsRowValueConstructorSyntaxInInList(): Boolean supportsRowValueConstructorSyntaxInSet [jvm]open override fun supportsRowValueConstructorSyntaxInSet(): Boolean supportsSelectAliasInGroupByClause [jvm]open override fun supportsSelectAliasInGroupByClause(): Boolean supportsSequences [jvm]open fun supportsSequences(): Boolean supportsSkipLocked [jvm]open fun supportsSkipLocked(): Boolean supportsSubqueryOnMutatingTable [jvm]open override fun supportsSubqueryOnMutatingTable(): Boolean supportsSubselectAsInPredicateLHS [jvm]open fun supportsSubselectAsInPredicateLHS(): Boolean supportsTableCheck [jvm]open fun supportsTableCheck(): Boolean supportsTupleCounts [jvm]open fun supportsTupleCounts(): Boolean supportsTupleDistinctCounts [jvm]open fun supportsTupleDistinctCounts(): Boolean supportsTuplesInSubqueries [jvm]open fun supportsTuplesInSubqueries(): Boolean supportsUnboundedLobLocatorMaterialization [jvm]open fun supportsUnboundedLobLocatorMaterialization(): Boolean supportsUnionAll [jvm]open override fun supportsUnionAll(): Boolean supportsValuesList [jvm]open fun supportsValuesList(): Boolean toBooleanValueString [jvm]open fun toBooleanValueString(p0: Boolean): String toString [jvm]open override fun toString(): String transformSelectString [jvm]open fun transformSelectString(p0: String): String useFollowOnLocking [jvm]open fun useFollowOnLocking(p0: QueryParameters): Boolean useInputStreamToInsertBlob [jvm]open override fun useInputStreamToInsertBlob(): Boolean"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/-vitess-dialect/","title":"VitessDialect - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect/VitessDialect
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/-vitess-dialect/#vitessdialect","title":"VitessDialect","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/build-s-q-l-exception-conversion-delegate/","title":"buildSQLExceptionConversionDelegate - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect/buildSQLExceptionConversionDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/build-s-q-l-exception-conversion-delegate/#buildsqlexceptionconversiondelegate","title":"buildSQLExceptionConversionDelegate","text":"[jvm]\\ open override fun buildSQLExceptionConversionDelegate(): SQLExceptionConversionDelegate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/use-input-stream-to-insert-blob/","title":"useInputStreamToInsertBlob - Misk","text":"//misk-hibernate/misk.hibernate/VitessDialect/useInputStreamToInsertBlob
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate/-vitess-dialect/use-input-stream-to-insert-blob/#useinputstreamtoinsertblob","title":"useInputStreamToInsertBlob","text":"[jvm]\\ open override fun useInputStreamToInsertBlob(): Boolean
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate.annotation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/#types","title":"Types","text":"Name Summary Keyspace [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])annotation class Keyspace(val value: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/#functions","title":"Functions","text":"Name Summary keyspace [jvm]fun Keyspace.keyspace(): Keyspace"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/keyspace/","title":"keyspace - Misk","text":"//misk-hibernate/misk.hibernate.annotation/keyspace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/keyspace/#keyspace","title":"keyspace","text":"[jvm]\\ fun Keyspace.keyspace(): Keyspace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/","title":"Keyspace - Misk","text":"//misk-hibernate/misk.hibernate.annotation/Keyspace
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class Keyspace(val value: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/#functions","title":"Functions","text":"Name Summary keyspace [jvm]fun Keyspace.keyspace(): Keyspace"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/value/","title":"value - Misk","text":"//misk-hibernate/misk.hibernate.annotation/Keyspace/value
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.annotation/-keyspace/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate.migrate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/#types","title":"Types","text":"Name Summary BulkShardMigrator [jvm]class BulkShardMigrator<R : DbRoot<R>, C : DbChild<R, C>>BulkShardMigrator facilitates moving of child entities belonging to a source root entity to target root entity in bulk. Source or target entity can either live on the same or different shards."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/","title":"BulkShardMigrator - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/#bulkshardmigrator","title":"BulkShardMigrator","text":"[jvm]\\ class BulkShardMigrator<R : DbRoot<R>, C : DbChild<R, C>>
BulkShardMigrator facilitates moving of child entities belonging to a source root entity to target root entity in bulk. Source or target entity can either live on the same or different shards.
If moving between shards it will copy the rows between shards using a SELECT and a batched INSERT statements. The mutations are applied to the result set in memory between the SELECT and the batch INSERT.
An example of moving rows from characters table that is sharded by movie_id from source_id to target_id:
bulkShardMigratorFactory.create(transacter, sessionFactory, DbMovie::class, DbCharacter::class) .rootColumn(\"movie_id\") .source(sourceId) .target(targetId) .execute()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Factory [jvm]@Singletonclass Factory@Injectconstructor IncMutation [jvm]class IncMutation(column: String) : BulkShardMigrator.Mutation Mutation [jvm]abstract class Mutation NowMutation [jvm]class NowMutation(column: String) : BulkShardMigrator.Mutation SetMappingMutation [jvm]class SetMappingMutation(column: String, valueMapper: Function<Any, Any>) : BulkShardMigrator.Mutation SetMutation [jvm]class SetMutation(column: String, value: Any) : BulkShardMigrator.Mutation"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/#functions","title":"Functions","text":"Name Summary batched [jvm]fun batched(): BulkShardMigrator<R, C> batchSize [jvm]fun batchSize(batchSize: Int): BulkShardMigrator<R, C> execute [jvm]@JvmOverloadsfun execute(insertIgnore: Boolean = false) inc [jvm]operator fun inc(column: String): BulkShardMigrator<R, C> latestBatchOnly [jvm]fun latestBatchOnly(latestBatchOnly: Boolean): BulkShardMigrator<R, C> now [jvm]fun now(column: String): BulkShardMigrator<R, C> rootColumn [jvm]fun rootColumn(columnName: String): BulkShardMigrator<R, C> set [jvm]operator fun set(column: String, valueMapper: Function<Any, Any>): BulkShardMigrator<R, C>operator fun set(column: String, value: Any): BulkShardMigrator<R, C> source [jvm]fun source(sourceRoot: Id<R>): BulkShardMigrator<R, C> target [jvm]fun target(targetRoot: Id<R>): BulkShardMigrator<R, C> where [jvm]fun where(where: String, vararg parameters: Any): BulkShardMigrator<R, C>fun where(where: String, parameters: List<*>): BulkShardMigrator<R, C>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batch-size/","title":"batchSize - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/batchSize
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batch-size/#batchsize","title":"batchSize","text":"[jvm]\\ fun batchSize(batchSize: Int): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batched/","title":"batched - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/batched
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/batched/#batched","title":"batched","text":"[jvm]\\ fun batched(): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/execute/","title":"execute - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/execute
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/execute/#execute","title":"execute","text":"[jvm]\\
@JvmOverloads
fun execute(insertIgnore: Boolean = false)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/inc/","title":"inc - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/inc
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/inc/#inc","title":"inc","text":"[jvm]\\ operator fun inc(column: String): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/latest-batch-only/","title":"latestBatchOnly - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/latestBatchOnly
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/latest-batch-only/#latestbatchonly","title":"latestBatchOnly","text":"[jvm]\\ fun latestBatchOnly(latestBatchOnly: Boolean): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/now/","title":"now - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/now
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/now/#now","title":"now","text":"[jvm]\\ fun now(column: String): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/root-column/","title":"rootColumn - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/rootColumn
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/root-column/#rootcolumn","title":"rootColumn","text":"[jvm]\\ fun rootColumn(columnName: String): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/set/","title":"set - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/set
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/set/#set","title":"set","text":"[jvm]\\ operator fun set(column: String, value: Any): BulkShardMigrator<R, C>
operator fun set(column: String, valueMapper: Function<Any, Any>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/source/","title":"source - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/source
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/source/#source","title":"source","text":"[jvm]\\ fun source(sourceRoot: Id<R>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/target/","title":"target - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/target
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/target/#target","title":"target","text":"[jvm]\\ fun target(targetRoot: Id<R>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/where/","title":"where - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/where
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/where/#where","title":"where","text":"[jvm]\\ fun where(where: String, vararg parameters: Any): BulkShardMigrator<R, C>
fun where(where: String, parameters: List<*>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-companion/","title":"Companion - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/","title":"Factory - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Factory
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun <R : DbRoot<R>, C : DbChild<R, C>> create(transacter: Transacter, sessionFactory: SessionFactory, rootClass: KClass<R>, childClass: KClass<C>): BulkShardMigrator<R, C>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/-factory/","title":"Factory - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Factory/Factory
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/create/","title":"create - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Factory/create
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-factory/create/#create","title":"create","text":"[jvm]\\ fun <R : DbRoot<R>, C : DbChild<R, C>> create(transacter: Transacter, sessionFactory: SessionFactory, rootClass: KClass<R>, childClass: KClass<C>): BulkShardMigrator<R, C>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/","title":"IncMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/#incmutation","title":"IncMutation","text":"[jvm]\\ class IncMutation(column: String) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/#constructors","title":"Constructors","text":"IncMutation [jvm]constructor(column: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open override fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/-inc-mutation/","title":"IncMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/IncMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/-inc-mutation/#incmutation","title":"IncMutation","text":"[jvm]\\ constructor(column: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/update-sql/","title":"updateSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/IncMutation/updateSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-inc-mutation/update-sql/#updatesql","title":"updateSql","text":"[jvm]\\ open override fun updateSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/","title":"Mutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#mutation","title":"Mutation","text":"abstract class Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#inheritors","title":"Inheritors","text":"SetMutation SetMappingMutation NowMutation IncMutation"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#constructors","title":"Constructors","text":"Mutation [jvm]constructor()"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]abstract fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/-mutation/","title":"Mutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/-mutation/#mutation","title":"Mutation","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ abstract fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/insert-sql/","title":"insertSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/insertSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/insert-sql/#insertsql","title":"insertSql","text":"[jvm]\\ open fun insertSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/update-sql/","title":"updateSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/Mutation/updateSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-mutation/update-sql/#updatesql","title":"updateSql","text":"[jvm]\\ open fun updateSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/","title":"NowMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/#nowmutation","title":"NowMutation","text":"[jvm]\\ class NowMutation(column: String) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/#constructors","title":"Constructors","text":"NowMutation [jvm]constructor(column: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open override fun insertSql(): String updateSql [jvm]open override fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/-now-mutation/","title":"NowMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/NowMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/-now-mutation/#nowmutation","title":"NowMutation","text":"[jvm]\\ constructor(column: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/insert-sql/","title":"insertSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/insertSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/insert-sql/#insertsql","title":"insertSql","text":"[jvm]\\ open override fun insertSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/update-sql/","title":"updateSql - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/NowMutation/updateSql
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-now-mutation/update-sql/#updatesql","title":"updateSql","text":"[jvm]\\ open override fun updateSql(): String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/","title":"SetMappingMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/#setmappingmutation","title":"SetMappingMutation","text":"[jvm]\\ class SetMappingMutation(column: String, valueMapper: Function<Any, Any>) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/#constructors","title":"Constructors","text":"SetMappingMutation [jvm]constructor(column: String, valueMapper: Function<Any, Any>)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/-set-mapping-mutation/","title":"SetMappingMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation/SetMappingMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/-set-mapping-mutation/#setmappingmutation","title":"SetMappingMutation","text":"[jvm]\\ constructor(column: String, valueMapper: Function<Any, Any>)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMappingMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mapping-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/","title":"SetMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/#setmutation","title":"SetMutation","text":"[jvm]\\ class SetMutation(column: String, value: Any) : BulkShardMigrator.Mutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/#constructors","title":"Constructors","text":"SetMutation [jvm]constructor(column: String, value: Any)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/#functions","title":"Functions","text":"Name Summary bindInsert [jvm]open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int bindUpdate [jvm]open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int insertSql [jvm]open fun insertSql(): String updateSql [jvm]open fun updateSql(): String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/-set-mutation/","title":"SetMutation - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation/SetMutation
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/-set-mutation/#setmutation","title":"SetMutation","text":"[jvm]\\ constructor(column: String, value: Any)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-insert/","title":"bindInsert - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation/bindInsert
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-insert/#bindinsert","title":"bindInsert","text":"[jvm]\\ open override fun bindInsert(insert: PreparedStatement, parameterIndex: Int, value: Any): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-update/","title":"bindUpdate - Misk","text":"//misk-hibernate/misk.hibernate.migrate/BulkShardMigrator/SetMutation/bindUpdate
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.migrate/-bulk-shard-migrator/-set-mutation/bind-update/#bindupdate","title":"bindUpdate","text":"[jvm]\\ open override fun bindUpdate(update: PreparedStatement, parameterIndex: Int): Int
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/","title":"Package-level declarations - Misk","text":"//misk-hibernate/misk.hibernate.pagination
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/#types","title":"Types","text":"Name Summary Offset [jvm]data class Offset(val offset: String)Offset into a query. Typically this is a string-encoded ID like 5, or a composite containing a date followed by an ID, like \"2019-08-16T:10:26:51Z/5\". Page [jvm]data class Page<T>(val contents: List<T>, val nextOffset: Offset?) Pager [jvm]interface Pager<T> Paginator [jvm]interface Paginator<T, in Q : Query<T>>Breaks a query into pages. Each page break is delimited by a string that is the offset of the last row of the preceding page."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/#functions","title":"Functions","text":"Name Summary idAscPaginator [jvm]fun <T : DbEntity<T>> idAscPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>Pages through entities by ascending ID. idDescPaginator [jvm]fun <T : DbEntity<T>> idDescPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>Pages through entities by descending ID. listAll [jvm]fun <T : DbEntity<T>, R> Pager<T>.listAll(transacter: Transacter, transform: (T) -> R): List<R> newPager [jvm]fun <T : DbEntity<T>, Q : Query<T>> Q.newPager(paginator: Paginator<T, Q>, initialOffset: Offset? = null, pageSize: Int = 100): Pager<T>Use a null initialOffset to start at the beginning."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-asc-paginator/","title":"idAscPaginator - Misk","text":"//misk-hibernate/misk.hibernate.pagination/idAscPaginator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-asc-paginator/#idascpaginator","title":"idAscPaginator","text":"[jvm]\\ fun <T : DbEntity<T>> idAscPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>
Pages through entities by ascending ID.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-desc-paginator/","title":"idDescPaginator - Misk","text":"//misk-hibernate/misk.hibernate.pagination/idDescPaginator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/id-desc-paginator/#iddescpaginator","title":"idDescPaginator","text":"[jvm]\\ fun <T : DbEntity<T>> idDescPaginator(idPath: String = \"id\"): Paginator<T, Query<T>>
Pages through entities by descending ID.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/list-all/","title":"listAll - Misk","text":"//misk-hibernate/misk.hibernate.pagination/listAll
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/list-all/#listall","title":"listAll","text":"[jvm]\\ fun <T : DbEntity<T>, R> Pager<T>.listAll(transacter: Transacter, transform: (T) -> R): List<R>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/new-pager/","title":"newPager - Misk","text":"//misk-hibernate/misk.hibernate.pagination/newPager
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/new-pager/#newpager","title":"newPager","text":"[jvm]\\ fun <T : DbEntity<T>, Q : Query<T>> Q.newPager(paginator: Paginator<T, Q>, initialOffset: Offset? = null, pageSize: Int = 100): Pager<T>
Use a null initialOffset to start at the beginning.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/","title":"Offset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Offset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/#offset","title":"Offset","text":"[jvm]\\ data class Offset(val offset: String)
Offset into a query. Typically this is a string-encoded ID like 5, or a composite containing a date followed by an ID, like \"2019-08-16T:10:26:51Z/5\".
Don\u2019t put PII in here. Clients see these in URLs and API calls, and can manipulate them. This could also potentially leak database growth information!
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/#constructors","title":"Constructors","text":"Offset [jvm]constructor(offset: String)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/#properties","title":"Properties","text":"Name Summary offset [jvm]val offset: String"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/-offset/","title":"Offset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Offset/Offset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/-offset/#offset","title":"Offset","text":"[jvm]\\ constructor(offset: String)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/offset/","title":"offset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Offset/offset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-offset/offset/#offset","title":"offset","text":"[jvm]\\ val offset: String
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/","title":"Page - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#page","title":"Page","text":"[jvm]\\ data class Page<T>(val contents: List<T>, val nextOffset: Offset?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#constructors","title":"Constructors","text":"Page [jvm]constructor(contents: List<T>, nextOffset: Offset?)"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/#properties","title":"Properties","text":"Name Summary contents [jvm]val contents: List<T> nextOffset [jvm]val nextOffset: Offset?Null if there are no more results. Pass this in a subsequent call to Query.newPager."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-page/","title":"Page - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/Page
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-page/#page","title":"Page","text":"[jvm]\\ constructor(contents: List<T>, nextOffset: Offset?)
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/contents/","title":"contents - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/contents
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/contents/#contents","title":"contents","text":"[jvm]\\ val contents: List<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/next-offset/","title":"nextOffset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/nextOffset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/next-offset/#nextoffset","title":"nextOffset","text":"[jvm]\\ val nextOffset: Offset?
Null if there are no more results. Pass this in a subsequent call to Query.newPager.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/","title":"Companion - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/#functions","title":"Functions","text":"Name Summary empty [jvm]fun <T> empty(): Page<T>"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/empty/","title":"empty - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Page/Companion/empty
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-page/-companion/empty/#empty","title":"empty","text":"[jvm]\\ fun <T> empty(): Page<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/","title":"Pager - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Pager
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/#pager","title":"Pager","text":"[jvm]\\ interface Pager<T>
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/#functions","title":"Functions","text":"Name Summary hasNext [jvm]abstract fun hasNext(): BooleanReturns true when there are more pages to load. listAll [jvm]fun <T : DbEntity<T>, R> Pager<T>.listAll(transacter: Transacter, transform: (T) -> R): List<R> nextPage [jvm]abstract fun nextPage(session: Session): Page<T>?Returns null when there are no more pages."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/has-next/","title":"hasNext - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Pager/hasNext
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/has-next/#hasnext","title":"hasNext","text":"[jvm]\\ abstract fun hasNext(): Boolean
Returns true when there are more pages to load.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/next-page/","title":"nextPage - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Pager/nextPage
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-pager/next-page/#nextpage","title":"nextPage","text":"[jvm]\\ abstract fun nextPage(session: Session): Page<T>?
Returns null when there are no more pages.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/","title":"Paginator - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Paginator
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/#paginator","title":"Paginator","text":"[jvm]\\ interface Paginator<T, in Q : Query<T>>
Breaks a query into pages. Each page break is delimited by a string that is the offset of the last row of the preceding page.
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/#functions","title":"Functions","text":"Name Summary applyOffset [jvm]abstract fun applyOffset(query: Q, offset: Offset?)Adjust query so that is in paging order and offset by offset (if non-null). Most implementations will add anORDER BY clause. They should also add a WHERE column > offset constraint if the offset is non-null. getOffset [jvm]abstract fun getOffset(row: T): OffsetFigure out what the offset of row is, and encode that as a string."},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/apply-offset/","title":"applyOffset - Misk","text":"//misk-hibernate/misk.hibernate.pagination/Paginator/applyOffset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/apply-offset/#applyoffset","title":"applyOffset","text":"[jvm]\\ abstract fun applyOffset(query: Q, offset: Offset?)
Adjust query so that is in paging order and offset by offset (if non-null). Most implementations will add an ORDER BY clause. They should also add a WHERE column > offset constraint if the offset is non-null.
//misk-hibernate/misk.hibernate.pagination/Paginator/getOffset
"},{"location":"0.x/misk-hibernate/misk-hibernate/misk.hibernate.pagination/-paginator/get-offset/#getoffset","title":"getOffset","text":"[jvm]\\ abstract fun getOffset(row: T): Offset
Figure out what the offset of row is, and encode that as a string.
"},{"location":"0.x/misk-hotwire/","title":"misk-hotwire - Misk","text":"//misk-hotwire
"},{"location":"0.x/misk-hotwire/#misk-hotwire","title":"misk-hotwire","text":""},{"location":"0.x/misk-hotwire/#packages","title":"Packages","text":"Name misk.hotwire misk.turbo"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/","title":"Package-level declarations - Misk","text":"//misk-hotwire/misk.hotwire
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/#functions","title":"Functions","text":"Name Summary buildHtml [jvm]fun buildHtml(renderer: TagConsumer<*>.() -> Unit): String buildHtmlResponseBody [jvm]fun buildHtmlResponseBody(renderer: TagConsumer<*>.() -> Unit): ResponseBody"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html-response-body/","title":"buildHtmlResponseBody - Misk","text":"//misk-hotwire/misk.hotwire/buildHtmlResponseBody
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html-response-body/#buildhtmlresponsebody","title":"buildHtmlResponseBody","text":"[jvm]\\ fun buildHtmlResponseBody(renderer: TagConsumer<*>.() -> Unit): ResponseBody
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html/","title":"buildHtml - Misk","text":"//misk-hotwire/misk.hotwire/buildHtml
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.hotwire/build-html/#buildhtml","title":"buildHtml","text":"[jvm]\\ fun buildHtml(renderer: TagConsumer<*>.() -> Unit): String
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/","title":"Package-level declarations - Misk","text":"//misk-hotwire/misk.turbo
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/#types","title":"Types","text":"Name Summary Template [jvm]class Template(consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTagProduces HTML tag as required to define Hotwire Turbo using kotlinx.html. TurboFrame [jvm]class TurboFrame@JvmOverloadsconstructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTagProduces HTML tag as required to define Hotwire Turbo using kotlinx.html. TurboStream [jvm]class TurboStream(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTagProduces HTML tag as required to define Hotwire Turbo using kotlinx.html. TurboStreamAction [jvm]enum TurboStreamAction : Enum<TurboStreamAction> Different modes for TurboStream to be handled and result in DOM changes when it arrives via WebSocket or in HTTP response."},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/#functions","title":"Functions","text":"Name Summary addHotwireHeadImports [jvm]fun TagConsumer<*>.addHotwireHeadImports(appRoot: String)HTML tags to add to Head to configure Hotwire (Turbo, Stimulus) dependencies and default controllers template [jvm]fun TagConsumer<*>.template(block: Template.() -> Unit = {}) turbo_frame [jvm]fun TagConsumer<*>.turbo_frame(id: String, src: String? = null, lazy: Boolean = false, block: TurboFrame.() -> Unit = {}) turbo_stream [jvm]fun TagConsumer<*>.turbo_stream(action: TurboStreamAction, targetId: String, block: TurboStream.() -> Unit = {})"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/add-hotwire-head-imports/","title":"addHotwireHeadImports - Misk","text":"//misk-hotwire/misk.turbo/addHotwireHeadImports
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/add-hotwire-head-imports/#addhotwireheadimports","title":"addHotwireHeadImports","text":"[jvm]\\ fun TagConsumer<*>.addHotwireHeadImports(appRoot: String)
HTML tags to add to Head to configure Hotwire (Turbo, Stimulus) dependencies and default controllers
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/template/","title":"template - Misk","text":"//misk-hotwire/misk.turbo/template
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/template/#template","title":"template","text":"[jvm]\\ fun TagConsumer<*>.template(block: Template.() -> Unit = {})
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_frame/","title":"turbo_frame - Misk","text":"//misk-hotwire/misk.turbo/turbo_frame
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_frame/#turbo_frame","title":"turbo_frame","text":"[jvm]\\ fun TagConsumer<*>.turbo_frame(id: String, src: String? = null, lazy: Boolean = false, block: TurboFrame.() -> Unit = {})
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_stream/","title":"turbo_stream - Misk","text":"//misk-hotwire/misk.turbo/turbo_stream
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/turbo_stream/#turbo_stream","title":"turbo_stream","text":"[jvm]\\ fun TagConsumer<*>.turbo_stream(action: TurboStreamAction, targetId: String, block: TurboStream.() -> Unit = {})
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/","title":"Template - Misk","text":"//misk-hotwire/misk.turbo/Template
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#template","title":"Template","text":"[jvm]\\ class Template(consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTag
Produces HTML tag as required to define Hotwire Turbo using kotlinx.html.
Follows the spec from Hotwire docs: https://turbo.hotwired.dev/handbook/streams
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#constructors","title":"Constructors","text":"Template [jvm]constructor(consumer: TagConsumer<*>)"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#properties","title":"Properties","text":"Name Summary attributes [jvm]open override val attributes: DelegatingMap attributesEntries [jvm]open override val attributesEntries: Collection<Map.Entry<String, String>> consumer [jvm]open override val consumer: TagConsumer<*> emptyTag [jvm]open override val emptyTag: Boolean inlineTag [jvm]open override val inlineTag: Boolean namespace [jvm]open override val namespace: String? tagName [jvm]open override val tagName: String"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/#functions","title":"Functions","text":"Name Summary comment [jvm]open fun comment(s: String) entity [jvm]open fun entity(e: Entities) text [jvm]open fun text(n: Number)open fun text(s: String) unaryPlus [jvm]open operator fun String.unaryPlus()open operator fun Entities.unaryPlus()"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/-template/","title":"Template - Misk","text":"//misk-hotwire/misk.turbo/Template/Template
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-template/-template/#template","title":"Template","text":"[jvm]\\ constructor(consumer: TagConsumer<*>)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/","title":"TurboFrame - Misk","text":"//misk-hotwire/misk.turbo/TurboFrame
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#turboframe","title":"TurboFrame","text":"[jvm]\\ class TurboFrame@JvmOverloadsconstructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTag
Produces HTML tag as required to define Hotwire Turbo using kotlinx.html.
Follows the spec from Hotwire docs: https://turbo.hotwired.dev/handbook/frames
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#constructors","title":"Constructors","text":"TurboFrame [jvm]@JvmOverloadsconstructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>)"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#properties","title":"Properties","text":"Name Summary attributes [jvm]open override val attributes: DelegatingMap attributesEntries [jvm]open override val attributesEntries: Collection<Map.Entry<String, String>> consumer [jvm]open override val consumer: TagConsumer<*> emptyTag [jvm]open override val emptyTag: Boolean inlineTag [jvm]open override val inlineTag: Boolean namespace [jvm]open override val namespace: String? tagName [jvm]open override val tagName: String"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/#functions","title":"Functions","text":"Name Summary comment [jvm]open fun comment(s: String) entity [jvm]open fun entity(e: Entities) text [jvm]open fun text(n: Number)open fun text(s: String) unaryPlus [jvm]open operator fun String.unaryPlus()open operator fun Entities.unaryPlus()"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/-turbo-frame/","title":"TurboFrame - Misk","text":"//misk-hotwire/misk.turbo/TurboFrame/TurboFrame
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-frame/-turbo-frame/#turboframe","title":"TurboFrame","text":"[jvm]\\
@JvmOverloads
constructor(id: String, src: String? = null, lazy: Boolean = false, consumer: TagConsumer<*>)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/","title":"TurboStream - Misk","text":"//misk-hotwire/misk.turbo/TurboStream
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#turbostream","title":"TurboStream","text":"[jvm]\\ class TurboStream(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>) : HTMLTag, HtmlInlineTag
Produces HTML tag as required to define Hotwire Turbo using kotlinx.html.
Example Produced HTML"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#constructors","title":"Constructors","text":"TurboStream [jvm]constructor(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>)"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#properties","title":"Properties","text":"Name Summary attributes [jvm]open override val attributes: DelegatingMap attributesEntries [jvm]open override val attributesEntries: Collection<Map.Entry<String, String>> consumer [jvm]open override val consumer: TagConsumer<*> emptyTag [jvm]open override val emptyTag: Boolean inlineTag [jvm]open override val inlineTag: Boolean namespace [jvm]open override val namespace: String? tagName [jvm]open override val tagName: String"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/#functions","title":"Functions","text":"Name Summary comment [jvm]open fun comment(s: String) entity [jvm]open fun entity(e: Entities) text [jvm]open fun text(n: Number)open fun text(s: String) unaryPlus [jvm]open operator fun String.unaryPlus()open operator fun Entities.unaryPlus()"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/-turbo-stream/","title":"TurboStream - Misk","text":"
//misk-hotwire/misk.turbo/TurboStream/TurboStream
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream/-turbo-stream/#turbostream","title":"TurboStream","text":"[jvm]\\ constructor(action: TurboStreamAction, targetId: String, consumer: TagConsumer<*>)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/","title":"TurboStreamAction - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#turbostreamaction","title":"TurboStreamAction","text":"[jvm]\\ enum TurboStreamAction : Enum<TurboStreamAction>
Different modes for TurboStream to be handled and result in DOM changes when it arrives via WebSocket or in HTTP response.
https://turbo.hotwired.dev/handbook/streams
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#entries","title":"Entries","text":"APPEND [jvm]APPEND PREPEND [jvm]PREPEND REPLACE [jvm]REPLACE UPDATE [jvm]UPDATE REMOVE [jvm]REMOVE BEFORE [jvm]BEFORE AFTER [jvm]AFTER"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<TurboStreamAction>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): TurboStreamActionReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<TurboStreamAction>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/entries/","title":"entries - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/entries
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<TurboStreamAction>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/value-of/","title":"valueOf - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/valueOf
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): TurboStreamAction
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/values/","title":"values - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/values
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<TurboStreamAction>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-f-t-e-r/","title":"AFTER - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/AFTER
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-f-t-e-r/#after","title":"AFTER","text":"[jvm]\\ AFTER
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-f-t-e-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-p-p-e-n-d/","title":"APPEND - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/APPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-p-p-e-n-d/#append","title":"APPEND","text":"[jvm]\\ APPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-a-p-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-b-e-f-o-r-e/","title":"BEFORE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/BEFORE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-b-e-f-o-r-e/#before","title":"BEFORE","text":"[jvm]\\ BEFORE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-b-e-f-o-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-p-r-e-p-e-n-d/","title":"PREPEND - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/PREPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-p-r-e-p-e-n-d/#prepend","title":"PREPEND","text":"[jvm]\\ PREPEND
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-p-r-e-p-e-n-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-m-o-v-e/","title":"REMOVE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/REMOVE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-m-o-v-e/#remove","title":"REMOVE","text":"[jvm]\\ REMOVE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-m-o-v-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-p-l-a-c-e/","title":"REPLACE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/REPLACE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-p-l-a-c-e/#replace","title":"REPLACE","text":"[jvm]\\ REPLACE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-r-e-p-l-a-c-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-u-p-d-a-t-e/","title":"UPDATE - Misk","text":"//misk-hotwire/misk.turbo/TurboStreamAction/UPDATE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-u-p-d-a-t-e/#update","title":"UPDATE","text":"[jvm]\\ UPDATE
"},{"location":"0.x/misk-hotwire/misk-hotwire/misk.turbo/-turbo-stream-action/-u-p-d-a-t-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-inject/","title":"misk-inject - Misk","text":"//misk-inject
"},{"location":"0.x/misk-inject/#misk-inject","title":"misk-inject","text":""},{"location":"0.x/misk-inject/#packages","title":"Packages","text":"Name misk.inject"},{"location":"0.x/misk-inject/misk-inject/misk.inject/","title":"Package-level declarations - Misk","text":"//misk-inject/misk.inject
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-inject/misk-inject/misk.inject/#types","title":"Types","text":"Name Summary KAbstractModule [jvm]abstract class KAbstractModule : AbstractModuleA class that provides helper methods for working with Kotlin and Guice, allowing implementing classes to operate in the Kotlin type system rather than converting to Java. KInstallOnceModule [jvm]abstract class KInstallOnceModule : KAbstractModuleMake it safe to install multiple instances of this module. Guice will only install it once. ReusableTestModule [jvm]@ExperimentalMiskApiabstract class ReusableTestModule : KInstallOnceModuleThis class should be extended by test modules used in tests, for misk to reuse the guice injector across tests for significantly faster test suite performance."},{"location":"0.x/misk-inject/misk-inject/misk.inject/#functions","title":"Functions","text":"Name Summary asSingleton [jvm]fun ScopedBindingBuilder.asSingleton() getInstance [jvm]inline fun <T : Any> Injector.getInstance(annotation: Annotation? = null): T getSetOf [jvm]fun <T : Any> Injector.getSetOf(type: KClass<T>, annotation: KClass<out Annotation>? = null): Set<T> keyOf [jvm]inline fun <T : Any> keyOf(): Key<T>inline fun <T : Any> keyOf(a: Annotation): Key<T>[jvm]inline fun <T : Any> keyOf(a: KClass<out Annotation>?): Key<T>If annotation is not null, returns a key for @Annotation T, otherwise a key for T. listOfType [jvm]inline fun <T : Any> listOfType(): TypeLiteral<List<T>>fun <T> listOfType(elementType: TypeLiteral<T>): TypeLiteral<List<T>>fun <T : Any> listOfType(elementType: KClass<T>): TypeLiteral<List<T>> mapOfType [jvm]inline fun <K : Any, V : Any> mapOfType(): TypeLiteral<Map<K, V>>fun <K, V> mapOfType(keyType: TypeLiteral<K>, valueType: TypeLiteral<V>): TypeLiteral<Map<K, V>>fun <K : Any, V : Any> mapOfType(keyType: KClass<K>, valueType: KClass<V>): TypeLiteral<Map<K, V>> parameterizedType [jvm]inline fun <T : Any> parameterizedType(vararg typeParameters: Type): ParameterizedType setOfType [jvm]inline fun <T : Any> setOfType(): TypeLiteral<Set<T>>fun <T> setOfType(elementType: TypeLiteral<T>): TypeLiteral<Set<T>>fun <T : Any> setOfType(elementType: KClass<T>): TypeLiteral<Set<T>> subtypeOf [jvm]inline fun <T : Any> subtypeOf(): WildcardType toKey [jvm]fun <T : Any> TypeLiteral<T>.toKey(annotation: KClass<out Annotation>? = null): Key<T>fun <T : Any> KClass<T>.toKey(qualifier: KClass<out Annotation>? = null): Key<T> typeLiteral [jvm]fun Type.typeLiteral(): TypeLiteral<>fun <T : Any> KClass<T>.typeLiteral(): TypeLiteral<T>fun KType.typeLiteral(): TypeLiteral<> uninject [jvm]fun uninject(target: Any)"},{"location":"0.x/misk-inject/misk-inject/misk.inject/as-singleton/","title":"asSingleton - Misk","text":"//misk-inject/misk.inject/asSingleton
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/as-singleton/#assingleton","title":"asSingleton","text":"[jvm]\\ fun ScopedBindingBuilder.asSingleton()
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-instance/","title":"getInstance - Misk","text":"//misk-inject/misk.inject/getInstance
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-instance/#getinstance","title":"getInstance","text":"[jvm]\\ inline fun <T : Any> Injector.getInstance(annotation: Annotation? = null): T
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-set-of/","title":"getSetOf - Misk","text":"//misk-inject/misk.inject/getSetOf
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/get-set-of/#getsetof","title":"getSetOf","text":"[jvm]\\ fun <T : Any> Injector.getSetOf(type: KClass<T>, annotation: KClass<out Annotation>? = null): Set<T>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/key-of/","title":"keyOf - Misk","text":"//misk-inject/misk.inject/keyOf
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/key-of/#keyof","title":"keyOf","text":"[jvm]\\ inline fun <T : Any> keyOf(): Key<T>
inline fun <T : Any> keyOf(a: Annotation): Key<T>
[jvm]\\ inline fun <T : Any> keyOf(a: KClass<out Annotation>?): Key<T>
If annotation is not null, returns a key for @Annotation T, otherwise a key for T.
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/list-of-type/","title":"listOfType - Misk","text":"//misk-inject/misk.inject/listOfType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/list-of-type/#listoftype","title":"listOfType","text":"[jvm]\\ fun <T> listOfType(elementType: TypeLiteral<T>): TypeLiteral<List<T>>
fun <T : Any> listOfType(elementType: KClass<T>): TypeLiteral<List<T>>
inline fun <T : Any> listOfType(): TypeLiteral<List<T>>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/map-of-type/","title":"mapOfType - Misk","text":"//misk-inject/misk.inject/mapOfType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/map-of-type/#mapoftype","title":"mapOfType","text":"[jvm]\\ inline fun <K : Any, V : Any> mapOfType(): TypeLiteral<Map<K, V>>
fun <K : Any, V : Any> mapOfType(keyType: KClass<K>, valueType: KClass<V>): TypeLiteral<Map<K, V>>
fun <K, V> mapOfType(keyType: TypeLiteral<K>, valueType: TypeLiteral<V>): TypeLiteral<Map<K, V>>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/parameterized-type/","title":"parameterizedType - Misk","text":"//misk-inject/misk.inject/parameterizedType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/parameterized-type/#parameterizedtype","title":"parameterizedType","text":"[jvm]\\ inline fun <T : Any> parameterizedType(vararg typeParameters: Type): ParameterizedType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/set-of-type/","title":"setOfType - Misk","text":"//misk-inject/misk.inject/setOfType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/set-of-type/#setoftype","title":"setOfType","text":"[jvm]\\ fun <T> setOfType(elementType: TypeLiteral<T>): TypeLiteral<Set<T>>
fun <T : Any> setOfType(elementType: KClass<T>): TypeLiteral<Set<T>>
inline fun <T : Any> setOfType(): TypeLiteral<Set<T>>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/subtype-of/","title":"subtypeOf - Misk","text":"//misk-inject/misk.inject/subtypeOf
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/subtype-of/#subtypeof","title":"subtypeOf","text":"[jvm]\\ inline fun <T : Any> subtypeOf(): WildcardType
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/to-key/","title":"toKey - Misk","text":"//misk-inject/misk.inject/toKey
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/to-key/#tokey","title":"toKey","text":"[jvm]\\ fun <T : Any> TypeLiteral<T>.toKey(annotation: KClass<out Annotation>? = null): Key<T>
fun <T : Any> KClass<T>.toKey(qualifier: KClass<out Annotation>? = null): Key<T>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/type-literal/","title":"typeLiteral - Misk","text":"//misk-inject/misk.inject/typeLiteral
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/type-literal/#typeliteral","title":"typeLiteral","text":"[jvm]\\ fun Type.typeLiteral(): TypeLiteral<*>
fun KType.typeLiteral(): TypeLiteral<*>
fun <T : Any> KClass<T>.typeLiteral(): TypeLiteral<T>
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/uninject/","title":"uninject - Misk","text":"//misk-inject/misk.inject/uninject
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/uninject/#uninject","title":"uninject","text":"[jvm]\\ fun uninject(target: Any)
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-abstract-module/","title":"KAbstractModule - Misk","text":"//misk-inject/misk.inject/KAbstractModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-abstract-module/#kabstractmodule","title":"KAbstractModule","text":"abstract class KAbstractModule : AbstractModule
A class that provides helper methods for working with Kotlin and Guice, allowing implementing classes to operate in the Kotlin type system rather than converting to Java.
The more Kotlin friendly API allows calls like:
bind(Foo::class.java).to(RealFoo::class.java)\nTo be rewritten as:
bind<Foo>().to<RealFoo>()\n//misk-inject/misk.inject/KAbstractModule/KAbstractModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-abstract-module/-k-abstract-module/#kabstractmodule","title":"KAbstractModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/","title":"KInstallOnceModule - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#kinstalloncemodule","title":"KInstallOnceModule","text":"abstract class KInstallOnceModule : KAbstractModule
Make it safe to install multiple instances of this module. Guice will only install it once.
This eases dependency management of library/core dependencies which benefit from multiple installation sites in varying configurations.
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#inheritors","title":"Inheritors","text":"ReusableTestModule"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#constructors","title":"Constructors","text":"KInstallOnceModule [jvm]constructor()"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/-k-install-once-module/","title":"KInstallOnceModule - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule/KInstallOnceModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/-k-install-once-module/#kinstalloncemodule","title":"KInstallOnceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/equals/","title":"equals - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule/equals
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/equals/#equals","title":"equals","text":"[jvm]\\ operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/hash-code/","title":"hashCode - Misk","text":"//misk-inject/misk.inject/KInstallOnceModule/hashCode
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-k-install-once-module/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ override fun hashCode(): Int
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/","title":"ReusableTestModule - Misk","text":"//misk-inject/misk.inject/ReusableTestModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/#reusabletestmodule","title":"ReusableTestModule","text":"[jvm]\\ @ExperimentalMiskApi
abstract class ReusableTestModule : KInstallOnceModule
This class should be extended by test modules used in tests, for misk to reuse the guice injector across tests for significantly faster test suite performance.
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/#constructors","title":"Constructors","text":"ReusableTestModule [jvm]constructor()"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/-reusable-test-module/","title":"ReusableTestModule - Misk","text":"//misk-inject/misk.inject/ReusableTestModule/ReusableTestModule
"},{"location":"0.x/misk-inject/misk-inject/misk.inject/-reusable-test-module/-reusable-test-module/#reusabletestmodule","title":"ReusableTestModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/","title":"misk-jdbc - Misk","text":"//misk-jdbc
"},{"location":"0.x/misk-jdbc/#misk-jdbc","title":"misk-jdbc","text":""},{"location":"0.x/misk-jdbc/#packages","title":"Packages","text":"Name misk.database misk.jdbc misk.vitess"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/","title":"Package-level declarations - Misk","text":"//misk-jdbc/misk.database
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/#types","title":"Types","text":"Name Summary CockroachCluster [jvm]class CockroachCluster(val name: String, val config: DataSourceConfig) DatabaseServer [jvm]interface DatabaseServerRepresents a database server for development/testing generally running in Docker. DockerCockroachCluster [jvm]class DockerCockroachCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer DockerPostgresServer [jvm]class DockerPostgresServer(val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer DockerTidbCluster [jvm]class DockerTidbCluster(val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer DockerVitessCluster [jvm]class DockerVitessCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer Keyspace [jvm]class Keyspace(val sharded: Boolean, val tables: Map<String, Table>) StartDatabaseService [jvm]class StartDatabaseService(qualifier: KClass<out Annotation>, deployment: Deployment, config: DataSourceConfig) : AbstractIdleServiceAll Vitess clusters used by the app/test are tracked in a global cache as a DockerVitessCluster. StartVitessService [jvm]class StartVitessService Table [jvm]class Table TidbCluster [jvm]class TidbCluster(val resourceLoader: ResourceLoader, val config: DataSourceConfig) VitessCluster [jvm]class VitessCluster@JvmOverloadsconstructor(val name: String, resourceLoader: ResourceLoader, val config: DataSourceConfig, val moshi: Moshi = defaultKotlinMoshi)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/#functions","title":"Functions","text":"Name Summary runCommand [jvm]fun runCommand(command: String): Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/run-command/","title":"runCommand - Misk","text":"//misk-jdbc/misk.database/runCommand
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/run-command/#runcommand","title":"runCommand","text":"[jvm]\\ fun runCommand(command: String): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/","title":"CockroachCluster - Misk","text":"//misk-jdbc/misk.database/CockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#cockroachcluster","title":"CockroachCluster","text":"[jvm]\\ class CockroachCluster(val name: String, val config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#constructors","title":"Constructors","text":"CockroachCluster [jvm]constructor(name: String, config: DataSourceConfig)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig externalHttpPort [jvm]val externalHttpPort: Int = 26258 internalHttpPort [jvm]val internalHttpPort: Int = 8080 name [jvm]val name: String postgresPort [jvm]val postgresPort: Int = 26257"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/#functions","title":"Functions","text":"Name Summary openConnection [jvm]fun openConnection(): ConnectionConnect to vtgate."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/-cockroach-cluster/","title":"CockroachCluster - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/CockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/-cockroach-cluster/#cockroachcluster","title":"CockroachCluster","text":"[jvm]\\ constructor(name: String, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/external-http-port/","title":"externalHttpPort - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/externalHttpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/external-http-port/#externalhttpport","title":"externalHttpPort","text":"[jvm]\\ val externalHttpPort: Int = 26258
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/internal-http-port/","title":"internalHttpPort - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/internalHttpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/internal-http-port/#internalhttpport","title":"internalHttpPort","text":"[jvm]\\ val internalHttpPort: Int = 8080
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/open-connection/","title":"openConnection - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/openConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/open-connection/#openconnection","title":"openConnection","text":"[jvm]\\ fun openConnection(): Connection
Connect to vtgate.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/postgres-port/","title":"postgresPort - Misk","text":"//misk-jdbc/misk.database/CockroachCluster/postgresPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-cockroach-cluster/postgres-port/#postgresport","title":"postgresPort","text":"[jvm]\\ val postgresPort: Int = 26257
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/","title":"DatabaseServer - Misk","text":"//misk-jdbc/misk.database/DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/#databaseserver","title":"DatabaseServer","text":"interface DatabaseServer
Represents a database server for development/testing generally running in Docker.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/#inheritors","title":"Inheritors","text":"DockerCockroachCluster DockerPostgresServer DockerTidbCluster DockerVitessCluster"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/#functions","title":"Functions","text":"Name Summary pullImage [jvm]abstract fun pullImage() start [jvm]abstract fun start() stop [jvm]abstract fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DatabaseServer/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ abstract fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DatabaseServer/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/start/#start","title":"start","text":"[jvm]\\ abstract fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DatabaseServer/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-database-server/stop/#stop","title":"stop","text":"[jvm]\\ abstract fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/","title":"DockerCockroachCluster - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#dockercockroachcluster","title":"DockerCockroachCluster","text":"[jvm]\\ class DockerCockroachCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#constructors","title":"Constructors","text":"DockerCockroachCluster [jvm]constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerCockroachCluster.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#properties","title":"Properties","text":"Name Summary cluster [jvm]val cluster: CockroachCluster config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient moshi [jvm]val moshi: Moshi name [jvm]val name: String resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-docker-cockroach-cluster/","title":"DockerCockroachCluster - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/DockerCockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-docker-cockroach-cluster/#dockercockroachcluster","title":"DockerCockroachCluster","text":"[jvm]\\ constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/cluster/","title":"cluster - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/cluster/#cluster","title":"cluster","text":"[jvm]\\ val cluster: CockroachCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME [jvm]const val CONTAINER_NAME: String IMAGE [jvm]const val IMAGE: String logger [jvm]val logger: KLogger SHA [jvm]const val SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/","title":"CONTAINER_NAME - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/CONTAINER_NAME
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/#container_name","title":"CONTAINER_NAME","text":"[jvm]\\ const val CONTAINER_NAME: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-i-m-a-g-e/","title":"IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-i-m-a-g-e/#image","title":"IMAGE","text":"[jvm]\\ const val IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-s-h-a/","title":"SHA - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/-s-h-a/#sha","title":"SHA","text":"[jvm]\\ const val SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerCockroachCluster.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerCockroachCluster.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerCockroachCluster.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerCockroachCluster/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-cockroach-cluster/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/","title":"DockerPostgresServer - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#dockerpostgresserver","title":"DockerPostgresServer","text":"[jvm]\\ class DockerPostgresServer(val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#constructors","title":"Constructors","text":"DockerPostgresServer [jvm]constructor(config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerPostgresServer.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-docker-postgres-server/","title":"DockerPostgresServer - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/DockerPostgresServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-docker-postgres-server/#dockerpostgresserver","title":"DockerPostgresServer","text":"[jvm]\\ constructor(config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME [jvm]const val CONTAINER_NAME: String IMAGE [jvm]const val IMAGE: String logger [jvm]val logger: KLogger SHA [jvm]const val SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/","title":"CONTAINER_NAME - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/CONTAINER_NAME
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/#container_name","title":"CONTAINER_NAME","text":"[jvm]\\ const val CONTAINER_NAME: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-i-m-a-g-e/","title":"IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-i-m-a-g-e/#image","title":"IMAGE","text":"[jvm]\\ const val IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-s-h-a/","title":"SHA - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/-s-h-a/#sha","title":"SHA","text":"[jvm]\\ const val SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerPostgresServer.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerPostgresServer.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerPostgresServer.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerPostgresServer/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-postgres-server/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/","title":"DockerTidbCluster - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#dockertidbcluster","title":"DockerTidbCluster","text":"[jvm]\\ class DockerTidbCluster(val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#constructors","title":"Constructors","text":"DockerTidbCluster [jvm]constructor(moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerTidbCluster.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#properties","title":"Properties","text":"Name Summary cluster [jvm]val cluster: TidbCluster config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient moshi [jvm]val moshi: Moshi resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-docker-tidb-cluster/","title":"DockerTidbCluster - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/DockerTidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-docker-tidb-cluster/#dockertidbcluster","title":"DockerTidbCluster","text":"[jvm]\\ constructor(moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/cluster/","title":"cluster - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/cluster/#cluster","title":"cluster","text":"[jvm]\\ val cluster: TidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME [jvm]const val CONTAINER_NAME: String IMAGE [jvm]const val IMAGE: String logger [jvm]val logger: KLogger SHA [jvm]const val SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/","title":"CONTAINER_NAME - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/CONTAINER_NAME
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e/#container_name","title":"CONTAINER_NAME","text":"[jvm]\\ const val CONTAINER_NAME: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-i-m-a-g-e/","title":"IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-i-m-a-g-e/#image","title":"IMAGE","text":"[jvm]\\ const val IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-s-h-a/","title":"SHA - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/-s-h-a/#sha","title":"SHA","text":"[jvm]\\ const val SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerTidbCluster.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerTidbCluster.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerTidbCluster.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerTidbCluster/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-tidb-cluster/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/","title":"DockerVitessCluster - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#dockervitesscluster","title":"DockerVitessCluster","text":"[jvm]\\ class DockerVitessCluster(val name: String, val moshi: Moshi, val resourceLoader: ResourceLoader, val config: DataSourceConfig, val docker: DockerClient) : DatabaseServer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#constructors","title":"Constructors","text":"DockerVitessCluster [jvm]constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion LogContainerResultCallback [jvm]class LogContainerResultCallback : ResultCallbackTemplate<DockerVitessCluster.LogContainerResultCallback, Frame>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#properties","title":"Properties","text":"Name Summary cluster [jvm]val cluster: VitessCluster config [jvm]val config: DataSourceConfig docker [jvm]val docker: DockerClient moshi [jvm]val moshi: Moshi name [jvm]val name: String resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/#functions","title":"Functions","text":"Name Summary pullImage [jvm]open override fun pullImage() start [jvm]open override fun start() stop [jvm]open override fun stop()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-docker-vitess-cluster/","title":"DockerVitessCluster - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/DockerVitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-docker-vitess-cluster/#dockervitesscluster","title":"DockerVitessCluster","text":"[jvm]\\ constructor(name: String, moshi: Moshi, resourceLoader: ResourceLoader, config: DataSourceConfig, docker: DockerClient)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/cluster/","title":"cluster - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/cluster/#cluster","title":"cluster","text":"[jvm]\\ val cluster: VitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/docker/","title":"docker - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/docker
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/docker/#docker","title":"docker","text":"[jvm]\\ val docker: DockerClient
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ open override fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/start/","title":"start - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/start
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/start/#start","title":"start","text":"[jvm]\\ open override fun start()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/stop/","title":"stop - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/stop
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/stop/#stop","title":"stop","text":"[jvm]\\ open override fun stop()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/#properties","title":"Properties","text":"Name Summary CONTAINER_NAME_PREFIX [jvm]const val CONTAINER_NAME_PREFIX: String logger [jvm]val logger: KLogger VITESS_IMAGE [jvm]const val VITESS_IMAGE: String VITESS_SHA [jvm]const val VITESS_SHA: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/#functions","title":"Functions","text":"Name Summary pullImage [jvm]fun pullImage() startVitessDaemon [jvm]fun startVitessDaemon(qualifier: KClass<out Annotation>, config: DataSourceConfig)A helper method to start the Vitess cluster outside of the dev server or test process, to enable rapid iteration. This should be called directly amain() function, for example:"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e_-p-r-e-f-i-x/","title":"CONTAINER_NAME_PREFIX - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/CONTAINER_NAME_PREFIX
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-c-o-n-t-a-i-n-e-r_-n-a-m-e_-p-r-e-f-i-x/#container_name_prefix","title":"CONTAINER_NAME_PREFIX","text":"[jvm]\\ const val CONTAINER_NAME_PREFIX: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-i-m-a-g-e/","title":"VITESS_IMAGE - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/VITESS_IMAGE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-i-m-a-g-e/#vitess_image","title":"VITESS_IMAGE","text":"[jvm]\\ const val VITESS_IMAGE: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-s-h-a/","title":"VITESS_SHA - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/VITESS_SHA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/-v-i-t-e-s-s_-s-h-a/#vitess_sha","title":"VITESS_SHA","text":"[jvm]\\ const val VITESS_SHA: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/pull-image/","title":"pullImage - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/pullImage
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/pull-image/#pullimage","title":"pullImage","text":"[jvm]\\ fun pullImage()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/start-vitess-daemon/","title":"startVitessDaemon - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/Companion/startVitessDaemon
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-companion/start-vitess-daemon/#startvitessdaemon","title":"startVitessDaemon","text":"[jvm]\\ fun startVitessDaemon(qualifier: KClass<out Annotation>, config: DataSourceConfig)
A helper method to start the Vitess cluster outside of the dev server or test process, to enable rapid iteration. This should be called directly a main() function, for example:
MyAppVitessDaemon.kt:
fun main() { val config = MiskConfig.load(\"myapp\", Environment.TESTING) startVitessDaemon(MyAppDb::class, config.data_source_clusters.values.first().writer) }"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"
//misk-jdbc/misk.database/DockerVitessCluster/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ class LogContainerResultCallback : ResultCallbackTemplate<DockerVitessCluster.LogContainerResultCallback, Frame>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/#constructors","title":"Constructors","text":"LogContainerResultCallback [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/#functions","title":"Functions","text":"Name Summary awaitCompletion [jvm]open fun awaitCompletion(): DockerVitessCluster.LogContainerResultCallbackopen fun awaitCompletion(p0: Long, p1: TimeUnit): Boolean awaitStarted [jvm]open fun awaitStarted(): DockerVitessCluster.LogContainerResultCallbackopen fun awaitStarted(p0: Long, p1: TimeUnit): Boolean close [jvm]open override fun close() onComplete [jvm]open override fun onComplete() onError [jvm]open override fun onError(p0: Throwable) onNext [jvm]open override fun onNext(item: Frame) onStart [jvm]open override fun onStart(p0: Closeable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/-log-container-result-callback/","title":"LogContainerResultCallback - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/LogContainerResultCallback/LogContainerResultCallback
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/-log-container-result-callback/#logcontainerresultcallback","title":"LogContainerResultCallback","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/on-next/","title":"onNext - Misk","text":"//misk-jdbc/misk.database/DockerVitessCluster/LogContainerResultCallback/onNext
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-docker-vitess-cluster/-log-container-result-callback/on-next/#onnext","title":"onNext","text":"[jvm]\\ open override fun onNext(item: Frame)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.database/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ class Keyspace(val sharded: Boolean, val tables: Map<String, Table>)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#constructors","title":"Constructors","text":"Keyspace [jvm]constructor(sharded: Boolean, tables: Map<String, Table>)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#properties","title":"Properties","text":"Name Summary sharded [jvm]val sharded: Boolean tables [jvm]val tables: Map<String, Table>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/#functions","title":"Functions","text":"Name Summary shardCount [jvm]fun shardCount(): Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.database/Keyspace/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ constructor(sharded: Boolean, tables: Map<String, Table>)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/shard-count/","title":"shardCount - Misk","text":"//misk-jdbc/misk.database/Keyspace/shardCount
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/shard-count/#shardcount","title":"shardCount","text":"[jvm]\\ fun shardCount(): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/sharded/","title":"sharded - Misk","text":"//misk-jdbc/misk.database/Keyspace/sharded
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/sharded/#sharded","title":"sharded","text":"[jvm]\\ val sharded: Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/tables/","title":"tables - Misk","text":"//misk-jdbc/misk.database/Keyspace/tables
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-keyspace/tables/#tables","title":"tables","text":"[jvm]\\ val tables: Map<String, Table>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/","title":"StartDatabaseService - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/#startdatabaseservice","title":"StartDatabaseService","text":"[jvm]\\ class StartDatabaseService(qualifier: KClass<out Annotation>, deployment: Deployment, config: DataSourceConfig) : AbstractIdleService
All Vitess clusters used by the app/test are tracked in a global cache as a DockerVitessCluster.
On startup, the service will look for a cluster in the cache, and if not found, look for it in Docker by container name, or as a last resort start the container itself.
On shutdown, the cache is invalidated by a JVM shutdown hook. On invalidation, the cache will call the each entry\u2019s stop() method. If the cluster container was created in this JVM, it will be stopped and removed. Otherwise (if the container was started by a different process), it will be left running.
//misk-jdbc/misk.database/StartDatabaseService/StartDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-start-database-service/#startdatabaseservice","title":"StartDatabaseService","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, deployment: Deployment, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/init/","title":"init - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/init
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/init/#init","title":"init","text":"[jvm]\\ fun init(): StartDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/server/","title":"server - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/server
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/server/#server","title":"server","text":"[jvm]\\ var server: DatabaseServer?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/","title":"CacheKey - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/#cachekey","title":"CacheKey","text":"[jvm]\\ data class CacheKey(val name: String, val config: DataSourceConfig, val deployment: Deployment)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/#constructors","title":"Constructors","text":"CacheKey [jvm]constructor(name: String, config: DataSourceConfig, deployment: Deployment)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig deployment [jvm]val deployment: Deployment name [jvm]val name: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/-cache-key/","title":"CacheKey - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/CacheKey
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/-cache-key/#cachekey","title":"CacheKey","text":"[jvm]\\ constructor(name: String, config: DataSourceConfig, deployment: Deployment)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/deployment/","title":"deployment - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/deployment
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/deployment/#deployment","title":"deployment","text":"[jvm]\\ val deployment: Deployment
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/CacheKey/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-cache-key/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger servers [jvm]lateinit var servers: LoadingCache<StartDatabaseService.CacheKey, Optional<DatabaseServer>>Global cache of running database servers."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/servers/","title":"servers - Misk","text":"//misk-jdbc/misk.database/StartDatabaseService/Companion/servers
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-database-service/-companion/servers/#servers","title":"servers","text":"[jvm]\\ lateinit var servers: LoadingCache<StartDatabaseService.CacheKey, Optional<DatabaseServer>>
Global cache of running database servers.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/","title":"StartVitessService - Misk","text":"//misk-jdbc/misk.database/StartVitessService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/#startvitessservice","title":"StartVitessService","text":"[jvm]\\ class StartVitessService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/#constructors","title":"Constructors","text":"StartVitessService [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-start-vitess-service/","title":"StartVitessService - Misk","text":"//misk-jdbc/misk.database/StartVitessService/StartVitessService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-start-vitess-service/#startvitessservice","title":"StartVitessService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.database/StartVitessService/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-start-vitess-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/","title":"Table - Misk","text":"//misk-jdbc/misk.database/Table
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/#table","title":"Table","text":"[jvm]\\ class Table
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/#constructors","title":"Constructors","text":"Table [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/-table/","title":"Table - Misk","text":"//misk-jdbc/misk.database/Table/Table
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-table/-table/#table","title":"Table","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/","title":"TidbCluster - Misk","text":"//misk-jdbc/misk.database/TidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#tidbcluster","title":"TidbCluster","text":"[jvm]\\ class TidbCluster(val resourceLoader: ResourceLoader, val config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#constructors","title":"Constructors","text":"TidbCluster [jvm]constructor(resourceLoader: ResourceLoader, config: DataSourceConfig)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig configDir [jvm]val configDir: Path httpPort [jvm]val httpPort: Int = 10080 mysqlPort [jvm]val mysqlPort: Int = 4000 resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/#functions","title":"Functions","text":"Name Summary openConnection [jvm]fun openConnection(): ConnectionConnect to vtgate."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/-tidb-cluster/","title":"TidbCluster - Misk","text":"//misk-jdbc/misk.database/TidbCluster/TidbCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/-tidb-cluster/#tidbcluster","title":"TidbCluster","text":"[jvm]\\ constructor(resourceLoader: ResourceLoader, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config-dir/","title":"configDir - Misk","text":"//misk-jdbc/misk.database/TidbCluster/configDir
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config-dir/#configdir","title":"configDir","text":"[jvm]\\ val configDir: Path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/TidbCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/http-port/","title":"httpPort - Misk","text":"//misk-jdbc/misk.database/TidbCluster/httpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/http-port/#httpport","title":"httpPort","text":"[jvm]\\ val httpPort: Int = 10080
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/mysql-port/","title":"mysqlPort - Misk","text":"//misk-jdbc/misk.database/TidbCluster/mysqlPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/mysql-port/#mysqlport","title":"mysqlPort","text":"[jvm]\\ val mysqlPort: Int = 4000
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/open-connection/","title":"openConnection - Misk","text":"//misk-jdbc/misk.database/TidbCluster/openConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/open-connection/#openconnection","title":"openConnection","text":"[jvm]\\ fun openConnection(): Connection
Connect to vtgate.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/resource-loader/","title":"resourceLoader - Misk","text":"//misk-jdbc/misk.database/TidbCluster/resourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-tidb-cluster/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/","title":"VitessCluster - Misk","text":"//misk-jdbc/misk.database/VitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#vitesscluster","title":"VitessCluster","text":"[jvm]\\ class VitessCluster@JvmOverloadsconstructor(val name: String, resourceLoader: ResourceLoader, val config: DataSourceConfig, val moshi: Moshi = defaultKotlinMoshi)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#constructors","title":"Constructors","text":"VitessCluster [jvm]@JvmOverloadsconstructor(name: String, resourceLoader: ResourceLoader, config: DataSourceConfig, moshi: Moshi = defaultKotlinMoshi)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig configDir [jvm]val configDir: Path grpcPort [jvm]val grpcPort: Int httpPort [jvm]val httpPort: Int = 27000 keyspaceAdapter [jvm]val keyspaceAdapter: JsonAdapter<Keyspace> moshi [jvm]val moshi: Moshi mysqlPort [jvm]val mysqlPort: Int name [jvm]val name: String schemaDir [jvm]val schemaDir: Path vtgateMysqlPort [jvm]val vtgateMysqlPort: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/#functions","title":"Functions","text":"Name Summary keyspaces [jvm]fun keyspaces(): Map<String, Keyspace> openMysqlConnection [jvm]fun openMysqlConnection(): ConnectionConnect to the underlying MySQL database, bypassing Vitess entirely. openVtgateConnection [jvm]fun openVtgateConnection(): ConnectionConnect to vtgate."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/-vitess-cluster/","title":"VitessCluster - Misk","text":"//misk-jdbc/misk.database/VitessCluster/VitessCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/-vitess-cluster/#vitesscluster","title":"VitessCluster","text":"[jvm]\\
@JvmOverloads
constructor(name: String, resourceLoader: ResourceLoader, config: DataSourceConfig, moshi: Moshi = defaultKotlinMoshi)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config-dir/","title":"configDir - Misk","text":"//misk-jdbc/misk.database/VitessCluster/configDir
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config-dir/#configdir","title":"configDir","text":"[jvm]\\ val configDir: Path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config/","title":"config - Misk","text":"//misk-jdbc/misk.database/VitessCluster/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/grpc-port/","title":"grpcPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/grpcPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/grpc-port/#grpcport","title":"grpcPort","text":"[jvm]\\ val grpcPort: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/http-port/","title":"httpPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/httpPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/http-port/#httpport","title":"httpPort","text":"[jvm]\\ val httpPort: Int = 27000
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspace-adapter/","title":"keyspaceAdapter - Misk","text":"//misk-jdbc/misk.database/VitessCluster/keyspaceAdapter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspace-adapter/#keyspaceadapter","title":"keyspaceAdapter","text":"[jvm]\\ val keyspaceAdapter: JsonAdapter<Keyspace>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspaces/","title":"keyspaces - Misk","text":"//misk-jdbc/misk.database/VitessCluster/keyspaces
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/keyspaces/#keyspaces","title":"keyspaces","text":"[jvm]\\ fun keyspaces(): Map<String, Keyspace>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/moshi/","title":"moshi - Misk","text":"//misk-jdbc/misk.database/VitessCluster/moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: Moshi
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/mysql-port/","title":"mysqlPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/mysqlPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/mysql-port/#mysqlport","title":"mysqlPort","text":"[jvm]\\ val mysqlPort: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/name/","title":"name - Misk","text":"//misk-jdbc/misk.database/VitessCluster/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-mysql-connection/","title":"openMysqlConnection - Misk","text":"//misk-jdbc/misk.database/VitessCluster/openMysqlConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-mysql-connection/#openmysqlconnection","title":"openMysqlConnection","text":"[jvm]\\ fun openMysqlConnection(): Connection
Connect to the underlying MySQL database, bypassing Vitess entirely.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-vtgate-connection/","title":"openVtgateConnection - Misk","text":"//misk-jdbc/misk.database/VitessCluster/openVtgateConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/open-vtgate-connection/#openvtgateconnection","title":"openVtgateConnection","text":"[jvm]\\ fun openVtgateConnection(): Connection
Connect to vtgate.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/schema-dir/","title":"schemaDir - Misk","text":"//misk-jdbc/misk.database/VitessCluster/schemaDir
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/schema-dir/#schemadir","title":"schemaDir","text":"[jvm]\\ val schemaDir: Path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/vtgate-mysql-port/","title":"vtgateMysqlPort - Misk","text":"//misk-jdbc/misk.database/VitessCluster/vtgateMysqlPort
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.database/-vitess-cluster/vtgate-mysql-port/#vtgatemysqlport","title":"vtgateMysqlPort","text":"[jvm]\\ val vtgateMysqlPort: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/","title":"Package-level declarations - Misk","text":"//misk-jdbc/misk.jdbc
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/#types","title":"Types","text":"Name Summary Check [jvm]enum Check : Enum<Check> CheckDisabler [jvm]object CheckDisabler CheckException [jvm]open class CheckException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : SQLExceptionAn exception that is thrown when a Check fails. Cluster [jvm]interface Cluster<T>Cluster provides a consistent abstraction for interacting with various database-related resources T based on their role in the underlying database topology. DatabasePool [jvm]interface DatabasePoolFigures out what database name to use for a given config. Tests use this to pool many databases for concurrent execution. In development, staging, and production the database never changes. DatabaseReadyService [jvm]interface DatabaseReadyService : ServiceMarker interface for indicating that the database is ready. DataSourceCluster [jvm]class DataSourceCluster(val writer: DataSource, val reader: DataSource) : Cluster<DataSource> DataSourceClusterConfig [jvm]data class DataSourceClusterConfig(val writer: DataSourceConfig, val reader: DataSourceConfig?)Configuration element for a cluster of DataSources DataSourceClustersConfig [jvm]class DataSourceClustersConfig : LinkedHashMap<String, DataSourceClusterConfig> , ConfigTop-level configuration element for all datasource clusters DataSourceConfig [jvm]data class DataSourceConfig@JvmOverloadsconstructor(val type: DataSourceType, val host: String? = null, val port: Int? = null, val database: String? = null, val username: String? = null, val password: String? = null, val fixed_pool_size: Int = 10, val connection_timeout: Duration = Duration.ofSeconds(10), val validation_timeout: Duration = Duration.ofSeconds(3), val connection_idle_timeout: Duration? = null, val connection_max_lifetime: Duration = Duration.ofMinutes(1), val query_timeout: Duration? = Duration.ofMinutes(1), val keepalive_time: Duration = Duration.ofSeconds(0), val migrations_resource: String? = null, val migrations_resources: List<String>? = null, val migrations_resources_exclusion: List<String>? = null, val migrations_resources_regex: String = \"(^ DataSourceConnector [jvm]interface DataSourceConnector DataSourceDecorator [jvm]interface DataSourceDecorator DataSourceService [jvm]@Singletonclass DataSourceService@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null) : AbstractIdleService, DataSourceConnector, Provider<DataSource> Builds a connection pool to a JDBC database. Doesn\u2019t do any schema migration or validation. DataSourceType [jvm]enum DataSourceType : Enum<DataSourceType> Defines a type of datasource JdbcModule [jvm]class JdbcModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true) : KAbstractModuleBinds database connectivity for a qualified data source. This binds the following public types: JDBCSession [jvm]class JDBCSession(val connection: Connection) : Session PingDatabaseService [jvm]@Singletonclass PingDatabaseService@Injectconstructor(config: DataSourceConfig, deployment: Deployment) : AbstractIdleServiceService that waits for the database to become healthy. This is needed if we\u2019re booting up a Vitess cluster as part of the test run. PostCommitHookFailedException [jvm]class PostCommitHookFailedException(cause: Throwable) : ExceptionPostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook RealDatabasePool [jvm]object RealDatabasePool : DatabasePool RealTransacter [jvm]class RealTransacter(dataSourceService: DataSourceService) : Transacter SchemaMigratorService [jvm]class SchemaMigratorService : AbstractIdleService, HealthCheck, DatabaseReadyService Session [jvm]interface Session SpanInjector [jvm]class SpanInjector(val tracer: Tracer?, val config: DataSourceConfig) : QueryTransformer, DataSourceDecoratorOn the fly decorates queries with the span context, so the query call can be traced all the way through Vitess StringBuilderCarrier [jvm]class StringBuilderCarrier : TextMap TableScanException [jvm]class TableScanException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckExceptionException thrown if we execute a query lacking an index. Transacter [jvm]interface Transacter"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/#functions","title":"Functions","text":"Name Summary map [jvm]fun <T> ResultSet.map(function: (ResultSet) -> T): List<T> maybeInt [jvm]fun ResultSet.maybeInt(): Int? maybeLong [jvm]fun ResultSet.maybeLong(): Long? maybeResult [jvm]fun <T> ResultSet.maybeResult(function: (ResultSet) -> T): T? maybeString [jvm]fun ResultSet.maybeString(): String? uniqueInt [jvm]fun ResultSet.uniqueInt(): Int uniqueLong [jvm]fun ResultSet.uniqueLong(): Long uniqueResult [jvm]fun <T> ResultSet.uniqueResult(function: (ResultSet) -> T): T uniqueString [jvm]fun ResultSet.uniqueString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/map/","title":"map - Misk","text":"//misk-jdbc/misk.jdbc/map
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/map/#map","title":"map","text":"[jvm]\\ fun <T> ResultSet.map(function: (ResultSet) -> T): List<T>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-int/","title":"maybeInt - Misk","text":"//misk-jdbc/misk.jdbc/maybeInt
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-int/#maybeint","title":"maybeInt","text":"[jvm]\\ fun ResultSet.maybeInt(): Int?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-long/","title":"maybeLong - Misk","text":"//misk-jdbc/misk.jdbc/maybeLong
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-long/#maybelong","title":"maybeLong","text":"[jvm]\\ fun ResultSet.maybeLong(): Long?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-result/","title":"maybeResult - Misk","text":"//misk-jdbc/misk.jdbc/maybeResult
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-result/#mayberesult","title":"maybeResult","text":"[jvm]\\ fun <T> ResultSet.maybeResult(function: (ResultSet) -> T): T?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-string/","title":"maybeString - Misk","text":"//misk-jdbc/misk.jdbc/maybeString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/maybe-string/#maybestring","title":"maybeString","text":"[jvm]\\ fun ResultSet.maybeString(): String?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-int/","title":"uniqueInt - Misk","text":"//misk-jdbc/misk.jdbc/uniqueInt
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-int/#uniqueint","title":"uniqueInt","text":"[jvm]\\ fun ResultSet.uniqueInt(): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-long/","title":"uniqueLong - Misk","text":"//misk-jdbc/misk.jdbc/uniqueLong
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-long/#uniquelong","title":"uniqueLong","text":"[jvm]\\ fun ResultSet.uniqueLong(): Long
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-result/","title":"uniqueResult - Misk","text":"//misk-jdbc/misk.jdbc/uniqueResult
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-result/#uniqueresult","title":"uniqueResult","text":"[jvm]\\ fun <T> ResultSet.uniqueResult(function: (ResultSet) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-string/","title":"uniqueString - Misk","text":"//misk-jdbc/misk.jdbc/uniqueString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/unique-string/#uniquestring","title":"uniqueString","text":"[jvm]\\ fun ResultSet.uniqueString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/","title":"Check - Misk","text":"//misk-jdbc/misk.jdbc/Check
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#check","title":"Check","text":"[jvm]\\ enum Check : Enum<Check>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#entries","title":"Entries","text":"FULL_SCATTER [jvm]FULL_SCATTER TABLE_SCAN [jvm]TABLE_SCAN COWRITE [jvm]COWRITE"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Check>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): CheckReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Check>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.jdbc/Check/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Check>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.jdbc/Check/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Check
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/values/","title":"values - Misk","text":"//misk-jdbc/misk.jdbc/Check/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Check>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-c-o-w-r-i-t-e/","title":"COWRITE - Misk","text":"//misk-jdbc/misk.jdbc/Check/COWRITE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-c-o-w-r-i-t-e/#cowrite","title":"COWRITE","text":"[jvm]\\ COWRITE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-c-o-w-r-i-t-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-f-u-l-l_-s-c-a-t-t-e-r/","title":"FULL_SCATTER - Misk","text":"//misk-jdbc/misk.jdbc/Check/FULL_SCATTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-f-u-l-l_-s-c-a-t-t-e-r/#full_scatter","title":"FULL_SCATTER","text":"[jvm]\\ FULL_SCATTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-f-u-l-l_-s-c-a-t-t-e-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-t-a-b-l-e_-s-c-a-n/","title":"TABLE_SCAN - Misk","text":"//misk-jdbc/misk.jdbc/Check/TABLE_SCAN
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-t-a-b-l-e_-s-c-a-n/#table_scan","title":"TABLE_SCAN","text":"[jvm]\\ TABLE_SCAN
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check/-t-a-b-l-e_-s-c-a-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/","title":"CheckDisabler - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/#checkdisabler","title":"CheckDisabler","text":"[jvm]\\ object CheckDisabler
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/#properties","title":"Properties","text":"Name Summary disabledChecks [jvm]val disabledChecks: ThreadLocal<Collection<Check>>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/#functions","title":"Functions","text":"Name Summary disableChecks [jvm]fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T isCheckEnabled [jvm]fun isCheckEnabled(check: Check): Boolean withoutChecks [jvm]fun <T> withoutChecks(vararg checks: Check, body: () -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disable-checks/","title":"disableChecks - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/disableChecks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disable-checks/#disablechecks","title":"disableChecks","text":"[jvm]\\ fun <T> disableChecks(checks: Collection<Check>, body: () -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disabled-checks/","title":"disabledChecks - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/disabledChecks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/disabled-checks/#disabledchecks","title":"disabledChecks","text":"[jvm]\\ val disabledChecks: ThreadLocal<Collection<Check>>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/is-check-enabled/","title":"isCheckEnabled - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/isCheckEnabled
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/is-check-enabled/#ischeckenabled","title":"isCheckEnabled","text":"[jvm]\\ fun isCheckEnabled(check: Check): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/without-checks/","title":"withoutChecks - Misk","text":"//misk-jdbc/misk.jdbc/CheckDisabler/withoutChecks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-disabler/without-checks/#withoutchecks","title":"withoutChecks","text":"[jvm]\\ fun <T> withoutChecks(vararg checks: Check, body: () -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/","title":"CheckException - Misk","text":"//misk-jdbc/misk.jdbc/CheckException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#checkexception","title":"CheckException","text":"open class CheckException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : SQLException
An exception that is thrown when a Check fails.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#inheritors","title":"Inheritors","text":"TableScanException CowriteException FullScatterException"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#constructors","title":"Constructors","text":"CheckException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/-check-exception/","title":"CheckException - Misk","text":"//misk-jdbc/misk.jdbc/CheckException/CheckException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-check-exception/-check-exception/#checkexception","title":"CheckException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/","title":"Cluster - Misk","text":"//misk-jdbc/misk.jdbc/Cluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/#cluster","title":"Cluster","text":"interface Cluster<T>
Cluster provides a consistent abstraction for interacting with various database-related resources T based on their role in the underlying database topology.
Database clusters are often composed of a Read/Write master instance and a set of Read-Only replica instances.
Misk defers management of these replicas to the underlying persistence layer and requires a single addressable endpoint.
Examples include a Read-Only DataSource or a Read/Write SessionFactory in Hibernate.
N.B. If a Read-Only resource is not provided Misk will default to the Read/Write resource.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/#inheritors","title":"Inheritors","text":"DataSourceCluster"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/#properties","title":"Properties","text":"Name Summary reader [jvm]abstract val reader: T writer [jvm]abstract val writer: T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/reader/","title":"reader - Misk","text":"//misk-jdbc/misk.jdbc/Cluster/reader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/reader/#reader","title":"reader","text":"[jvm]\\ abstract val reader: T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/writer/","title":"writer - Misk","text":"//misk-jdbc/misk.jdbc/Cluster/writer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-cluster/writer/#writer","title":"writer","text":"[jvm]\\ abstract val writer: T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/","title":"DataSourceCluster - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/#datasourcecluster","title":"DataSourceCluster","text":"[jvm]\\ class DataSourceCluster(val writer: DataSource, val reader: DataSource) : Cluster<DataSource>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/#constructors","title":"Constructors","text":"DataSourceCluster [jvm]constructor(writer: DataSource, reader: DataSource)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/#properties","title":"Properties","text":"Name Summary reader [jvm]open override val reader: DataSource writer [jvm]open override val writer: DataSource"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/-data-source-cluster/","title":"DataSourceCluster - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster/DataSourceCluster
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/-data-source-cluster/#datasourcecluster","title":"DataSourceCluster","text":"[jvm]\\ constructor(writer: DataSource, reader: DataSource)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/reader/","title":"reader - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster/reader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/reader/#reader","title":"reader","text":"[jvm]\\ open override val reader: DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/writer/","title":"writer - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceCluster/writer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster/writer/#writer","title":"writer","text":"[jvm]\\ open override val writer: DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/","title":"DataSourceClusterConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/#datasourceclusterconfig","title":"DataSourceClusterConfig","text":"[jvm]\\ data class DataSourceClusterConfig(val writer: DataSourceConfig, val reader: DataSourceConfig?)
Configuration element for a cluster of DataSources
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/#constructors","title":"Constructors","text":"DataSourceClusterConfig [jvm]constructor(writer: DataSourceConfig, reader: DataSourceConfig?)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/#properties","title":"Properties","text":"Name Summary reader [jvm]val reader: DataSourceConfig? writer [jvm]val writer: DataSourceConfig"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/-data-source-cluster-config/","title":"DataSourceClusterConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig/DataSourceClusterConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/-data-source-cluster-config/#datasourceclusterconfig","title":"DataSourceClusterConfig","text":"[jvm]\\ constructor(writer: DataSourceConfig, reader: DataSourceConfig?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/reader/","title":"reader - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig/reader
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/reader/#reader","title":"reader","text":"[jvm]\\ val reader: DataSourceConfig?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/writer/","title":"writer - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClusterConfig/writer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-cluster-config/writer/#writer","title":"writer","text":"[jvm]\\ val writer: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/","title":"DataSourceClustersConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClustersConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#datasourceclustersconfig","title":"DataSourceClustersConfig","text":"[jvm]\\ class DataSourceClustersConfig : LinkedHashMap<String, DataSourceClusterConfig> , Config
Top-level configuration element for all datasource clusters
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#constructors","title":"Constructors","text":"DataSourceClustersConfig [jvm]constructor()constructor(m: Map<String, DataSourceClusterConfig>)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#properties","title":"Properties","text":"Name Summary entries [jvm]open override val entries: MutableSet<MutableMap.MutableEntry<String, DataSourceClusterConfig>> keys [jvm]open override val keys: MutableSet<String> size [jvm]open override val size: Int values [jvm]open override val values: MutableCollection<DataSourceClusterConfig>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() clone [jvm]open override fun clone(): Any compute [jvm]open override fun compute(p0: String, p1: BiFunction<in String, in DataSourceClusterConfig?, out DataSourceClusterConfig?>): DataSourceClusterConfig? computeIfAbsent [jvm]open override fun computeIfAbsent(p0: String, p1: Function<in String, out DataSourceClusterConfig>): DataSourceClusterConfig computeIfPresent [jvm]open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in DataSourceClusterConfig, out DataSourceClusterConfig?>): DataSourceClusterConfig? containsKey [jvm]open override fun containsKey(key: String): Boolean containsValue [jvm]open override fun containsValue(value: DataSourceClusterConfig): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean forEach [jvm]open override fun forEach(p0: BiConsumer<in String, in DataSourceClusterConfig>) get [jvm]open operator override fun get(key: String): DataSourceClusterConfig? getOrDefault [jvm]open override fun getOrDefault(key: String, defaultValue: DataSourceClusterConfig): DataSourceClusterConfig hashCode [jvm]open override fun hashCode(): Int isEmpty [jvm]open override fun isEmpty(): Boolean merge [jvm]open override fun merge(p0: String, p1: DataSourceClusterConfig, p2: BiFunction<in DataSourceClusterConfig, in DataSourceClusterConfig, out DataSourceClusterConfig?>): DataSourceClusterConfig? put [jvm]open override fun put(key: String, value: DataSourceClusterConfig): DataSourceClusterConfig? putAll [jvm]open override fun putAll(from: Map<out String, DataSourceClusterConfig>) putIfAbsent [jvm]open override fun putIfAbsent(p0: String, p1: DataSourceClusterConfig): DataSourceClusterConfig? remove [jvm]open override fun remove(key: String): DataSourceClusterConfig?open override fun remove(key: String, value: DataSourceClusterConfig): Boolean replace [jvm]open override fun replace(p0: String, p1: DataSourceClusterConfig): DataSourceClusterConfig?open override fun replace(p0: String, p1: DataSourceClusterConfig, p2: DataSourceClusterConfig): Boolean replaceAll [jvm]open override fun replaceAll(p0: BiFunction<in String, in DataSourceClusterConfig, out DataSourceClusterConfig>) toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/-data-source-clusters-config/","title":"DataSourceClustersConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceClustersConfig/DataSourceClustersConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-clusters-config/-data-source-clusters-config/#datasourceclustersconfig","title":"DataSourceClustersConfig","text":"[jvm]\\ constructor()
constructor(m: Map<String, DataSourceClusterConfig>)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/","title":"DataSourceConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#datasourceconfig","title":"DataSourceConfig","text":"[jvm]\\ data class DataSourceConfig@JvmOverloadsconstructor(val type: DataSourceType, val host: String? = null, val port: Int? = null, val database: String? = null, val username: String? = null, val password: String? = null, val fixed_pool_size: Int = 10, val connection_timeout: Duration = Duration.ofSeconds(10), val validation_timeout: Duration = Duration.ofSeconds(3), val connection_idle_timeout: Duration? = null, val connection_max_lifetime: Duration = Duration.ofMinutes(1), val query_timeout: Duration? = Duration.ofMinutes(1), val keepalive_time: Duration = Duration.ofSeconds(0), val migrations_resource: String? = null, val migrations_resources: List<String>? = null, val migrations_resources_exclusion: List<String>? = null, val migrations_resources_regex: String = \"(^|.*/)v(\", val vitess_schema_resource_root: String? = null, val trust_certificate_key_store_url: String? = null, val trust_certificate_key_store_password: String? = null, val client_certificate_key_store_url: String? = null, val client_certificate_key_store_password: String? = null, val trust_certificate_key_store_path: String? = null, val client_certificate_key_store_path: String? = null, val verify_server_identity: Boolean = false, val enabledTlsProtocols: List<String> = listOf(\"TLSv1.2\", \"TLSv1.3\"), val show_sql: String? = \"false\", val generate_hibernate_stats: String? = \"false\", val jdbc_statement_batch_size: Int? = null, val use_fixed_pool_size: Boolean = false, val allow_public_key_retrieval: Boolean = false, val jdbc_url_query_parameters: Map<String, Any> = mapOf(), val mysql_enforce_writable_connections: Boolean = false)
Configuration element for an individual datasource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#constructors","title":"Constructors","text":"DataSourceConfig [jvm]@JvmOverloadsconstructor(type: DataSourceType, host: String? = null, port: Int? = null, database: String? = null, username: String? = null, password: String? = null, fixed_pool_size: Int = 10, connection_timeout: Duration = Duration.ofSeconds(10), validation_timeout: Duration = Duration.ofSeconds(3), connection_idle_timeout: Duration? = null, connection_max_lifetime: Duration = Duration.ofMinutes(1), query_timeout: Duration? = Duration.ofMinutes(1), keepalive_time: Duration = Duration.ofSeconds(0), migrations_resource: String? = null, migrations_resources: List<String>? = null, migrations_resources_exclusion: List<String>? = null, migrations_resources_regex: String = \"(^"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#properties","title":"Properties","text":"Name Summary allow_public_key_retrieval [jvm]val allow_public_key_retrieval: Boolean = false client_certificate_key_store_password [jvm]val client_certificate_key_store_password: String? = null client_certificate_key_store_path [jvm]val client_certificate_key_store_path: String? = null client_certificate_key_store_url [jvm]val client_certificate_key_store_url: String? = null connection_idle_timeout [jvm]val connection_idle_timeout: Duration? = null connection_max_lifetime [jvm]val connection_max_lifetime: Duration connection_timeout [jvm]val connection_timeout: Duration database [jvm]val database: String? = null enabledTlsProtocols [jvm]val enabledTlsProtocols: List<String> fixed_pool_size [jvm]val fixed_pool_size: Int = 10 generate_hibernate_stats [jvm]val generate_hibernate_stats: String? host [jvm]val host: String? = null jdbc_statement_batch_size [jvm]val jdbc_statement_batch_size: Int? = null jdbc_url_query_parameters [jvm]val jdbc_url_query_parameters: Map<String, Any> keepalive_time [jvm]val keepalive_time: Duration migrations_resource [jvm]val migrations_resource: String? = null migrations_resources [jvm]val migrations_resources: List<String>? = null migrations_resources_exclusion [jvm]val migrations_resources_exclusion: List<String>? = nullList of filenames to exclude from being processed in database schema migrations migrations_resources_regex [jvm]val migrations_resources_regex: StringRegular expression migration files names should match. Any migration filename that doesn\u2019t match the given regular expression will cause an exception, unless it was explicitly mentioned in migrations_resources_exclusion. mysql_enforce_writable_connections [jvm]val mysql_enforce_writable_connections: Boolean = false password [jvm]val password: String? = null port [jvm]val port: Int? = null query_timeout [jvm]val query_timeout: Duration? show_sql [jvm]val show_sql: String? trust_certificate_key_store_password [jvm]val trust_certificate_key_store_password: String? = null trust_certificate_key_store_path [jvm]val trust_certificate_key_store_path: String? = null trust_certificate_key_store_url [jvm]val trust_certificate_key_store_url: String? = null type [jvm]val type: DataSourceType use_fixed_pool_size [jvm]val use_fixed_pool_size: Boolean = false username [jvm]val username: String? = null validation_timeout [jvm]val validation_timeout: Duration verify_server_identity [jvm]val verify_server_identity: Boolean = false vitess_schema_resource_root [jvm]val vitess_schema_resource_root: String? = null"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/#functions","title":"Functions","text":"Name Summary asReplica [jvm]fun asReplica(): DataSourceConfig buildJdbcUrl [jvm]fun buildJdbcUrl(deployment: Deployment): String canRecoverOnReplica [jvm]fun canRecoverOnReplica(): Boolean withDefaults [jvm]fun withDefaults(): DataSourceConfig"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/-data-source-config/","title":"DataSourceConfig - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/-data-source-config/#datasourceconfig","title":"DataSourceConfig","text":"[jvm]\\
@JvmOverloads
constructor(type: DataSourceType, host: String? = null, port: Int? = null, database: String? = null, username: String? = null, password: String? = null, fixed_pool_size: Int = 10, connection_timeout: Duration = Duration.ofSeconds(10), validation_timeout: Duration = Duration.ofSeconds(3), connection_idle_timeout: Duration? = null, connection_max_lifetime: Duration = Duration.ofMinutes(1), query_timeout: Duration? = Duration.ofMinutes(1), keepalive_time: Duration = Duration.ofSeconds(0), migrations_resource: String? = null, migrations_resources: List<String>? = null, migrations_resources_exclusion: List<String>? = null, migrations_resources_regex: String = \"(^|.*/)v(\", vitess_schema_resource_root: String? = null, trust_certificate_key_store_url: String? = null, trust_certificate_key_store_password: String? = null, client_certificate_key_store_url: String? = null, client_certificate_key_store_password: String? = null, trust_certificate_key_store_path: String? = null, client_certificate_key_store_path: String? = null, verify_server_identity: Boolean = false, enabledTlsProtocols: List<String> = listOf(\"TLSv1.2\", \"TLSv1.3\"), show_sql: String? = \"false\", generate_hibernate_stats: String? = \"false\", jdbc_statement_batch_size: Int? = null, use_fixed_pool_size: Boolean = false, allow_public_key_retrieval: Boolean = false, jdbc_url_query_parameters: Map<String, Any> = mapOf(), mysql_enforce_writable_connections: Boolean = false)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/allow_public_key_retrieval/","title":"allow_public_key_retrieval - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/allow_public_key_retrieval
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/allow_public_key_retrieval/#allow_public_key_retrieval","title":"allow_public_key_retrieval","text":"[jvm]\\ val allow_public_key_retrieval: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/as-replica/","title":"asReplica - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/asReplica
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/as-replica/#asreplica","title":"asReplica","text":"[jvm]\\ fun asReplica(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/build-jdbc-url/","title":"buildJdbcUrl - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/buildJdbcUrl
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/build-jdbc-url/#buildjdbcurl","title":"buildJdbcUrl","text":"[jvm]\\ fun buildJdbcUrl(deployment: Deployment): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/can-recover-on-replica/","title":"canRecoverOnReplica - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/canRecoverOnReplica
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/can-recover-on-replica/#canrecoveronreplica","title":"canRecoverOnReplica","text":"[jvm]\\ fun canRecoverOnReplica(): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_password/","title":"client_certificate_key_store_password - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/client_certificate_key_store_password
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_password/#client_certificate_key_store_password","title":"client_certificate_key_store_password","text":"[jvm]\\ val client_certificate_key_store_password: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_path/","title":"client_certificate_key_store_path - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/client_certificate_key_store_path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_path/#client_certificate_key_store_path","title":"client_certificate_key_store_path","text":"[jvm]\\ val client_certificate_key_store_path: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_url/","title":"client_certificate_key_store_url - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/client_certificate_key_store_url
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/client_certificate_key_store_url/#client_certificate_key_store_url","title":"client_certificate_key_store_url","text":"[jvm]\\ val client_certificate_key_store_url: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_idle_timeout/","title":"connection_idle_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/connection_idle_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_idle_timeout/#connection_idle_timeout","title":"connection_idle_timeout","text":"[jvm]\\ val connection_idle_timeout: Duration? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_max_lifetime/","title":"connection_max_lifetime - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/connection_max_lifetime
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_max_lifetime/#connection_max_lifetime","title":"connection_max_lifetime","text":"[jvm]\\ val connection_max_lifetime: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_timeout/","title":"connection_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/connection_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/connection_timeout/#connection_timeout","title":"connection_timeout","text":"[jvm]\\ val connection_timeout: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/database/","title":"database - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/database
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/database/#database","title":"database","text":"[jvm]\\ val database: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/enabled-tls-protocols/","title":"enabledTlsProtocols - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/enabledTlsProtocols
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/enabled-tls-protocols/#enabledtlsprotocols","title":"enabledTlsProtocols","text":"[jvm]\\ val enabledTlsProtocols: List<String>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/fixed_pool_size/","title":"fixed_pool_size - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/fixed_pool_size
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/fixed_pool_size/#fixed_pool_size","title":"fixed_pool_size","text":"[jvm]\\ val fixed_pool_size: Int = 10
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/generate_hibernate_stats/","title":"generate_hibernate_stats - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/generate_hibernate_stats
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/generate_hibernate_stats/#generate_hibernate_stats","title":"generate_hibernate_stats","text":"[jvm]\\ val generate_hibernate_stats: String?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/host/","title":"host - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/host
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/host/#host","title":"host","text":"[jvm]\\ val host: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_statement_batch_size/","title":"jdbc_statement_batch_size - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/jdbc_statement_batch_size
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_statement_batch_size/#jdbc_statement_batch_size","title":"jdbc_statement_batch_size","text":"[jvm]\\ val jdbc_statement_batch_size: Int? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_url_query_parameters/","title":"jdbc_url_query_parameters - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/jdbc_url_query_parameters
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/jdbc_url_query_parameters/#jdbc_url_query_parameters","title":"jdbc_url_query_parameters","text":"[jvm]\\ val jdbc_url_query_parameters: Map<String, Any>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/keepalive_time/","title":"keepalive_time - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/keepalive_time
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/keepalive_time/#keepalive_time","title":"keepalive_time","text":"[jvm]\\ val keepalive_time: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resource/","title":"migrations_resource - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resource/#migrations_resource","title":"migrations_resource","text":"[jvm]\\ val migrations_resource: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources/","title":"migrations_resources - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resources
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources/#migrations_resources","title":"migrations_resources","text":"[jvm]\\ val migrations_resources: List<String>? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_exclusion/","title":"migrations_resources_exclusion - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resources_exclusion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_exclusion/#migrations_resources_exclusion","title":"migrations_resources_exclusion","text":"[jvm]\\ val migrations_resources_exclusion: List<String>? = null
List of filenames to exclude from being processed in database schema migrations
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_regex/","title":"migrations_resources_regex - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/migrations_resources_regex
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/migrations_resources_regex/#migrations_resources_regex","title":"migrations_resources_regex","text":"[jvm]\\ val migrations_resources_regex: String
Regular expression migration files names should match. Any migration filename that doesn\u2019t match the given regular expression will cause an exception, unless it was explicitly mentioned in migrations_resources_exclusion.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/mysql_enforce_writable_connections/","title":"mysql_enforce_writable_connections - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/mysql_enforce_writable_connections
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/mysql_enforce_writable_connections/#mysql_enforce_writable_connections","title":"mysql_enforce_writable_connections","text":"[jvm]\\ val mysql_enforce_writable_connections: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/password/","title":"password - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/password
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/password/#password","title":"password","text":"[jvm]\\ val password: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/port/","title":"port - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/port
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/port/#port","title":"port","text":"[jvm]\\ val port: Int? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/query_timeout/","title":"query_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/query_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/query_timeout/#query_timeout","title":"query_timeout","text":"[jvm]\\ val query_timeout: Duration?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/show_sql/","title":"show_sql - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/show_sql
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/show_sql/#show_sql","title":"show_sql","text":"[jvm]\\ val show_sql: String?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_password/","title":"trust_certificate_key_store_password - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/trust_certificate_key_store_password
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_password/#trust_certificate_key_store_password","title":"trust_certificate_key_store_password","text":"[jvm]\\ val trust_certificate_key_store_password: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_path/","title":"trust_certificate_key_store_path - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/trust_certificate_key_store_path
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_path/#trust_certificate_key_store_path","title":"trust_certificate_key_store_path","text":"[jvm]\\ val trust_certificate_key_store_path: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_url/","title":"trust_certificate_key_store_url - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/trust_certificate_key_store_url
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/trust_certificate_key_store_url/#trust_certificate_key_store_url","title":"trust_certificate_key_store_url","text":"[jvm]\\ val trust_certificate_key_store_url: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/type/","title":"type - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/type
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/type/#type","title":"type","text":"[jvm]\\ val type: DataSourceType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/use_fixed_pool_size/","title":"use_fixed_pool_size - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/use_fixed_pool_size
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/use_fixed_pool_size/#use_fixed_pool_size","title":"use_fixed_pool_size","text":"[jvm]\\ val use_fixed_pool_size: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/username/","title":"username - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/username
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/username/#username","title":"username","text":"[jvm]\\ val username: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/validation_timeout/","title":"validation_timeout - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/validation_timeout
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/validation_timeout/#validation_timeout","title":"validation_timeout","text":"[jvm]\\ val validation_timeout: Duration
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/verify_server_identity/","title":"verify_server_identity - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/verify_server_identity
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/verify_server_identity/#verify_server_identity","title":"verify_server_identity","text":"[jvm]\\ val verify_server_identity: Boolean = false
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/vitess_schema_resource_root/","title":"vitess_schema_resource_root - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/vitess_schema_resource_root
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/vitess_schema_resource_root/#vitess_schema_resource_root","title":"vitess_schema_resource_root","text":"[jvm]\\ val vitess_schema_resource_root: String? = null
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/with-defaults/","title":"withDefaults - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConfig/withDefaults
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-config/with-defaults/#withdefaults","title":"withDefaults","text":"[jvm]\\ fun withDefaults(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/","title":"DataSourceConnector - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConnector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/#datasourceconnector","title":"DataSourceConnector","text":"interface DataSourceConnector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/#inheritors","title":"Inheritors","text":"DataSourceService"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/#functions","title":"Functions","text":"Name Summary config [jvm]abstract fun config(): DataSourceConfig"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceConnector/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-connector/config/#config","title":"config","text":"[jvm]\\ abstract fun config(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/","title":"DataSourceDecorator - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceDecorator
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/#datasourcedecorator","title":"DataSourceDecorator","text":"interface DataSourceDecorator
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/#inheritors","title":"Inheritors","text":"SpanInjector"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/#functions","title":"Functions","text":"Name Summary decorate [jvm]abstract fun decorate(dataSource: DataSource): DataSource"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/decorate/","title":"decorate - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceDecorator/decorate
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-decorator/decorate/#decorate","title":"decorate","text":"[jvm]\\ abstract fun decorate(dataSource: DataSource): DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/","title":"DataSourceService - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#datasourceservice","title":"DataSourceService","text":"@Singleton
class DataSourceService@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null) : AbstractIdleService, DataSourceConnector, Provider<DataSource>
Builds a connection pool to a JDBC database. Doesn\u2019t do any schema migration or validation.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#parameters","title":"Parameters","text":"jvm
baseConfig the configuration to connect to. The actual database name used may vary as the databasePool can pick an alternate database name for testing."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#constructors","title":"Constructors","text":"DataSourceService [jvm]@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#properties","title":"Properties","text":"Name Summary dataSource [jvm]val dataSource: DataSource"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) config [jvm]open override fun config(): DataSourceConfig failureCause [jvm]override fun failureCause(): Throwable get [jvm]open override fun get(): DataSource isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-data-source-service/","title":"DataSourceService - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/DataSourceService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-data-source-service/#datasourceservice","title":"DataSourceService","text":"[jvm]\\
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, baseConfig: DataSourceConfig, deployment: Deployment, dataSourceDecorators: Set<DataSourceDecorator>, databasePool: DatabasePool, collectorRegistry: CollectorRegistry? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-data-source-service/#parameters","title":"Parameters","text":"jvm
baseConfig the configuration to connect to. The actual database name used may vary as the databasePool can pick an alternate database name for testing."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/config/#config","title":"config","text":"[jvm]\\ open override fun config(): DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/data-source/","title":"dataSource - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/dataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/data-source/#datasource","title":"dataSource","text":"[jvm]\\ val dataSource: DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/get/","title":"get - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/get
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/get/#get","title":"get","text":"[jvm]\\ open override fun get(): DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/logger/","title":"logger - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceService/Companion/logger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-service/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/","title":"DataSourceType - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#datasourcetype","title":"DataSourceType","text":"[jvm]\\ enum DataSourceType : Enum<DataSourceType>
Defines a type of datasource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#entries","title":"Entries","text":"MYSQL [jvm]MYSQL HSQLDB [jvm]HSQLDB VITESS_MYSQL [jvm]VITESS_MYSQL COCKROACHDB [jvm]COCKROACHDB POSTGRESQL [jvm]POSTGRESQL TIDB [jvm]TIDB"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String entries [jvm]val entries: EnumEntries<DataSourceType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): DataSourceTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<DataSourceType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/driver-class-name/","title":"driverClassName - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/driverClassName
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/driver-class-name/#driverclassname","title":"driverClassName","text":"[jvm]\\ val driverClassName: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<DataSourceType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/hibernate-dialect/","title":"hibernateDialect - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/hibernateDialect
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/hibernate-dialect/#hibernatedialect","title":"hibernateDialect","text":"[jvm]\\ val hibernateDialect: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/is-vitess/","title":"isVitess - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/isVitess
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/is-vitess/#isvitess","title":"isVitess","text":"[jvm]\\ val isVitess: Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): DataSourceType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/values/","title":"values - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<DataSourceType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-c-o-c-k-r-o-a-c-h-d-b/","title":"COCKROACHDB - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/COCKROACHDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-c-o-c-k-r-o-a-c-h-d-b/#cockroachdb","title":"COCKROACHDB","text":"[jvm]\\ COCKROACHDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-c-o-c-k-r-o-a-c-h-d-b/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-h-s-q-l-d-b/","title":"HSQLDB - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/HSQLDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-h-s-q-l-d-b/#hsqldb","title":"HSQLDB","text":"[jvm]\\ HSQLDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-h-s-q-l-d-b/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-m-y-s-q-l/","title":"MYSQL - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-m-y-s-q-l/#mysql","title":"MYSQL","text":"[jvm]\\ MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-m-y-s-q-l/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-p-o-s-t-g-r-e-s-q-l/","title":"POSTGRESQL - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/POSTGRESQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-p-o-s-t-g-r-e-s-q-l/#postgresql","title":"POSTGRESQL","text":"[jvm]\\ POSTGRESQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-p-o-s-t-g-r-e-s-q-l/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-t-i-d-b/","title":"TIDB - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/TIDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-t-i-d-b/#tidb","title":"TIDB","text":"[jvm]\\ TIDB
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-t-i-d-b/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-v-i-t-e-s-s_-m-y-s-q-l/","title":"VITESS_MYSQL - Misk","text":"//misk-jdbc/misk.jdbc/DataSourceType/VITESS_MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-v-i-t-e-s-s_-m-y-s-q-l/#vitess_mysql","title":"VITESS_MYSQL","text":"[jvm]\\ VITESS_MYSQL
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-data-source-type/-v-i-t-e-s-s_-m-y-s-q-l/#properties","title":"Properties","text":"Name Summary driverClassName [jvm]val driverClassName: String hibernateDialect [jvm]val hibernateDialect: String isVitess [jvm]val isVitess: Boolean name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/","title":"DatabasePool - Misk","text":"//misk-jdbc/misk.jdbc/DatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/#databasepool","title":"DatabasePool","text":"interface DatabasePool
Figures out what database name to use for a given config. Tests use this to pool many databases for concurrent execution. In development, staging, and production the database never changes.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/#inheritors","title":"Inheritors","text":"RealDatabasePool"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/#functions","title":"Functions","text":"Name Summary releaseDatabase [jvm]abstract fun releaseDatabase(config: DataSourceConfig)Releases a config created by takeDatabase. takeDatabase [jvm]abstract fun takeDatabase(config: DataSourceConfig): DataSourceConfigFinds a database to satisfy config and returns a new config that targets it."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/release-database/","title":"releaseDatabase - Misk","text":"//misk-jdbc/misk.jdbc/DatabasePool/releaseDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/release-database/#releasedatabase","title":"releaseDatabase","text":"[jvm]\\ abstract fun releaseDatabase(config: DataSourceConfig)
Releases a config created by takeDatabase.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/take-database/","title":"takeDatabase - Misk","text":"//misk-jdbc/misk.jdbc/DatabasePool/takeDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-pool/take-database/#takedatabase","title":"takeDatabase","text":"[jvm]\\ abstract fun takeDatabase(config: DataSourceConfig): DataSourceConfig
Finds a database to satisfy config and returns a new config that targets it.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-ready-service/","title":"DatabaseReadyService - Misk","text":"//misk-jdbc/misk.jdbc/DatabaseReadyService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-database-ready-service/#databasereadyservice","title":"DatabaseReadyService","text":"interface DatabaseReadyService : Service
Marker interface for indicating that the database is ready.
Services that require a database connection should depend on this interface when they are installed in a module.
e.g.
install(ServiceModule<MoviesService>()\n .dependsOn<DatabaseReadyService>(Movies::class))\n//misk-jdbc/misk.jdbc/JDBCSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#jdbcsession","title":"JDBCSession","text":"[jvm]\\ class JDBCSession(val connection: Connection) : Session
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#constructors","title":"Constructors","text":"JDBCSession [jvm]constructor(connection: Connection)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#types","title":"Types","text":"Name Summary HookType [jvm]enum HookType : Enum<JDBCSession.HookType>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#properties","title":"Properties","text":"Name Summary connection [jvm]val connection: Connection"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/#functions","title":"Functions","text":"Name Summary add [jvm]fun ConcurrentMap<JDBCSession.HookType, List<() -> Unit>>.add(hookType: JDBCSession.HookType, work: () -> Unit) component1 [jvm]operator fun component1(): ConnectionAllows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (connection) -> \u2026 } executePostCommitHooks [jvm]fun executePostCommitHooks() executePreCommitHooks [jvm]fun executePreCommitHooks() executeSessionCloseHooks [jvm]fun executeSessionCloseHooks() onPostCommit [jvm]open override fun onPostCommit(work: () -> Unit)Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed onPreCommit [jvm]open override fun onPreCommit(work: () -> Unit)Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back. onSessionClose [jvm]open override fun onSessionClose(work: () -> Unit)Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back. useConnection [jvm]open override fun <T> useConnection(work: (Connection) -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-j-d-b-c-session/","title":"JDBCSession - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/JDBCSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-j-d-b-c-session/#jdbcsession","title":"JDBCSession","text":"[jvm]\\ constructor(connection: Connection)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/add/","title":"add - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/add
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/add/#add","title":"add","text":"[jvm]\\ fun ConcurrentMap<JDBCSession.HookType, List<() -> Unit>>.add(hookType: JDBCSession.HookType, work: () -> Unit)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/component1/","title":"component1 - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/component1
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/component1/#component1","title":"component1","text":"[jvm]\\ operator fun component1(): Connection
Allows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (connection) -> \u2026 }
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/connection/","title":"connection - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/connection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/connection/#connection","title":"connection","text":"[jvm]\\ val connection: Connection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-post-commit-hooks/","title":"executePostCommitHooks - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/executePostCommitHooks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-post-commit-hooks/#executepostcommithooks","title":"executePostCommitHooks","text":"[jvm]\\ fun executePostCommitHooks()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-pre-commit-hooks/","title":"executePreCommitHooks - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/executePreCommitHooks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-pre-commit-hooks/#executeprecommithooks","title":"executePreCommitHooks","text":"[jvm]\\ fun executePreCommitHooks()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-session-close-hooks/","title":"executeSessionCloseHooks - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/executeSessionCloseHooks
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/execute-session-close-hooks/#executesessionclosehooks","title":"executeSessionCloseHooks","text":"[jvm]\\ fun executeSessionCloseHooks()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-post-commit/","title":"onPostCommit - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/onPostCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-post-commit/#onpostcommit","title":"onPostCommit","text":"[jvm]\\ open override fun onPostCommit(work: () -> Unit)
Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-pre-commit/","title":"onPreCommit - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/onPreCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-pre-commit/#onprecommit","title":"onPreCommit","text":"[jvm]\\ open override fun onPreCommit(work: () -> Unit)
Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-session-close/","title":"onSessionClose - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/onSessionClose
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/on-session-close/#onsessionclose","title":"onSessionClose","text":"[jvm]\\ open override fun onSessionClose(work: () -> Unit)
Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back.
A new transaction can be initiated as part of this hook.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/use-connection/","title":"useConnection - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/useConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/use-connection/#useconnection","title":"useConnection","text":"[jvm]\\ open override fun <T> useConnection(work: (Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/","title":"HookType - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#hooktype","title":"HookType","text":"[jvm]\\ enum HookType : Enum<JDBCSession.HookType>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#entries","title":"Entries","text":"PRE [jvm]PRE POST [jvm]POST SESSION_CLOSE [jvm]SESSION_CLOSE"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<JDBCSession.HookType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): JDBCSession.HookTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<JDBCSession.HookType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<JDBCSession.HookType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): JDBCSession.HookType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/values/","title":"values - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<JDBCSession.HookType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-o-s-t/","title":"POST - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/POST
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-o-s-t/#post","title":"POST","text":"[jvm]\\ POST
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-o-s-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-r-e/","title":"PRE - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/PRE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-r-e/#pre","title":"PRE","text":"[jvm]\\ PRE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-p-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/","title":"SESSION_CLOSE - Misk","text":"//misk-jdbc/misk.jdbc/JDBCSession/HookType/SESSION_CLOSE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#session_close","title":"SESSION_CLOSE","text":"[jvm]\\ SESSION_CLOSE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-j-d-b-c-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/","title":"JdbcModule - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#jdbcmodule","title":"JdbcModule","text":"[jvm]\\ class JdbcModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, val databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true) : KAbstractModule
Binds database connectivity for a qualified data source. This binds the following public types:
DataSource.getConnection can be used to get JDBC connections to your database.
This also registers services to connect to the database (DataSourceService) and to verify that the schema is up-to-date (SchemaMigratorService).
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#constructors","title":"Constructors","text":"JdbcModule [jvm]constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig databasePool [jvm]val databasePool: DatabasePool readerConfig [jvm]val readerConfig: DataSourceConfig?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/-jdbc-module/","title":"JdbcModule - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/JdbcModule
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/-jdbc-module/#jdbcmodule","title":"JdbcModule","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, databasePool: DatabasePool = RealDatabasePool)
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, config: DataSourceConfig, readerQualifier: KClass<out Annotation>?, readerConfig: DataSourceConfig?, databasePool: DatabasePool = RealDatabasePool, installHealthCheck: Boolean = true)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/database-pool/","title":"databasePool - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/databasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/database-pool/#databasepool","title":"databasePool","text":"[jvm]\\ val databasePool: DatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/reader-config/","title":"readerConfig - Misk","text":"//misk-jdbc/misk.jdbc/JdbcModule/readerConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-jdbc-module/reader-config/#readerconfig","title":"readerConfig","text":"[jvm]\\ val readerConfig: DataSourceConfig?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/","title":"PingDatabaseService - Misk","text":"//misk-jdbc/misk.jdbc/PingDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/#pingdatabaseservice","title":"PingDatabaseService","text":"[jvm]\\ @Singleton
class PingDatabaseService@Injectconstructor(config: DataSourceConfig, deployment: Deployment) : AbstractIdleService
Service that waits for the database to become healthy. This is needed if we\u2019re booting up a Vitess cluster as part of the test run.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/#constructors","title":"Constructors","text":"PingDatabaseService [jvm]@Injectconstructor(config: DataSourceConfig, deployment: Deployment)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/-ping-database-service/","title":"PingDatabaseService - Misk","text":"//misk-jdbc/misk.jdbc/PingDatabaseService/PingDatabaseService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-ping-database-service/-ping-database-service/#pingdatabaseservice","title":"PingDatabaseService","text":"[jvm]\\
@Inject
constructor(config: DataSourceConfig, deployment: Deployment)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-jdbc/misk.jdbc/PostCommitHookFailedException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ class PostCommitHookFailedException(cause: Throwable) : Exception
PostCommitHookFailedException is raised when a code run as part of a post-commit hook fails. Because post-commit hooks are run after the transaction is committed, failure in these hooks does not cause the transaction to rollback, and applications may need to differentiate the two cases (exception occurred and caused the transaction to rollback, exception occurred during a post-commit hook
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#constructors","title":"Constructors","text":"PostCommitHookFailedException [jvm]constructor(cause: Throwable)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/","title":"PostCommitHookFailedException - Misk","text":"//misk-jdbc/misk.jdbc/PostCommitHookFailedException/PostCommitHookFailedException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-post-commit-hook-failed-exception/-post-commit-hook-failed-exception/#postcommithookfailedexception","title":"PostCommitHookFailedException","text":"[jvm]\\ constructor(cause: Throwable)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/","title":"RealDatabasePool - Misk","text":"//misk-jdbc/misk.jdbc/RealDatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/#realdatabasepool","title":"RealDatabasePool","text":"[jvm]\\ object RealDatabasePool : DatabasePool
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/#functions","title":"Functions","text":"Name Summary releaseDatabase [jvm]open override fun releaseDatabase(config: DataSourceConfig)Releases a config created by takeDatabase. takeDatabase [jvm]open override fun takeDatabase(config: DataSourceConfig): DataSourceConfigFinds a database to satisfy config and returns a new config that targets it."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/release-database/","title":"releaseDatabase - Misk","text":"//misk-jdbc/misk.jdbc/RealDatabasePool/releaseDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/release-database/#releasedatabase","title":"releaseDatabase","text":"[jvm]\\ open override fun releaseDatabase(config: DataSourceConfig)
Releases a config created by takeDatabase.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/take-database/","title":"takeDatabase - Misk","text":"//misk-jdbc/misk.jdbc/RealDatabasePool/takeDatabase
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-database-pool/take-database/#takedatabase","title":"takeDatabase","text":"[jvm]\\ open override fun takeDatabase(config: DataSourceConfig): DataSourceConfig
Finds a database to satisfy config and returns a new config that targets it.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/","title":"RealTransacter - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#realtransacter","title":"RealTransacter","text":"[jvm]\\ class RealTransacter(dataSourceService: DataSourceService) : Transacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#constructors","title":"Constructors","text":"RealTransacter [jvm]constructor(dataSourceService: DataSourceService)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#properties","title":"Properties","text":"Name Summary inTransaction [jvm]open override val inTransaction: BooleanReturns true if the calling thread is currently within a transaction block."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/#functions","title":"Functions","text":"Name Summary transaction [jvm]open override fun <T> transaction(work: (connection: Connection) -> T): TStarts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed. transactionWithSession [jvm]open override fun <T> transactionWithSession(work: (session: JDBCSession) -> T): TStarts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/-real-transacter/","title":"RealTransacter - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/RealTransacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/-real-transacter/#realtransacter","title":"RealTransacter","text":"[jvm]\\ constructor(dataSourceService: DataSourceService)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/in-transaction/","title":"inTransaction - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/inTransaction
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/in-transaction/#intransaction","title":"inTransaction","text":"[jvm]\\ open override val inTransaction: Boolean
Returns true if the calling thread is currently within a transaction block.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction-with-session/","title":"transactionWithSession - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/transactionWithSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction-with-session/#transactionwithsession","title":"transactionWithSession","text":"[jvm]\\ open override fun <T> transactionWithSession(work: (session: JDBCSession) -> T): T
Starts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed.
This session object passed in wraps a connection and provides a way to add pre and post commit hooks that execute before and after a transaction is committed.
It is an error to start a transaction if another transaction is already in progress.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction/","title":"transaction - Misk","text":"//misk-jdbc/misk.jdbc/RealTransacter/transaction
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-real-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\ open override fun <T> transaction(work: (connection: Connection) -> T): T
Starts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed.
It is an error to start a transaction if another transaction is already in progress.
Prefer using transactionWithSession instead of this method as it has more functionality such as commit hooks.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/","title":"SchemaMigratorService - Misk","text":"//misk-jdbc/misk.jdbc/SchemaMigratorService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/#schemamigratorservice","title":"SchemaMigratorService","text":"[jvm]\\ class SchemaMigratorService : AbstractIdleService, HealthCheck, DatabaseReadyService
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State status [jvm]open override fun status(): HealthStatus stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/status/","title":"status - Misk","text":"//misk-jdbc/misk.jdbc/SchemaMigratorService/status
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-schema-migrator-service/status/#status","title":"status","text":"[jvm]\\ open override fun status(): HealthStatus
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/","title":"Session - Misk","text":"//misk-jdbc/misk.jdbc/Session
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/#session","title":"Session","text":"interface Session
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/#inheritors","title":"Inheritors","text":"JDBCSession"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/#functions","title":"Functions","text":"Name Summary onPostCommit [jvm]abstract fun onPostCommit(work: () -> Unit)Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed onPreCommit [jvm]abstract fun onPreCommit(work: () -> Unit)Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back. onSessionClose [jvm]abstract fun onSessionClose(work: () -> Unit)Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back. useConnection [jvm]abstract fun <T> useConnection(work: (Connection) -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-post-commit/","title":"onPostCommit - Misk","text":"//misk-jdbc/misk.jdbc/Session/onPostCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-post-commit/#onpostcommit","title":"onPostCommit","text":"[jvm]\\ abstract fun onPostCommit(work: () -> Unit)
Registers a hook that fires after the session transaction commits. Post-commit hooks cannot affect the disposition of the transaction; if a post-commit hook fails, the failure will be logged but not propagated to the application, as the transaction will have already committed
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-pre-commit/","title":"onPreCommit - Misk","text":"//misk-jdbc/misk.jdbc/Session/onPreCommit
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-pre-commit/#onprecommit","title":"onPreCommit","text":"[jvm]\\ abstract fun onPreCommit(work: () -> Unit)
Registers a hook that fires before the session\u2019s transaction commits. Failures in a pre-commit hook will cause the transaction to be rolled back.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-session-close/","title":"onSessionClose - Misk","text":"//misk-jdbc/misk.jdbc/Session/onSessionClose
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/on-session-close/#onsessionclose","title":"onSessionClose","text":"[jvm]\\ abstract fun onSessionClose(work: () -> Unit)
Registers a hook that fires after a session is closed. This is called regardless if a session was successfully committed or rolled back.
A new transaction can be initiated as part of this hook.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/use-connection/","title":"useConnection - Misk","text":"//misk-jdbc/misk.jdbc/Session/useConnection
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-session/use-connection/#useconnection","title":"useConnection","text":"[jvm]\\ abstract fun <T> useConnection(work: (Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/","title":"SpanInjector - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#spaninjector","title":"SpanInjector","text":"[jvm]\\ class SpanInjector(val tracer: Tracer?, val config: DataSourceConfig) : QueryTransformer, DataSourceDecorator
On the fly decorates queries with the span context, so the query call can be traced all the way through Vitess
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#constructors","title":"Constructors","text":"SpanInjector [jvm]constructor(tracer: Tracer?, config: DataSourceConfig)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#properties","title":"Properties","text":"Name Summary config [jvm]val config: DataSourceConfig tracer [jvm]val tracer: Tracer?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/#functions","title":"Functions","text":"Name Summary decorate [jvm]open override fun decorate(dataSource: DataSource): DataSource transformQuery [jvm]open override fun transformQuery(transformInfo: TransformInfo?): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/-span-injector/","title":"SpanInjector - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/SpanInjector
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/-span-injector/#spaninjector","title":"SpanInjector","text":"[jvm]\\ constructor(tracer: Tracer?, config: DataSourceConfig)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/config/","title":"config - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/config
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/config/#config","title":"config","text":"[jvm]\\ val config: DataSourceConfig
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/decorate/","title":"decorate - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/decorate
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/decorate/#decorate","title":"decorate","text":"[jvm]\\ open override fun decorate(dataSource: DataSource): DataSource
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/tracer/","title":"tracer - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/tracer
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/tracer/#tracer","title":"tracer","text":"[jvm]\\ val tracer: Tracer?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/transform-query/","title":"transformQuery - Misk","text":"//misk-jdbc/misk.jdbc/SpanInjector/transformQuery
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-span-injector/transform-query/#transformquery","title":"transformQuery","text":"[jvm]\\ open override fun transformQuery(transformInfo: TransformInfo?): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/","title":"StringBuilderCarrier - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#stringbuildercarrier","title":"StringBuilderCarrier","text":"[jvm]\\ class StringBuilderCarrier : TextMap
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#constructors","title":"Constructors","text":"StringBuilderCarrier [jvm]constructor()"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#properties","title":"Properties","text":"Name Summary map [jvm]val map: HashMap<String, String>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/#functions","title":"Functions","text":"Name Summary forEach [jvm]open fun forEach(p0: Consumer<in MutableMap.MutableEntry<String, String>>) iterator [jvm]open operator override fun iterator(): MutableIterator<MutableMap.MutableEntry<String, String>> put [jvm]open override fun put(key: String?, value: String?) spliterator [jvm]open fun spliterator(): Spliterator<MutableMap.MutableEntry<String, String>> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/-string-builder-carrier/","title":"StringBuilderCarrier - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/StringBuilderCarrier
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/-string-builder-carrier/#stringbuildercarrier","title":"StringBuilderCarrier","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/iterator/","title":"iterator - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/iterator
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/iterator/#iterator","title":"iterator","text":"[jvm]\\ open operator override fun iterator(): MutableIterator<MutableMap.MutableEntry<String, String>>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/map/","title":"map - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/map
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/map/#map","title":"map","text":"[jvm]\\ val map: HashMap<String, String>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/put/","title":"put - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/put
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/put/#put","title":"put","text":"[jvm]\\ open override fun put(key: String?, value: String?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.jdbc/StringBuilderCarrier/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-string-builder-carrier/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/","title":"TableScanException - Misk","text":"//misk-jdbc/misk.jdbc/TableScanException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#tablescanexception","title":"TableScanException","text":"[jvm]\\ class TableScanException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckException
Exception thrown if we execute a query lacking an index.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#constructors","title":"Constructors","text":"TableScanException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/-table-scan-exception/","title":"TableScanException - Misk","text":"//misk-jdbc/misk.jdbc/TableScanException/TableScanException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-table-scan-exception/-table-scan-exception/#tablescanexception","title":"TableScanException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/","title":"Transacter - Misk","text":"//misk-jdbc/misk.jdbc/Transacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#transacter","title":"Transacter","text":"interface Transacter
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#inheritors","title":"Inheritors","text":"RealTransacter"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#properties","title":"Properties","text":"Name Summary inTransaction [jvm]abstract val inTransaction: BooleanReturns true if the calling thread is currently within a transaction block."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/#functions","title":"Functions","text":"Name Summary transactionWithSession [jvm]abstract fun <T> transactionWithSession(work: (session: JDBCSession) -> T): TStarts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/in-transaction/","title":"inTransaction - Misk","text":"//misk-jdbc/misk.jdbc/Transacter/inTransaction
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/in-transaction/#intransaction","title":"inTransaction","text":"[jvm]\\ abstract val inTransaction: Boolean
Returns true if the calling thread is currently within a transaction block.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/transaction-with-session/","title":"transactionWithSession - Misk","text":"//misk-jdbc/misk.jdbc/Transacter/transactionWithSession
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.jdbc/-transacter/transaction-with-session/#transactionwithsession","title":"transactionWithSession","text":"[jvm]\\ abstract fun <T> transactionWithSession(work: (session: JDBCSession) -> T): T
Starts a transaction on the current thread, executes work, and commits the transaction. If the work raises an exception the transaction will be rolled back instead of committed.
This session object passed in wraps a connection and provides a way to add pre and post commit hooks that execute before and after a transaction is committed.
It is an error to start a transaction if another transaction is already in progress.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/","title":"Package-level declarations - Misk","text":"//misk-jdbc/misk.vitess
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/#types","title":"Types","text":"Name Summary CowriteException [jvm]class CowriteException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckExceptionThrown when a transaction that writes to multiple entity groups is detected. Destination [jvm]data class Destination(val keyspace: Keyspace?, val shard: Shard?, val tabletType: TabletType?) FullScatterException [jvm]class FullScatterException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckExceptionException thrown if we use a scatter query that is too wide in the wrong context. Keyspace [jvm]data class Keyspace(val name: String) Shard [jvm]data class Shard(val keyspace: Keyspace, val name: String) TabletType [jvm]enum TabletType : Enum<TabletType>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/#functions","title":"Functions","text":"Name Summary checkValidShardIdentifier [jvm]fun checkValidShardIdentifier(identifier: String) failSafeRead [jvm]fun <T> Connection.failSafeRead(block: (conn: Connection) -> T): TRuns a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.[jvm]fun <T> Connection.failSafeRead(shard: Shard, block: (conn: Connection) -> T): T getRootCause [jvm]fun getRootCause(throwable: Throwable): Throwable shards [jvm]fun shards(dataSourceService: DataSourceService): Supplier<Set<Shard>> tabletDoesNotExists [jvm]fun tabletDoesNotExists(e: Exception): Boolean target [jvm]fun <T> Connection.target(shard: Shard, block: (conn: Connection) -> T): T"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/check-valid-shard-identifier/","title":"checkValidShardIdentifier - Misk","text":"//misk-jdbc/misk.vitess/checkValidShardIdentifier
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/check-valid-shard-identifier/#checkvalidshardidentifier","title":"checkValidShardIdentifier","text":"[jvm]\\ fun checkValidShardIdentifier(identifier: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/fail-safe-read/","title":"failSafeRead - Misk","text":"//misk-jdbc/misk.vitess/failSafeRead
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/fail-safe-read/#failsaferead","title":"failSafeRead","text":"[jvm]\\ fun <T> Connection.failSafeRead(block: (conn: Connection) -> T): T
Runs a read on master first then tries it on replicas on failure. This method is here only for health check purpose for standby regions.
[jvm]\\ fun <T> Connection.failSafeRead(shard: Shard, block: (conn: Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/get-root-cause/","title":"getRootCause - Misk","text":"//misk-jdbc/misk.vitess/getRootCause
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/get-root-cause/#getrootcause","title":"getRootCause","text":"[jvm]\\ fun getRootCause(throwable: Throwable): Throwable
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/shards/","title":"shards - Misk","text":"//misk-jdbc/misk.vitess/shards
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/shards/#shards","title":"shards","text":"[jvm]\\ fun shards(dataSourceService: DataSourceService): Supplier<Set<Shard>>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/tablet-does-not-exists/","title":"tabletDoesNotExists - Misk","text":"//misk-jdbc/misk.vitess/tabletDoesNotExists
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/tablet-does-not-exists/#tabletdoesnotexists","title":"tabletDoesNotExists","text":"[jvm]\\ fun tabletDoesNotExists(e: Exception): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/target/","title":"target - Misk","text":"//misk-jdbc/misk.vitess/target
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/target/#target","title":"target","text":"[jvm]\\ fun <T> Connection.target(shard: Shard, block: (conn: Connection) -> T): T
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/","title":"CowriteException - Misk","text":"//misk-jdbc/misk.vitess/CowriteException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#cowriteexception","title":"CowriteException","text":"[jvm]\\ class CowriteException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckException
Thrown when a transaction that writes to multiple entity groups is detected.
Multi shard transactions are not safe and while multiple entity groups may currently reside on the same shard there is no guarantee they will do so across shard splits.
A transaction never spans a shard split. That is they never start before the split and end after, either they commit before the split or they start after the split. That said a transaction may start before a shard split and then time out or cancel and be retried after the shard split. If two entity groups resided on the same shard before the transaction they may no longer do so when the transaction is retried.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#constructors","title":"Constructors","text":"CowriteException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/-cowrite-exception/","title":"CowriteException - Misk","text":"//misk-jdbc/misk.vitess/CowriteException/CowriteException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-cowrite-exception/-cowrite-exception/#cowriteexception","title":"CowriteException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/","title":"Destination - Misk","text":"//misk-jdbc/misk.vitess/Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#destination","title":"Destination","text":"[jvm]\\ data class Destination(val keyspace: Keyspace?, val shard: Shard?, val tabletType: TabletType?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#constructors","title":"Constructors","text":"Destination [jvm]constructor(shard: Shard)constructor(tabletType: TabletType)constructor(shard: Shard, tabletType: TabletType)constructor(keyspace: Keyspace?, shard: Shard?, tabletType: TabletType?)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#properties","title":"Properties","text":"Name Summary keyspace [jvm]val keyspace: Keyspace? shard [jvm]val shard: Shard? tabletType [jvm]val tabletType: TabletType?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/#functions","title":"Functions","text":"Name Summary isBlank [jvm]fun isBlank(): Boolean mergedWith [jvm]fun mergedWith(other: Destination): Destination toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-destination/","title":"Destination - Misk","text":"//misk-jdbc/misk.vitess/Destination/Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-destination/#destination","title":"Destination","text":"[jvm]\\ constructor(shard: Shard)
constructor(tabletType: TabletType)
constructor(shard: Shard, tabletType: TabletType)
constructor(keyspace: Keyspace?, shard: Shard?, tabletType: TabletType?)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/is-blank/","title":"isBlank - Misk","text":"//misk-jdbc/misk.vitess/Destination/isBlank
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/is-blank/#isblank","title":"isBlank","text":"[jvm]\\ fun isBlank(): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/keyspace/","title":"keyspace - Misk","text":"//misk-jdbc/misk.vitess/Destination/keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/keyspace/#keyspace","title":"keyspace","text":"[jvm]\\ val keyspace: Keyspace?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/merged-with/","title":"mergedWith - Misk","text":"//misk-jdbc/misk.vitess/Destination/mergedWith
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/merged-with/#mergedwith","title":"mergedWith","text":"[jvm]\\ fun mergedWith(other: Destination): Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/shard/","title":"shard - Misk","text":"//misk-jdbc/misk.vitess/Destination/shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/shard/#shard","title":"shard","text":"[jvm]\\ val shard: Shard?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/tablet-type/","title":"tabletType - Misk","text":"//misk-jdbc/misk.vitess/Destination/tabletType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/tablet-type/#tablettype","title":"tabletType","text":"[jvm]\\ val tabletType: TabletType?
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.vitess/Destination/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.vitess/Destination/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(string: String): Destination"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/parse/","title":"parse - Misk","text":"//misk-jdbc/misk.vitess/Destination/Companion/parse
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-destination/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(string: String): Destination
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/","title":"FullScatterException - Misk","text":"//misk-jdbc/misk.vitess/FullScatterException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#fullscatterexception","title":"FullScatterException","text":"[jvm]\\ class FullScatterException@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null) : CheckException
Exception thrown if we use a scatter query that is too wide in the wrong context.
Strongly consistent reads require reads from the master of a cluster. The master of a cluster is a limited resource that we can\u2019t add more of. We can split shards but a wide scatter query will still hit all of the shards so we can\u2019t scale if we have too many wide scatters. For this reason we do not allow wide scatters for strongly consistent reads.
Note: For eventually consistent reads (that go to replicas) we may very well allow wide scatter queries because we can tune the availability by adding more replicas. Currently we do NOT differentiate between these types of reads for the detector but if you do need this it can be implemented.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#constructors","title":"Constructors","text":"FullScatterException [jvm]@JvmOverloadsconstructor(message: String? = null, cause: Throwable? = null)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable forEach [jvm]open fun forEach(p0: Consumer<in Throwable>) getErrorCode [jvm]open fun getErrorCode(): Int getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getNextException [jvm]open fun getNextException(): SQLException getSQLState [jvm]open fun getSQLState(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable iterator [jvm]open operator override fun iterator(): MutableIterator<Throwable> printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setNextException [jvm]open fun setNextException(p0: SQLException) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>) spliterator [jvm]open fun spliterator(): Spliterator<Throwable>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/-full-scatter-exception/","title":"FullScatterException - Misk","text":"//misk-jdbc/misk.vitess/FullScatterException/FullScatterException
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-full-scatter-exception/-full-scatter-exception/#fullscatterexception","title":"FullScatterException","text":"[jvm]\\
@JvmOverloads
constructor(message: String? = null, cause: Throwable? = null)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.vitess/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ data class Keyspace(val name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#constructors","title":"Constructors","text":"Keyspace [jvm]constructor(name: String)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/-keyspace/","title":"Keyspace - Misk","text":"//misk-jdbc/misk.vitess/Keyspace/Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/-keyspace/#keyspace","title":"Keyspace","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/name/","title":"name - Misk","text":"//misk-jdbc/misk.vitess/Keyspace/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.vitess/Keyspace/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-keyspace/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/","title":"Shard - Misk","text":"//misk-jdbc/misk.vitess/Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#shard","title":"Shard","text":"[jvm]\\ data class Shard(val keyspace: Keyspace, val name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#constructors","title":"Constructors","text":"Shard [jvm]constructor(keyspace: Keyspace, name: String)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion Key [jvm]data class Key(val bytes: ByteString) : Comparable<Shard.Key>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#properties","title":"Properties","text":"Name Summary keyspace [jvm]val keyspace: Keyspace name [jvm]val name: String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/#functions","title":"Functions","text":"Name Summary contains [jvm]operator fun contains(keyspaceId: Shard.Key): Boolean keyRange [jvm]fun keyRange(): Range<Shard.Key> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-shard/","title":"Shard - Misk","text":"//misk-jdbc/misk.vitess/Shard/Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-shard/#shard","title":"Shard","text":"[jvm]\\ constructor(keyspace: Keyspace, name: String)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/contains/","title":"contains - Misk","text":"//misk-jdbc/misk.vitess/Shard/contains
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/contains/#contains","title":"contains","text":"[jvm]\\ operator fun contains(keyspaceId: Shard.Key): Boolean
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/key-range/","title":"keyRange - Misk","text":"//misk-jdbc/misk.vitess/Shard/keyRange
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/key-range/#keyrange","title":"keyRange","text":"[jvm]\\ fun keyRange(): Range<Shard.Key>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/keyspace/","title":"keyspace - Misk","text":"//misk-jdbc/misk.vitess/Shard/keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/keyspace/#keyspace","title":"keyspace","text":"[jvm]\\ val keyspace: Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/name/","title":"name - Misk","text":"//misk-jdbc/misk.vitess/Shard/name
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/to-string/","title":"toString - Misk","text":"//misk-jdbc/misk.vitess/Shard/toString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/#properties","title":"Properties","text":"Name Summary MAX_LENGTH [jvm]const val MAX_LENGTH: Int = 8 SINGLE_KEYSPACE [jvm]val SINGLE_KEYSPACE: Keyspace SINGLE_SHARD [jvm]val SINGLE_SHARD: Shard SINGLE_SHARD_ID [jvm]const val SINGLE_SHARD_ID: String SINGLE_SHARD_SET [jvm]val SINGLE_SHARD_SET: ImmutableSet<Shard>"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/#functions","title":"Functions","text":"Name Summary parse [jvm]fun parse(string: String): Shard"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-m-a-x_-l-e-n-g-t-h/","title":"MAX_LENGTH - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/MAX_LENGTH
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-m-a-x_-l-e-n-g-t-h/#max_length","title":"MAX_LENGTH","text":"[jvm]\\ const val MAX_LENGTH: Int = 8
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-k-e-y-s-p-a-c-e/","title":"SINGLE_KEYSPACE - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_KEYSPACE
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-k-e-y-s-p-a-c-e/#single_keyspace","title":"SINGLE_KEYSPACE","text":"[jvm]\\ val SINGLE_KEYSPACE: Keyspace
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d/","title":"SINGLE_SHARD - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_SHARD
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d/#single_shard","title":"SINGLE_SHARD","text":"[jvm]\\ val SINGLE_SHARD: Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-i-d/","title":"SINGLE_SHARD_ID - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_SHARD_ID
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-i-d/#single_shard_id","title":"SINGLE_SHARD_ID","text":"[jvm]\\ const val SINGLE_SHARD_ID: String
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-s-e-t/","title":"SINGLE_SHARD_SET - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/SINGLE_SHARD_SET
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/-s-i-n-g-l-e_-s-h-a-r-d_-s-e-t/#single_shard_set","title":"SINGLE_SHARD_SET","text":"[jvm]\\ val SINGLE_SHARD_SET: ImmutableSet<Shard>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/parse/","title":"parse - Misk","text":"//misk-jdbc/misk.vitess/Shard/Companion/parse
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(string: String): Shard
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/","title":"Key - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#key","title":"Key","text":"[jvm]\\ data class Key(val bytes: ByteString) : Comparable<Shard.Key>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#constructors","title":"Constructors","text":"Key [jvm]constructor(hex: String)Vitess always converts sharding keys to a left-justified binary string for computing a shard. This left-justification makes the right-most zeroes insignificant and optional.constructor(bytes: ByteString)"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#properties","title":"Properties","text":"Name Summary bytes [jvm]val bytes: ByteString"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/#functions","title":"Functions","text":"Name Summary compareTo [jvm]open operator override fun compareTo(other: Shard.Key): Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-key/","title":"Key - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/Key
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-key/#key","title":"Key","text":"[jvm]\\ constructor(hex: String)
Vitess always converts sharding keys to a left-justified binary string for computing a shard. This left-justification makes the right-most zeroes insignificant and optional.
To make compareTo, equals and hashCode work properly in Java, these keys are force padded with 0\u2019s at the end. Dynamic end padding when comparing would break the equals/hashCode contract in Java.
[jvm]\\ constructor(bytes: ByteString)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/bytes/","title":"bytes - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/bytes
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/bytes/#bytes","title":"bytes","text":"[jvm]\\ val bytes: ByteString
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/compare-to/","title":"compareTo - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/compareTo
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Shard.Key): Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/","title":"Companion - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/#functions","title":"Functions","text":"Name Summary hash [jvm]fun hash(id: Long): Shard.Key"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/hash/","title":"hash - Misk","text":"//misk-jdbc/misk.vitess/Shard/Key/Companion/hash
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-shard/-key/-companion/hash/#hash","title":"hash","text":"[jvm]\\ fun hash(id: Long): Shard.Key
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/","title":"TabletType - Misk","text":"//misk-jdbc/misk.vitess/TabletType
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#tablettype","title":"TabletType","text":"[jvm]\\ enum TabletType : Enum<TabletType>
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#entries","title":"Entries","text":"MASTER [jvm]MASTER REPLICA [jvm]REPLICA"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<TabletType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): TabletTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<TabletType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/entries/","title":"entries - Misk","text":"//misk-jdbc/misk.vitess/TabletType/entries
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<TabletType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value-of/","title":"valueOf - Misk","text":"//misk-jdbc/misk.vitess/TabletType/valueOf
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): TabletType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value/","title":"value - Misk","text":"//misk-jdbc/misk.vitess/TabletType/value
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/value/#value","title":"value","text":"[jvm]\\ val value: Int
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/values/","title":"values - Misk","text":"//misk-jdbc/misk.vitess/TabletType/values
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<TabletType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-m-a-s-t-e-r/","title":"MASTER - Misk","text":"//misk-jdbc/misk.vitess/TabletType/MASTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-m-a-s-t-e-r/#master","title":"MASTER","text":"[jvm]\\ MASTER
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-m-a-s-t-e-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-r-e-p-l-i-c-a/","title":"REPLICA - Misk","text":"//misk-jdbc/misk.vitess/TabletType/REPLICA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-r-e-p-l-i-c-a/#replica","title":"REPLICA","text":"[jvm]\\ REPLICA
"},{"location":"0.x/misk-jdbc/misk-jdbc/misk.vitess/-tablet-type/-r-e-p-l-i-c-a/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jobqueue/","title":"misk-jobqueue - Misk","text":"//misk-jobqueue
"},{"location":"0.x/misk-jobqueue/#misk-jobqueue","title":"misk-jobqueue","text":""},{"location":"0.x/misk-jobqueue/#packages","title":"Packages","text":"Name misk.jobqueue"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/","title":"Package-level declarations - Misk","text":"//misk-jobqueue/misk.jobqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/#types","title":"Types","text":"Name Summary Job [jvm]interface JobIncoming job JobConsumer [jvm]interface JobConsumerA JobConsumer allows applications to subscribe to receive incoming jobs JobHandler [jvm]interface JobHandlerA JobHandler is an application implemented interface that handles jobs received by this service. JobHandlers must explicitly call Job.acknowledge after successful processing to cause the to be deleted from the underlying queue and not redelivered, or can call Job.deadLetter to put the job onto the associated dead letter queue. The jobqueue framework assumes that the underlying queueing system is at-least-once, so handlers must be prepared for the possibility that a job will be delivered more than once (for example if the process fails or the visibility timeout expires after processing but before acknowledgement). Typically this is handled by either storing some sort of ticket in the local database when the job is enqueued and deleting it as part of the application transaction when the job is processed but prior to acknowledgement, or by storing some sort of \"processed marker\" in the local database during job processing and ignoring jobs whose marker is already recorded. JobQueue [jvm]interface JobQueueA JobQueue enqueues jobs for asynchronous execution, possibly in another process. Jobs are enqueued immediately and may involve an RPC to the underlying job queueing system, so should not be done from within a database transaction. Applications that need to enqueue jobs atomically with a local database transaction should use the TransactionalJobQueue interface QueueName [jvm]data class QueueName(val value: String)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/#functions","title":"Functions","text":"Name Summary subscribe [jvm]inline fun JobConsumer.subscribe(queueName: QueueName, crossinline handler: (Job) -> Unit)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/subscribe/","title":"subscribe - Misk","text":"//misk-jobqueue/misk.jobqueue/subscribe
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ inline fun JobConsumer.subscribe(queueName: QueueName, crossinline handler: (Job) -> Unit)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/","title":"Job - Misk","text":"//misk-jobqueue/misk.jobqueue/Job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/#job","title":"Job","text":"[jvm]\\ interface Job
Incoming job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/#properties","title":"Properties","text":"Name Summary attributes [jvm]abstract val attributes: Map<String, String>context attributes associated with the job body [jvm]abstract val body: Stringbody of the job id [jvm]abstract val id: Stringsystem assigned globally unique id for the job idempotenceKey [jvm]abstract val idempotenceKey: StringApplication assigned key for a job. queueName [jvm]abstract val queueName: QueueNamename of the queue on which the job was received"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/#functions","title":"Functions","text":"Name Summary acknowledge [jvm]abstract fun acknowledge()Acknowledges the job and deletes it from the underlying queue. May perform an RPC, and thus should not be called while holding database transactions or other resources deadLetter [jvm]abstract fun deadLetter()Moves the job from the main queue onto the associated dead letter queue. May perform an RPC delayWithBackoff [jvm]abstract fun delayWithBackoff()Assigns and applies a visibility timeout for the job by making it unreachable for some time duration. The timeout increases after each retry. May perform an RPC."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/acknowledge/","title":"acknowledge - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/acknowledge
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/acknowledge/#acknowledge","title":"acknowledge","text":"[jvm]\\ abstract fun acknowledge()
Acknowledges the job and deletes it from the underlying queue. May perform an RPC, and thus should not be called while holding database transactions or other resources
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/attributes/","title":"attributes - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/attributes
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/attributes/#attributes","title":"attributes","text":"[jvm]\\ abstract val attributes: Map<String, String>
context attributes associated with the job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/body/","title":"body - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/body
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/body/#body","title":"body","text":"[jvm]\\ abstract val body: String
body of the job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/dead-letter/","title":"deadLetter - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/deadLetter
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/dead-letter/#deadletter","title":"deadLetter","text":"[jvm]\\ abstract fun deadLetter()
Moves the job from the main queue onto the associated dead letter queue. May perform an RPC
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/delay-with-backoff/","title":"delayWithBackoff - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/delayWithBackoff
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/delay-with-backoff/#delaywithbackoff","title":"delayWithBackoff","text":"[jvm]\\ abstract fun delayWithBackoff()
Assigns and applies a visibility timeout for the job by making it unreachable for some time duration. The timeout increases after each retry. May perform an RPC.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/id/","title":"id - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/id
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/id/#id","title":"id","text":"[jvm]\\ abstract val id: String
system assigned globally unique id for the job
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/idempotence-key/","title":"idempotenceKey - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/idempotenceKey
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/idempotence-key/#idempotencekey","title":"idempotenceKey","text":"[jvm]\\ abstract val idempotenceKey: String
Application assigned key for a job.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/idempotence-key/#see-also","title":"See also","text":"JobQueue.enqueue"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/queue-name/","title":"queueName - Misk","text":"//misk-jobqueue/misk.jobqueue/Job/queueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job/queue-name/#queuename","title":"queueName","text":"[jvm]\\ abstract val queueName: QueueName
name of the queue on which the job was received
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/","title":"JobConsumer - Misk","text":"//misk-jobqueue/misk.jobqueue/JobConsumer
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/#jobconsumer","title":"JobConsumer","text":"[jvm]\\ interface JobConsumer
A JobConsumer allows applications to subscribe to receive incoming jobs
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/#functions","title":"Functions","text":"Name Summary subscribe [jvm]abstract fun subscribe(queueName: QueueName, handler: JobHandler)Registers a handler to receive messages. Once registered, the consumer will immediately begin receiving messages from the underlying job queue and dispatch them to the provided handler. A service may only have one subscription outstanding per queue subscribe [jvm]inline fun JobConsumer.subscribe(queueName: QueueName, crossinline handler: (Job) -> Unit) unsubscribe [jvm]abstract fun unsubscribe(queueName: QueueName)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/subscribe/","title":"subscribe - Misk","text":"//misk-jobqueue/misk.jobqueue/JobConsumer/subscribe
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ abstract fun subscribe(queueName: QueueName, handler: JobHandler)
Registers a handler to receive messages. Once registered, the consumer will immediately begin receiving messages from the underlying job queue and dispatch them to the provided handler. A service may only have one subscription outstanding per queue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/unsubscribe/","title":"unsubscribe - Misk","text":"//misk-jobqueue/misk.jobqueue/JobConsumer/unsubscribe
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-consumer/unsubscribe/#unsubscribe","title":"unsubscribe","text":"[jvm]\\ abstract fun unsubscribe(queueName: QueueName)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/","title":"JobHandler - Misk","text":"//misk-jobqueue/misk.jobqueue/JobHandler
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/#jobhandler","title":"JobHandler","text":"[jvm]\\ interface JobHandler
A JobHandler is an application implemented interface that handles jobs received by this service. JobHandlers must explicitly call Job.acknowledge after successful processing to cause the to be deleted from the underlying queue and not redelivered, or can call Job.deadLetter to put the job onto the associated dead letter queue. The jobqueue framework assumes that the underlying queueing system is at-least-once, so handlers must be prepared for the possibility that a job will be delivered more than once (for example if the process fails or the visibility timeout expires after processing but before acknowledgement). Typically this is handled by either storing some sort of ticket in the local database when the job is enqueued and deleting it as part of the application transaction when the job is processed but prior to acknowledgement, or by storing some sort of \"processed marker\" in the local database during job processing and ignoring jobs whose marker is already recorded.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/#functions","title":"Functions","text":"Name Summary handleJob [jvm]abstract fun handleJob(job: Job)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/handle-job/","title":"handleJob - Misk","text":"//misk-jobqueue/misk.jobqueue/JobHandler/handleJob
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-handler/handle-job/#handlejob","title":"handleJob","text":"[jvm]\\ abstract fun handleJob(job: Job)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/","title":"JobQueue - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/#jobqueue","title":"JobQueue","text":"[jvm]\\ interface JobQueue
A JobQueue enqueues jobs for asynchronous execution, possibly in another process. Jobs are enqueued immediately and may involve an RPC to the underlying job queueing system, so should not be done from within a database transaction. Applications that need to enqueue jobs atomically with a local database transaction should use the TransactionalJobQueue interface
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/#types","title":"Types","text":"Name Summary BatchEnqueueException [jvm]data class BatchEnqueueException(val queueName: QueueName, val successful: List<String>, val failed: List<JobQueue.EnqueueErrorResult>) : ExceptionException Data class containing the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned Companion [jvm]object Companion EnqueueErrorResult [jvm]data class EnqueueErrorResult(val idempotenceKey: String, val clientError: Boolean, val code: String, val message: String)Data class containing the error result of a failed job enqueue JobRequest [jvm]data class JobRequest@JvmOverloadsconstructor(val body: String, val idempotenceKey: String = UUID.randomUUID().toString(), val deliveryDelay: Duration? = null, val attributes: Map<String, String> = mapOf())Data class containing the necessary information to be enqueued in a batch enqueue"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/#functions","title":"Functions","text":"Name Summary batchEnqueue [jvm]abstract fun batchEnqueue(queueName: QueueName, jobs: List<JobQueue.JobRequest>)throws BatchEnqueueException contains the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned enqueue [jvm]open fun enqueue(queueName: QueueName, body: String, deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())[jvm]abstract fun enqueue(queueName: QueueName, body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())Enqueue a job onto the given queue, along with a set of job attributes."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/batch-enqueue/","title":"batchEnqueue - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/batchEnqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/batch-enqueue/#batchenqueue","title":"batchEnqueue","text":"[jvm]\\ abstract fun batchEnqueue(queueName: QueueName, jobs: List<JobQueue.JobRequest>)
throws BatchEnqueueException contains the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/enqueue/","title":"enqueue - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/enqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/enqueue/#enqueue","title":"enqueue","text":"[jvm]\\ open fun enqueue(queueName: QueueName, body: String, deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())
[jvm]\\ abstract fun enqueue(queueName: QueueName, body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())
Enqueue a job onto the given queue, along with a set of job attributes.
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/enqueue/#parameters","title":"Parameters","text":"jvm
queueName The name of the queue on which to place the job. body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body. idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set. deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m). If a longer delay is required by applications, use the TransactionalJobQueue interface instead. attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/","title":"BatchEnqueueException - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#batchenqueueexception","title":"BatchEnqueueException","text":"[jvm]\\ data class BatchEnqueueException(val queueName: QueueName, val successful: List<String>, val failed: List<JobQueue.EnqueueErrorResult>) : Exception
Exception Data class containing the list of jobs successfully enqueued and the list of jobs that could not be enqueued. See EnqueueErrorResult for more details on the error information returned
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#constructors","title":"Constructors","text":"BatchEnqueueException [jvm]constructor(queueName: QueueName, successful: List<String>, failed: List<JobQueue.EnqueueErrorResult>)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? failed [jvm]val failed: List<JobQueue.EnqueueErrorResult> message [jvm]open val message: String? queueName [jvm]val queueName: QueueName successful [jvm]val successful: List<String>"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/-batch-enqueue-exception/","title":"BatchEnqueueException - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/BatchEnqueueException
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/-batch-enqueue-exception/#batchenqueueexception","title":"BatchEnqueueException","text":"[jvm]\\ constructor(queueName: QueueName, successful: List<String>, failed: List<JobQueue.EnqueueErrorResult>)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/failed/","title":"failed - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/failed
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/failed/#failed","title":"failed","text":"[jvm]\\ val failed: List<JobQueue.EnqueueErrorResult>
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/queue-name/","title":"queueName - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/queueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/queue-name/#queuename","title":"queueName","text":"[jvm]\\ val queueName: QueueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/successful/","title":"successful - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/BatchEnqueueException/successful
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-batch-enqueue-exception/successful/#successful","title":"successful","text":"[jvm]\\ val successful: List<String>
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/","title":"Companion - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/Companion
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/#properties","title":"Properties","text":"Name Summary SQS_MAX_BATCH_ENQUEUE_JOB_SIZE [jvm]const val SQS_MAX_BATCH_ENQUEUE_JOB_SIZE: Int = 10"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/-s-q-s_-m-a-x_-b-a-t-c-h_-e-n-q-u-e-u-e_-j-o-b_-s-i-z-e/","title":"SQS_MAX_BATCH_ENQUEUE_JOB_SIZE - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/Companion/SQS_MAX_BATCH_ENQUEUE_JOB_SIZE
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-companion/-s-q-s_-m-a-x_-b-a-t-c-h_-e-n-q-u-e-u-e_-j-o-b_-s-i-z-e/#sqs_max_batch_enqueue_job_size","title":"SQS_MAX_BATCH_ENQUEUE_JOB_SIZE","text":"[jvm]\\ const val SQS_MAX_BATCH_ENQUEUE_JOB_SIZE: Int = 10
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/","title":"EnqueueErrorResult - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#enqueueerrorresult","title":"EnqueueErrorResult","text":"data class EnqueueErrorResult(val idempotenceKey: String, val clientError: Boolean, val code: String, val message: String)
Data class containing the error result of a failed job enqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key for the failed enqueued job clientError Indicates whether the error is due to a clientside error code Error code returned by the JobQueue service message Error message returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#constructors","title":"Constructors","text":"EnqueueErrorResult [jvm]constructor(idempotenceKey: String, clientError: Boolean, code: String, message: String)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/#properties","title":"Properties","text":"Name Summary clientError [jvm]val clientError: Boolean code [jvm]val code: String idempotenceKey [jvm]val idempotenceKey: String message [jvm]val message: String"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/-enqueue-error-result/","title":"EnqueueErrorResult - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/EnqueueErrorResult
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/-enqueue-error-result/#enqueueerrorresult","title":"EnqueueErrorResult","text":"[jvm]\\ constructor(idempotenceKey: String, clientError: Boolean, code: String, message: String)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/-enqueue-error-result/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key for the failed enqueued job clientError Indicates whether the error is due to a clientside error code Error code returned by the JobQueue service message Error message returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/client-error/","title":"clientError - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/clientError
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/client-error/#clienterror","title":"clientError","text":"[jvm]\\ val clientError: Boolean
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/client-error/#parameters","title":"Parameters","text":"jvm
clientError Indicates whether the error is due to a clientside error"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/code/","title":"code - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/code
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/code/#code","title":"code","text":"[jvm]\\ val code: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/code/#parameters","title":"Parameters","text":"jvm
code Error code returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/idempotence-key/","title":"idempotenceKey - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/idempotenceKey
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/idempotence-key/#idempotencekey","title":"idempotenceKey","text":"[jvm]\\ val idempotenceKey: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/idempotence-key/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key for the failed enqueued job"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/message/","title":"message - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/EnqueueErrorResult/message
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/message/#message","title":"message","text":"[jvm]\\ val message: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-enqueue-error-result/message/#parameters","title":"Parameters","text":"jvm
message Error message returned by the JobQueue service"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/","title":"JobRequest - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#jobrequest","title":"JobRequest","text":"data class JobRequest@JvmOverloadsconstructor(val body: String, val idempotenceKey: String = UUID.randomUUID().toString(), val deliveryDelay: Duration? = null, val attributes: Map<String, String> = mapOf())
Data class containing the necessary information to be enqueued in a batch enqueue
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#parameters","title":"Parameters","text":"jvm
body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body. idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set. deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m). attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#constructors","title":"Constructors","text":"JobRequest [jvm]@JvmOverloadsconstructor(body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/#properties","title":"Properties","text":"Name Summary attributes [jvm]val attributes: Map<String, String> body [jvm]val body: String deliveryDelay [jvm]val deliveryDelay: Duration? = null idempotenceKey [jvm]val idempotenceKey: String"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/-job-request/","title":"JobRequest - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/JobRequest
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/-job-request/#jobrequest","title":"JobRequest","text":"[jvm]\\
@JvmOverloads
constructor(body: String, idempotenceKey: String = UUID.randomUUID().toString(), deliveryDelay: Duration? = null, attributes: Map<String, String> = mapOf())
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/-job-request/#parameters","title":"Parameters","text":"jvm
body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body. idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set. deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m). attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/attributes/","title":"attributes - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/attributes
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/attributes/#attributes","title":"attributes","text":"[jvm]\\ val attributes: Map<String, String>
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/attributes/#parameters","title":"Parameters","text":"jvm
attributes Arbitrary contextual attributes associated with the job. Implementations may limit the number of attributes per message."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/body/","title":"body - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/body
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/body/#body","title":"body","text":"[jvm]\\ val body: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/body/#parameters","title":"Parameters","text":"jvm
body The body of the job; can be any arbitrary string - it is up to the enqueuer and consumer to agree on the format of the body."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/delivery-delay/","title":"deliveryDelay - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/deliveryDelay
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/delivery-delay/#deliverydelay","title":"deliveryDelay","text":"[jvm]\\ val deliveryDelay: Duration? = null
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/delivery-delay/#parameters","title":"Parameters","text":"jvm
deliveryDelay If specified, the job will only become visible to the consumer after the provided duration. Used for jobs that should delay processing for a period of time. Note that depending on implementation, there may be an upper limit to this value. For instance, SQS implementation limitsdeliveryDelay to 900s (15m)."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/idempotence-key/","title":"idempotenceKey - Misk","text":"//misk-jobqueue/misk.jobqueue/JobQueue/JobRequest/idempotenceKey
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/idempotence-key/#idempotencekey","title":"idempotenceKey","text":"[jvm]\\ val idempotenceKey: String
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-job-queue/-job-request/idempotence-key/#parameters","title":"Parameters","text":"jvm
idempotenceKey Client-assigned unique key, useful for application code to detect duplicate work. Implementations of both JobQueue and JobConsumer are expected to not perform any filtering based on this value, as it carries meaning only for application code (i.e. any logic around this property should take place in JobHandlers). Defaults to a randomly generated UUID when not explicitly set."},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/","title":"QueueName - Misk","text":"//misk-jobqueue/misk.jobqueue/QueueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/#queuename","title":"QueueName","text":"[jvm]\\ data class QueueName(val value: String)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/#constructors","title":"Constructors","text":"QueueName [jvm]constructor(value: String)"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/-queue-name/","title":"QueueName - Misk","text":"//misk-jobqueue/misk.jobqueue/QueueName/QueueName
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/-queue-name/#queuename","title":"QueueName","text":"[jvm]\\ constructor(value: String)
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/value/","title":"value - Misk","text":"//misk-jobqueue/misk.jobqueue/QueueName/value
"},{"location":"0.x/misk-jobqueue/misk-jobqueue/misk.jobqueue/-queue-name/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-jooq/","title":"misk-jooq - Misk","text":"//misk-jooq
"},{"location":"0.x/misk-jooq/#misk-jooq","title":"misk-jooq","text":""},{"location":"0.x/misk-jooq/#packages","title":"Packages","text":"Name misk.jooq misk.jooq.listeners misk.jooq.testgen misk.jooq.testgen.keys misk.jooq.testgen.tables misk.jooq.testgen.tables.records misk.jooq.testgen.tables.references"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/#types","title":"Types","text":"Name Summary IsolationLevelAwareConnectionProvider [jvm]class IsolationLevelAwareConnectionProvider(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions) : ConnectionProvider JooqHealthCheck [jvm]class JooqHealthCheck(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock) : HealthCheck JooqModule [jvm]class JooqModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {}) : KAbstractModule JooqSession [jvm]class JooqSession(val ctx: DSLContext) : Session JooqTransacter [jvm]class JooqTransacter@JvmOverloadsconstructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {}) TransactionIsolationLevel [jvm]enum TransactionIsolationLevel : Enum<TransactionIsolationLevel>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/#functions","title":"Functions","text":"Name Summary fetchOneOrNull [jvm]fun <RECORD : Record?> ResultQuery<RECORD>.fetchOneOrNull(): RECORD? getOrThrow [jvm]fun <ANY> ANY?.getOrThrow(): ANY ifNotNull [jvm]inline fun <ANY> ANY?.ifNotNull(condition: (any: ANY) -> Condition): Condition toInstant [jvm]fun LocalDateTime.toInstant(): Instant toLocalDateTime [jvm]fun Instant.toLocalDateTime(): LocalDateTime"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/fetch-one-or-null/","title":"fetchOneOrNull - Misk","text":"//misk-jooq/misk.jooq/fetchOneOrNull
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/fetch-one-or-null/#fetchoneornull","title":"fetchOneOrNull","text":"[jvm]\\ fun <RECORD : Record?> ResultQuery<RECORD>.fetchOneOrNull(): RECORD?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/get-or-throw/","title":"getOrThrow - Misk","text":"//misk-jooq/misk.jooq/getOrThrow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/get-or-throw/#getorthrow","title":"getOrThrow","text":"[jvm]\\ fun <ANY> ANY?.getOrThrow(): ANY
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/if-not-null/","title":"ifNotNull - Misk","text":"//misk-jooq/misk.jooq/ifNotNull
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/if-not-null/#ifnotnull","title":"ifNotNull","text":"[jvm]\\ inline fun <ANY> ANY?.ifNotNull(condition: (any: ANY) -> Condition): Condition
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-instant/","title":"toInstant - Misk","text":"//misk-jooq/misk.jooq/toInstant
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-instant/#toinstant","title":"toInstant","text":"[jvm]\\ fun LocalDateTime.toInstant(): Instant
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-local-date-time/","title":"toLocalDateTime - Misk","text":"//misk-jooq/misk.jooq/toLocalDateTime
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/to-local-date-time/#tolocaldatetime","title":"toLocalDateTime","text":"[jvm]\\ fun Instant.toLocalDateTime(): LocalDateTime
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/","title":"IsolationLevelAwareConnectionProvider - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/#isolationlevelawareconnectionprovider","title":"IsolationLevelAwareConnectionProvider","text":"[jvm]\\ class IsolationLevelAwareConnectionProvider(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions) : ConnectionProvider
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/#constructors","title":"Constructors","text":"IsolationLevelAwareConnectionProvider [jvm]constructor(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): Connection release [jvm]open override fun release(connection: Connection)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/-isolation-level-aware-connection-provider/","title":"IsolationLevelAwareConnectionProvider - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider/IsolationLevelAwareConnectionProvider
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/-isolation-level-aware-connection-provider/#isolationlevelawareconnectionprovider","title":"IsolationLevelAwareConnectionProvider","text":"[jvm]\\ constructor(dataSourceConnectionProvider: DataSourceConnectionProvider, transacterOptions: JooqTransacter.TransacterOptions)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/acquire/","title":"acquire - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider/acquire
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Connection
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/release/","title":"release - Misk","text":"//misk-jooq/misk.jooq/IsolationLevelAwareConnectionProvider/release
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-isolation-level-aware-connection-provider/release/#release","title":"release","text":"[jvm]\\ open override fun release(connection: Connection)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/","title":"JooqHealthCheck - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#jooqhealthcheck","title":"JooqHealthCheck","text":"[jvm]\\ class JooqHealthCheck(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock) : HealthCheck
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#constructors","title":"Constructors","text":"JooqHealthCheck [jvm]constructor(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/#functions","title":"Functions","text":"Name Summary status [jvm]open override fun status(): HealthStatus"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-jooq-health-check/","title":"JooqHealthCheck - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/JooqHealthCheck
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-jooq-health-check/#jooqhealthcheck","title":"JooqHealthCheck","text":"[jvm]\\ constructor(qualifier: KClass<out Annotation>, dataSourceProvider: Provider<out Service>, jooqTransacterProvider: Provider<JooqTransacter>, clock: Clock)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/status/","title":"status - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/status
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/status/#status","title":"status","text":"[jvm]\\ open override fun status(): HealthStatus
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/#properties","title":"Properties","text":"Name Summary CLOCK_SKEW_UNHEALTHY_THRESHOLD [jvm]val CLOCK_SKEW_UNHEALTHY_THRESHOLD: Duration CLOCK_SKEW_WARN_THRESHOLD [jvm]val CLOCK_SKEW_WARN_THRESHOLD: Duration log [jvm]val log: KLogger"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-u-n-h-e-a-l-t-h-y_-t-h-r-e-s-h-o-l-d/","title":"CLOCK_SKEW_UNHEALTHY_THRESHOLD - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion/CLOCK_SKEW_UNHEALTHY_THRESHOLD
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-u-n-h-e-a-l-t-h-y_-t-h-r-e-s-h-o-l-d/#clock_skew_unhealthy_threshold","title":"CLOCK_SKEW_UNHEALTHY_THRESHOLD","text":"[jvm]\\ val CLOCK_SKEW_UNHEALTHY_THRESHOLD: Duration
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-w-a-r-n_-t-h-r-e-s-h-o-l-d/","title":"CLOCK_SKEW_WARN_THRESHOLD - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion/CLOCK_SKEW_WARN_THRESHOLD
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/-c-l-o-c-k_-s-k-e-w_-w-a-r-n_-t-h-r-e-s-h-o-l-d/#clock_skew_warn_threshold","title":"CLOCK_SKEW_WARN_THRESHOLD","text":"[jvm]\\ val CLOCK_SKEW_WARN_THRESHOLD: Duration
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/log/","title":"log - Misk","text":"//misk-jooq/misk.jooq/JooqHealthCheck/Companion/log
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-health-check/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/","title":"JooqModule - Misk","text":"//misk-jooq/misk.jooq/JooqModule
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/#jooqmodule","title":"JooqModule","text":"[jvm]\\ class JooqModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {}) : KAbstractModule
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/#constructors","title":"Constructors","text":"JooqModule [jvm]@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {})"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/-jooq-module/","title":"JooqModule - Misk","text":"//misk-jooq/misk.jooq/JooqModule/JooqModule
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-module/-jooq-module/#jooqmodule","title":"JooqModule","text":"[jvm]\\
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, dataSourceClusterConfig: DataSourceClusterConfig, jooqCodeGenSchemaName: String, databasePool: DatabasePool = RealDatabasePool, readerQualifier: KClass<out Annotation>? = null, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), installHealthChecks: Boolean = true, jooqConfigExtension: Configuration.() -> Unit = {})
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/","title":"JooqSession - Misk","text":"//misk-jooq/misk.jooq/JooqSession
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#jooqsession","title":"JooqSession","text":"[jvm]\\ class JooqSession(val ctx: DSLContext) : Session
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#constructors","title":"Constructors","text":"JooqSession [jvm]constructor(ctx: DSLContext)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#types","title":"Types","text":"Name Summary HookType [jvm]enum HookType : Enum<JooqSession.HookType>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#properties","title":"Properties","text":"Name Summary ctx [jvm]val ctx: DSLContext"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/#functions","title":"Functions","text":"Name Summary add [jvm]fun ConcurrentMap<JooqSession.HookType, List<() -> Unit>>.add(hookType: JooqSession.HookType, work: () -> Unit) component1 [jvm]operator fun component1(): DSLContextAllows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (ctx) -> \u2026 } executePostCommitHooks [jvm]fun executePostCommitHooks() executePreCommitHooks [jvm]fun executePreCommitHooks() executeSessionCloseHooks [jvm]fun executeSessionCloseHooks() onPostCommit [jvm]open override fun onPostCommit(work: () -> Unit) onPreCommit [jvm]open override fun onPreCommit(work: () -> Unit) onSessionClose [jvm]open override fun onSessionClose(work: () -> Unit) useConnection [jvm]open override fun <T> useConnection(work: (Connection) -> T): T"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-jooq-session/","title":"JooqSession - Misk","text":"//misk-jooq/misk.jooq/JooqSession/JooqSession
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-jooq-session/#jooqsession","title":"JooqSession","text":"[jvm]\\ constructor(ctx: DSLContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/add/","title":"add - Misk","text":"//misk-jooq/misk.jooq/JooqSession/add
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/add/#add","title":"add","text":"[jvm]\\ fun ConcurrentMap<JooqSession.HookType, List<() -> Unit>>.add(hookType: JooqSession.HookType, work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/component1/","title":"component1 - Misk","text":"//misk-jooq/misk.jooq/JooqSession/component1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/component1/#component1","title":"component1","text":"[jvm]\\ operator fun component1(): DSLContext
Allows for destructuring the JooqSession and writing simpler code like this transacter.transaction { (ctx) -> \u2026 }
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/ctx/","title":"ctx - Misk","text":"//misk-jooq/misk.jooq/JooqSession/ctx
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/ctx/#ctx","title":"ctx","text":"[jvm]\\ val ctx: DSLContext
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-post-commit-hooks/","title":"executePostCommitHooks - Misk","text":"//misk-jooq/misk.jooq/JooqSession/executePostCommitHooks
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-post-commit-hooks/#executepostcommithooks","title":"executePostCommitHooks","text":"[jvm]\\ fun executePostCommitHooks()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-pre-commit-hooks/","title":"executePreCommitHooks - Misk","text":"//misk-jooq/misk.jooq/JooqSession/executePreCommitHooks
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-pre-commit-hooks/#executeprecommithooks","title":"executePreCommitHooks","text":"[jvm]\\ fun executePreCommitHooks()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-session-close-hooks/","title":"executeSessionCloseHooks - Misk","text":"//misk-jooq/misk.jooq/JooqSession/executeSessionCloseHooks
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/execute-session-close-hooks/#executesessionclosehooks","title":"executeSessionCloseHooks","text":"[jvm]\\ fun executeSessionCloseHooks()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-post-commit/","title":"onPostCommit - Misk","text":"//misk-jooq/misk.jooq/JooqSession/onPostCommit
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-post-commit/#onpostcommit","title":"onPostCommit","text":"[jvm]\\ open override fun onPostCommit(work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-pre-commit/","title":"onPreCommit - Misk","text":"//misk-jooq/misk.jooq/JooqSession/onPreCommit
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-pre-commit/#onprecommit","title":"onPreCommit","text":"[jvm]\\ open override fun onPreCommit(work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-session-close/","title":"onSessionClose - Misk","text":"//misk-jooq/misk.jooq/JooqSession/onSessionClose
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/on-session-close/#onsessionclose","title":"onSessionClose","text":"[jvm]\\ open override fun onSessionClose(work: () -> Unit)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/use-connection/","title":"useConnection - Misk","text":"//misk-jooq/misk.jooq/JooqSession/useConnection
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/use-connection/#useconnection","title":"useConnection","text":"[jvm]\\ open override fun <T> useConnection(work: (Connection) -> T): T
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/","title":"HookType - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#hooktype","title":"HookType","text":"[jvm]\\ enum HookType : Enum<JooqSession.HookType>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#entries","title":"Entries","text":"PRE [jvm]PRE POST [jvm]POST SESSION_CLOSE [jvm]SESSION_CLOSE"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<JooqSession.HookType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): JooqSession.HookTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<JooqSession.HookType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/entries/","title":"entries - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/entries
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<JooqSession.HookType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/value-of/","title":"valueOf - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/valueOf
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): JooqSession.HookType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/values/","title":"values - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/values
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<JooqSession.HookType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-o-s-t/","title":"POST - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/POST
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-o-s-t/#post","title":"POST","text":"[jvm]\\ POST
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-o-s-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-r-e/","title":"PRE - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/PRE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-r-e/#pre","title":"PRE","text":"[jvm]\\ PRE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-p-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/","title":"SESSION_CLOSE - Misk","text":"//misk-jooq/misk.jooq/JooqSession/HookType/SESSION_CLOSE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#session_close","title":"SESSION_CLOSE","text":"[jvm]\\ SESSION_CLOSE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-session/-hook-type/-s-e-s-s-i-o-n_-c-l-o-s-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/","title":"JooqTransacter - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#jooqtransacter","title":"JooqTransacter","text":"[jvm]\\ class JooqTransacter@JvmOverloadsconstructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {})
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#constructors","title":"Constructors","text":"JooqTransacter [jvm]@JvmOverloadsconstructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {})"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion TransacterOptions [jvm]data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val maxRetryDelayMillis: Long = 500, val isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/#functions","title":"Functions","text":"Name Summary transaction [jvm]@JvmOverloadsfun <RETURN_TYPE> transaction(options: JooqTransacter.TransacterOptions = TransacterOptions(), callback: (jooqSession: JooqSession) -> RETURN_TYPE): RETURN_TYPE"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-jooq-transacter/","title":"JooqTransacter - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/JooqTransacter
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-jooq-transacter/#jooqtransacter","title":"JooqTransacter","text":"[jvm]\\
@JvmOverloads
constructor(dataSourceService: DataSourceService, dataSourceConfig: DataSourceConfig, jooqCodeGenSchemaName: String, jooqTimestampRecordListenerOptions: JooqTimestampRecordListenerOptions = JooqTimestampRecordListenerOptions(install = false), clock: Clock, jooqConfigExtension: Configuration.() -> Unit = {})
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/transaction/","title":"transaction - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/transaction
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\
@JvmOverloads
fun <RETURN_TYPE> transaction(options: JooqTransacter.TransacterOptions = TransacterOptions(), callback: (jooqSession: JooqSession) -> RETURN_TYPE): RETURN_TYPE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/#properties","title":"Properties","text":"Name Summary noRetriesOptions [jvm]val noRetriesOptions: JooqTransacter.TransacterOptions"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/no-retries-options/","title":"noRetriesOptions - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/Companion/noRetriesOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-companion/no-retries-options/#noretriesoptions","title":"noRetriesOptions","text":"[jvm]\\ val noRetriesOptions: JooqTransacter.TransacterOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\ data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val maxRetryDelayMillis: Long = 500, val isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/#constructors","title":"Constructors","text":"TransacterOptions [jvm]@JvmOverloadsconstructor(maxAttempts: Int = 3, maxRetryDelayMillis: Long = 500, isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/#properties","title":"Properties","text":"Name Summary isolationLevel [jvm]val isolationLevel: TransactionIsolationLevel maxAttempts [jvm]val maxAttempts: Int = 3 maxRetryDelayMillis [jvm]val maxRetryDelayMillis: Long = 500"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/TransacterOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\
@JvmOverloads
constructor(maxAttempts: Int = 3, maxRetryDelayMillis: Long = 500, isolationLevel: TransactionIsolationLevel = TransactionIsolationLevel.REPEATABLE_READ)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/isolation-level/","title":"isolationLevel - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/isolationLevel
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/isolation-level/#isolationlevel","title":"isolationLevel","text":"[jvm]\\ val isolationLevel: TransactionIsolationLevel
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-attempts/","title":"maxAttempts - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/maxAttempts
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-attempts/#maxattempts","title":"maxAttempts","text":"[jvm]\\ val maxAttempts: Int = 3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-retry-delay-millis/","title":"maxRetryDelayMillis - Misk","text":"//misk-jooq/misk.jooq/JooqTransacter/TransacterOptions/maxRetryDelayMillis
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-jooq-transacter/-transacter-options/max-retry-delay-millis/#maxretrydelaymillis","title":"maxRetryDelayMillis","text":"[jvm]\\ val maxRetryDelayMillis: Long = 500
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/","title":"TransactionIsolationLevel - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#transactionisolationlevel","title":"TransactionIsolationLevel","text":"[jvm]\\ enum TransactionIsolationLevel : Enum<TransactionIsolationLevel>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#entries","title":"Entries","text":"READ_UNCOMMITTED [jvm]READ_UNCOMMITTED READ_COMMITTED [jvm]READ_COMMITTED REPEATABLE_READ [jvm]REPEATABLE_READ SERIALIZABLE [jvm]SERIALIZABLE"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<TransactionIsolationLevel>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): TransactionIsolationLevelReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<TransactionIsolationLevel>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/entries/","title":"entries - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/entries
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<TransactionIsolationLevel>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value-of/","title":"valueOf - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/valueOf
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): TransactionIsolationLevel
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value/","title":"value - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/value
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/value/#value","title":"value","text":"[jvm]\\ val value: Int
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/values/","title":"values - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/values
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<TransactionIsolationLevel>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-c-o-m-m-i-t-t-e-d/","title":"READ_COMMITTED - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/READ_COMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-c-o-m-m-i-t-t-e-d/#read_committed","title":"READ_COMMITTED","text":"[jvm]\\ READ_COMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-c-o-m-m-i-t-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-u-n-c-o-m-m-i-t-t-e-d/","title":"READ_UNCOMMITTED - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/READ_UNCOMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-u-n-c-o-m-m-i-t-t-e-d/#read_uncommitted","title":"READ_UNCOMMITTED","text":"[jvm]\\ READ_UNCOMMITTED
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-a-d_-u-n-c-o-m-m-i-t-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-p-e-a-t-a-b-l-e_-r-e-a-d/","title":"REPEATABLE_READ - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/REPEATABLE_READ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-p-e-a-t-a-b-l-e_-r-e-a-d/#repeatable_read","title":"REPEATABLE_READ","text":"[jvm]\\ REPEATABLE_READ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-r-e-p-e-a-t-a-b-l-e_-r-e-a-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-s-e-r-i-a-l-i-z-a-b-l-e/","title":"SERIALIZABLE - Misk","text":"//misk-jooq/misk.jooq/TransactionIsolationLevel/SERIALIZABLE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-s-e-r-i-a-l-i-z-a-b-l-e/#serializable","title":"SERIALIZABLE","text":"[jvm]\\ SERIALIZABLE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq/-transaction-isolation-level/-s-e-r-i-a-l-i-z-a-b-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int value [jvm]val value: Int"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.listeners
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/#types","title":"Types","text":"Name Summary AvoidUsingSelectStarException [jvm]class AvoidUsingSelectStarException(message: String) : RuntimeException AvoidUsingSelectStarListener [jvm]class AvoidUsingSelectStarListener : DefaultExecuteListener JooqSQLLogger [jvm]class JooqSQLLogger : DefaultExecuteListener JooqTimestampRecordListener [jvm]class JooqTimestampRecordListener(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String) : DefaultRecordListenerA Record Listener that will automatically set the current timestamp for the createdAtColumnName during insertions. And the current timestamp to the updatedAtColumnName while updating a row JooqTimestampRecordListenerOptions [jvm]data class JooqTimestampRecordListenerOptions@JvmOverloadsconstructor(val install: Boolean, val createdAtColumnName: String = \"\", val updatedAtColumnName: String = \"\")Use this class to configure the installation of the misk.jooq.listeners.JooqTimestampRecordListener You can use both or configure just one of the createdAtColumnName to be set to the current timestamp when inserting or updating it. If you leave the one you don\u2019t want set as an empty string the JooqTimestampRecordListener will ignore it."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/","title":"AvoidUsingSelectStarException - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarException
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#avoidusingselectstarexception","title":"AvoidUsingSelectStarException","text":"[jvm]\\ class AvoidUsingSelectStarException(message: String) : RuntimeException
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#constructors","title":"Constructors","text":"AvoidUsingSelectStarException [jvm]constructor(message: String)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/-avoid-using-select-star-exception/","title":"AvoidUsingSelectStarException - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarException/AvoidUsingSelectStarException
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-exception/-avoid-using-select-star-exception/#avoidusingselectstarexception","title":"AvoidUsingSelectStarException","text":"[jvm]\\ constructor(message: String)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/","title":"AvoidUsingSelectStarListener - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#avoidusingselectstarlistener","title":"AvoidUsingSelectStarListener","text":"[jvm]\\ class AvoidUsingSelectStarListener : DefaultExecuteListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#constructors","title":"Constructors","text":"AvoidUsingSelectStarListener [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/#functions","title":"Functions","text":"Name Summary bindEnd [jvm]open fun bindEnd(p0: ExecuteContext) bindStart [jvm]open fun bindStart(p0: ExecuteContext) end [jvm]open fun end(p0: ExecuteContext) exception [jvm]open fun exception(p0: ExecuteContext) executeEnd [jvm]open fun executeEnd(p0: ExecuteContext) executeStart [jvm]open fun executeStart(p0: ExecuteContext) fetchEnd [jvm]open fun fetchEnd(p0: ExecuteContext) fetchStart [jvm]open fun fetchStart(p0: ExecuteContext) outEnd [jvm]open fun outEnd(p0: ExecuteContext) outStart [jvm]open fun outStart(p0: ExecuteContext) prepareEnd [jvm]open fun prepareEnd(p0: ExecuteContext) prepareStart [jvm]open fun prepareStart(p0: ExecuteContext) recordEnd [jvm]open fun recordEnd(p0: ExecuteContext) recordStart [jvm]open fun recordStart(p0: ExecuteContext) renderEnd [jvm]open override fun renderEnd(ctx: ExecuteContext?)This catches any query that has a select * from or select table.* from. We don\u2019t want to use any query that uses a select * in it, as jooq has a hard time converting the result set into a jooq table record. It captures the result set via indexes and not the column names. If you try to fetch the result set into a jooq record, jooq will expect the order in which the columns are returned in the query matches the order of in which the columns are declared in the jooq generated code. I suppose it does ResultSet.get(0), ResulSet.get(1) instead of doing ResultSet.get(<column name) renderStart [jvm]open fun renderStart(p0: ExecuteContext) resultEnd [jvm]open fun resultEnd(p0: ExecuteContext) resultStart [jvm]open fun resultStart(p0: ExecuteContext) start [jvm]open fun start(p0: ExecuteContext) warning [jvm]open fun warning(p0: ExecuteContext)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-avoid-using-select-star-listener/","title":"AvoidUsingSelectStarListener - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/AvoidUsingSelectStarListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-avoid-using-select-star-listener/#avoidusingselectstarlistener","title":"AvoidUsingSelectStarListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/render-end/","title":"renderEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/renderEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/render-end/#renderend","title":"renderEnd","text":"[jvm]\\ open override fun renderEnd(ctx: ExecuteContext?)
This catches any query that has a select * from or select table.* from. We don\u2019t want to use any query that uses a select * in it, as jooq has a hard time converting the result set into a jooq table record. It captures the result set via indexes and not the column names. If you try to fetch the result set into a jooq record, jooq will expect the order in which the columns are returned in the query matches the order of in which the columns are declared in the jooq generated code. I suppose it does ResultSet.get(0), ResulSet.get(1) instead of doing ResultSet.get(<column name)
If the databases in dev, staging and prod don\u2019t all have the same column ordering, then things start to fail.
Either way from a code maintainability point of view it is best to avoid select * from and always specify the columns you need. If you need all the columns in a table 2 ways of doing that in jooq
ctx.selectFrom(<table name>)...\nIf you are joining multiple tables and need the columns of only one table
ctx.select(<jooq gen table>.fields().toList()).from(<table>.innerJoin....)\nDO NOT DO THIS:
ctx.select(<jooq gen table>.asterisk()).from(<table>)...\nThis listener\u2019s purpose is to catch the above and prevent it from happening.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/#properties","title":"Properties","text":"Name Summary selectStarFromRegex [jvm]val selectStarFromRegex: Regex"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/select-star-from-regex/","title":"selectStarFromRegex - Misk","text":"//misk-jooq/misk.jooq.listeners/AvoidUsingSelectStarListener/Companion/selectStarFromRegex
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-avoid-using-select-star-listener/-companion/select-star-from-regex/#selectstarfromregex","title":"selectStarFromRegex","text":"[jvm]\\ val selectStarFromRegex: Regex
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/","title":"JooqSQLLogger - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#jooqsqllogger","title":"JooqSQLLogger","text":"[jvm]\\ class JooqSQLLogger : DefaultExecuteListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#constructors","title":"Constructors","text":"JooqSQLLogger [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/#functions","title":"Functions","text":"Name Summary bindEnd [jvm]open fun bindEnd(p0: ExecuteContext) bindStart [jvm]open fun bindStart(p0: ExecuteContext) end [jvm]open fun end(p0: ExecuteContext) exception [jvm]open override fun exception(ctx: ExecuteContext) executeEnd [jvm]open override fun executeEnd(ctx: ExecuteContext) executeStart [jvm]open fun executeStart(p0: ExecuteContext) fetchEnd [jvm]open fun fetchEnd(p0: ExecuteContext) fetchStart [jvm]open fun fetchStart(p0: ExecuteContext) outEnd [jvm]open override fun outEnd(ctx: ExecuteContext) outStart [jvm]open fun outStart(p0: ExecuteContext) prepareEnd [jvm]open fun prepareEnd(p0: ExecuteContext) prepareStart [jvm]open fun prepareStart(p0: ExecuteContext) recordEnd [jvm]open override fun recordEnd(ctx: ExecuteContext) recordStart [jvm]open fun recordStart(p0: ExecuteContext) renderEnd [jvm]open override fun renderEnd(ctx: ExecuteContext) renderStart [jvm]open fun renderStart(p0: ExecuteContext) resultEnd [jvm]open override fun resultEnd(ctx: ExecuteContext) resultStart [jvm]open fun resultStart(p0: ExecuteContext) start [jvm]open fun start(p0: ExecuteContext) warning [jvm]open fun warning(p0: ExecuteContext)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-jooq-s-q-l-logger/","title":"JooqSQLLogger - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/JooqSQLLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-jooq-s-q-l-logger/#jooqsqllogger","title":"JooqSQLLogger","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/exception/","title":"exception - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/exception
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/exception/#exception","title":"exception","text":"[jvm]\\ open override fun exception(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/execute-end/","title":"executeEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/executeEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/execute-end/#executeend","title":"executeEnd","text":"[jvm]\\ open override fun executeEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/out-end/","title":"outEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/outEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/out-end/#outend","title":"outEnd","text":"[jvm]\\ open override fun outEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/record-end/","title":"recordEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/recordEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/record-end/#recordend","title":"recordEnd","text":"[jvm]\\ open override fun recordEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/render-end/","title":"renderEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/renderEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/render-end/#renderend","title":"renderEnd","text":"[jvm]\\ open override fun renderEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/result-end/","title":"resultEnd - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/resultEnd
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/result-end/#resultend","title":"resultEnd","text":"[jvm]\\ open override fun resultEnd(ctx: ExecuteContext)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/#properties","title":"Properties","text":"Name Summary log [jvm]val log: KLogger"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/log/","title":"log - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqSQLLogger/Companion/log
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-s-q-l-logger/-companion/log/#log","title":"log","text":"[jvm]\\ val log: KLogger
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/","title":"JooqTimestampRecordListener - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/#jooqtimestamprecordlistener","title":"JooqTimestampRecordListener","text":"[jvm]\\ class JooqTimestampRecordListener(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String) : DefaultRecordListener
A Record Listener that will automatically set the current timestamp for the createdAtColumnName during insertions. And the current timestamp to the updatedAtColumnName while updating a row
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/#constructors","title":"Constructors","text":"JooqTimestampRecordListener [jvm]constructor(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/#functions","title":"Functions","text":"Name Summary deleteEnd [jvm]open fun deleteEnd(p0: RecordContext) deleteStart [jvm]open fun deleteStart(p0: RecordContext) exception [jvm]open fun exception(p0: RecordContext) insertEnd [jvm]open fun insertEnd(p0: RecordContext) insertStart [jvm]open override fun insertStart(ctx: RecordContext?) loadEnd [jvm]open fun loadEnd(p0: RecordContext) loadStart [jvm]open fun loadStart(p0: RecordContext) mergeEnd [jvm]open fun mergeEnd(p0: RecordContext) mergeStart [jvm]open fun mergeStart(p0: RecordContext) refreshEnd [jvm]open fun refreshEnd(p0: RecordContext) refreshStart [jvm]open fun refreshStart(p0: RecordContext) storeEnd [jvm]open fun storeEnd(p0: RecordContext) storeStart [jvm]open fun storeStart(p0: RecordContext) updateEnd [jvm]open fun updateEnd(p0: RecordContext) updateStart [jvm]open override fun updateStart(ctx: RecordContext?)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/-jooq-timestamp-record-listener/","title":"JooqTimestampRecordListener - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener/JooqTimestampRecordListener
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/-jooq-timestamp-record-listener/#jooqtimestamprecordlistener","title":"JooqTimestampRecordListener","text":"[jvm]\\ constructor(clock: Clock, createdAtColumnName: String, updatedAtColumnName: String)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/insert-start/","title":"insertStart - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener/insertStart
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/insert-start/#insertstart","title":"insertStart","text":"[jvm]\\ open override fun insertStart(ctx: RecordContext?)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/update-start/","title":"updateStart - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListener/updateStart
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener/update-start/#updatestart","title":"updateStart","text":"[jvm]\\ open override fun updateStart(ctx: RecordContext?)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/","title":"JooqTimestampRecordListenerOptions - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/#jooqtimestamprecordlisteneroptions","title":"JooqTimestampRecordListenerOptions","text":"[jvm]\\ data class JooqTimestampRecordListenerOptions@JvmOverloadsconstructor(val install: Boolean, val createdAtColumnName: String = \"\", val updatedAtColumnName: String = \"\")
Use this class to configure the installation of the misk.jooq.listeners.JooqTimestampRecordListener You can use both or configure just one of the createdAtColumnName to be set to the current timestamp when inserting or updating it. If you leave the one you don\u2019t want set as an empty string the JooqTimestampRecordListener will ignore it.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/#constructors","title":"Constructors","text":"JooqTimestampRecordListenerOptions [jvm]@JvmOverloadsconstructor(install: Boolean, createdAtColumnName: String = \"\", updatedAtColumnName: String = \"\")"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/#properties","title":"Properties","text":"Name Summary createdAtColumnName [jvm]val createdAtColumnName: String install [jvm]val install: Boolean updatedAtColumnName [jvm]val updatedAtColumnName: String"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/-jooq-timestamp-record-listener-options/","title":"JooqTimestampRecordListenerOptions - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/JooqTimestampRecordListenerOptions
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/-jooq-timestamp-record-listener-options/#jooqtimestamprecordlisteneroptions","title":"JooqTimestampRecordListenerOptions","text":"[jvm]\\
@JvmOverloads
constructor(install: Boolean, createdAtColumnName: String = \"\", updatedAtColumnName: String = \"\")
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/created-at-column-name/","title":"createdAtColumnName - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/createdAtColumnName
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/created-at-column-name/#createdatcolumnname","title":"createdAtColumnName","text":"[jvm]\\ val createdAtColumnName: String
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/install/","title":"install - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/install
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/install/#install","title":"install","text":"[jvm]\\ val install: Boolean
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/updated-at-column-name/","title":"updatedAtColumnName - Misk","text":"//misk-jooq/misk.jooq.listeners/JooqTimestampRecordListenerOptions/updatedAtColumnName
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.listeners/-jooq-timestamp-record-listener-options/updated-at-column-name/#updatedatcolumnname","title":"updatedAtColumnName","text":"[jvm]\\ val updatedAtColumnName: String
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.testgen
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/#types","title":"Types","text":"Name Summary DefaultCatalog [jvm]open class DefaultCatalog : CatalogImplThis class is generated by jOOQ. Jooq [jvm]open class Jooq : SchemaImplThis class is generated by jOOQ."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/","title":"DefaultCatalog - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#defaultcatalog","title":"DefaultCatalog","text":"[jvm]\\ open class DefaultCatalog : CatalogImpl
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#constructors","title":"Constructors","text":"DefaultCatalog [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#properties","title":"Properties","text":"Name Summary JOOQ [jvm]val JOOQ: JooqThe schemajooq."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/#functions","title":"Functions","text":"Name Summary $name [jvm]override fun $name(): Name accept [jvm]override fun accept(p0: Context<*>) clauses [jvm]override fun clauses(p0: Context<*>): Array<Clause> declaresCTE [jvm]open override fun declaresCTE(): Boolean declaresFields [jvm]open override fun declaresFields(): Boolean declaresTables [jvm]open override fun declaresTables(): Boolean declaresWindows [jvm]open override fun declaresWindows(): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean generatesCast [jvm]open override fun generatesCast(): Boolean getComment [jvm]override fun getComment(): String getCommentPart [jvm]override fun getCommentPart(): Comment getName [jvm]override fun getName(): String getQualifiedName [jvm]open override fun getQualifiedName(): Name getSchema [jvm]override fun getSchema(p0: String): Schema?override fun getSchema(p0: Name): Schema? getSchemas [jvm]open override fun getSchemas(): List<Schema> getUnqualifiedName [jvm]override fun getUnqualifiedName(): Name hashCode [jvm]open override fun hashCode(): Int rendersContent [jvm]open override fun rendersContent(p0: Context<*>): Boolean schemaStream [jvm]override fun schemaStream(): Stream<Schema> toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-default-catalog/","title":"DefaultCatalog - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/DefaultCatalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-default-catalog/#defaultcatalog","title":"DefaultCatalog","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-j-o-o-q/","title":"JOOQ - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/JOOQ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-j-o-o-q/#jooq","title":"JOOQ","text":"[jvm]\\ val JOOQ: Jooq
The schema jooq.
//misk-jooq/misk.jooq.testgen/DefaultCatalog/getSchemas
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/get-schemas/#getschemas","title":"getSchemas","text":"[jvm]\\ open override fun getSchemas(): List<Schema>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT_CATALOG [jvm]val DEFAULT_CATALOG: DefaultCatalogThe reference instance ofDEFAULT_CATALOG"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/-d-e-f-a-u-l-t_-c-a-t-a-l-o-g/","title":"DEFAULT_CATALOG - Misk","text":"//misk-jooq/misk.jooq.testgen/DefaultCatalog/Companion/DEFAULT_CATALOG
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-default-catalog/-companion/-d-e-f-a-u-l-t_-c-a-t-a-l-o-g/#default_catalog","title":"DEFAULT_CATALOG","text":"[jvm]\\ val DEFAULT_CATALOG: DefaultCatalog
The reference instance of DEFAULT_CATALOG
//misk-jooq/misk.jooq.testgen/Jooq
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#jooq","title":"Jooq","text":"[jvm]\\ open class Jooq : SchemaImpl
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#constructors","title":"Constructors","text":"Jooq [jvm]constructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#properties","title":"Properties","text":"Name Summary MOVIE [jvm]val MOVIE: MovieThe tablejooq.movie."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/#functions","title":"Functions","text":"Name Summary $name [jvm]override fun $name(): Name accept [jvm]override fun accept(p0: Context<*>) clauses [jvm]override fun clauses(p0: Context<*>): Array<Clause> declaresCTE [jvm]open override fun declaresCTE(): Boolean declaresFields [jvm]open override fun declaresFields(): Boolean declaresTables [jvm]open override fun declaresTables(): Boolean declaresWindows [jvm]open override fun declaresWindows(): Boolean domainStream [jvm]override fun domainStream(): Stream<Domain<*>> equals [jvm]open operator override fun equals(other: Any?): Boolean foreignKeyStream [jvm]override fun foreignKeyStream(): Stream<ForeignKey<*, *>> generatesCast [jvm]open override fun generatesCast(): Boolean getCatalog [jvm]open override fun getCatalog(): Catalog getComment [jvm]override fun getComment(): String getCommentPart [jvm]override fun getCommentPart(): Comment getDomain [jvm]override fun getDomain(p0: String): Domain<>?override fun getDomain(p0: Name): Domain<>? getDomains [jvm]open override fun getDomains(): MutableList<Domain<*>> getForeignKeys [jvm]open override fun getForeignKeys(): MutableList<ForeignKey<, *>>override fun getForeignKeys(p0: String): MutableList<ForeignKey<, >>override fun getForeignKeys(p0: Name): MutableList<ForeignKey<, *>> getIndexes [jvm]open override fun getIndexes(): MutableList<Index>override fun getIndexes(p0: String): MutableList<Index>override fun getIndexes(p0: Name): MutableList<Index> getName [jvm]override fun getName(): String getPrimaryKeys [jvm]open override fun getPrimaryKeys(): MutableList<UniqueKey<>>override fun getPrimaryKeys(p0: String): MutableList<UniqueKey<>>override fun getPrimaryKeys(p0: Name): MutableList<UniqueKey<*>> getQualifiedName [jvm]open override fun getQualifiedName(): Name getSequence [jvm]override fun getSequence(p0: String): Sequence<>?override fun getSequence(p0: Name): Sequence<>? getSequences [jvm]open override fun getSequences(): MutableList<Sequence<*>> getTable [jvm]override fun getTable(p0: String): Table<>?override fun getTable(p0: Name): Table<>? getTables [jvm]open override fun getTables(): List<Table<*>> getUDT [jvm]override fun getUDT(p0: String): UDT<>?override fun getUDT(p0: Name): UDT<>? getUDTs [jvm]open override fun getUDTs(): MutableList<UDT<*>> getUniqueKeys [jvm]open override fun getUniqueKeys(): MutableList<UniqueKey<>>override fun getUniqueKeys(p0: String): MutableList<UniqueKey<>>override fun getUniqueKeys(p0: Name): MutableList<UniqueKey<*>> getUnqualifiedName [jvm]override fun getUnqualifiedName(): Name hashCode [jvm]open override fun hashCode(): Int indexStream [jvm]override fun indexStream(): Stream<Index> primaryKeyStream [jvm]override fun primaryKeyStream(): Stream<UniqueKey<*>> rendersContent [jvm]open override fun rendersContent(p0: Context<*>): Boolean sequenceStream [jvm]override fun sequenceStream(): Stream<Sequence<*>> tableStream [jvm]override fun tableStream(): Stream<Table<*>> toString [jvm]open override fun toString(): String udtStream [jvm]override fun udtStream(): Stream<UDT<*>> uniqueKeyStream [jvm]override fun uniqueKeyStream(): Stream<UniqueKey<*>>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-jooq/","title":"Jooq - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/Jooq
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-jooq/#jooq","title":"Jooq","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-m-o-v-i-e/","title":"MOVIE - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/MOVIE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-m-o-v-i-e/#movie","title":"MOVIE","text":"[jvm]\\ val MOVIE: Movie
The table jooq.movie.
//misk-jooq/misk.jooq.testgen/Jooq/getCatalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/get-catalog/#getcatalog","title":"getCatalog","text":"[jvm]\\ open override fun getCatalog(): Catalog
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/get-tables/","title":"getTables - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/getTables
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/get-tables/#gettables","title":"getTables","text":"[jvm]\\ open override fun getTables(): List<Table<*>>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/#properties","title":"Properties","text":"Name Summary JOOQ [jvm]val JOOQ: JooqThe reference instance ofjooq"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/-j-o-o-q/","title":"JOOQ - Misk","text":"//misk-jooq/misk.jooq.testgen/Jooq/Companion/JOOQ
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen/-jooq/-companion/-j-o-o-q/#jooq","title":"JOOQ","text":"[jvm]\\ val JOOQ: Jooq
The reference instance of jooq
//misk-jooq/misk.jooq.testgen.keys
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/#properties","title":"Properties","text":"Name Summary KEY_MOVIE_PRIMARY [jvm]val KEY_MOVIE_PRIMARY: UniqueKey<MovieRecord>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/-k-e-y_-m-o-v-i-e_-p-r-i-m-a-r-y/","title":"KEY_MOVIE_PRIMARY - Misk","text":"//misk-jooq/misk.jooq.testgen.keys/KEY_MOVIE_PRIMARY
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.keys/-k-e-y_-m-o-v-i-e_-p-r-i-m-a-r-y/#key_movie_primary","title":"KEY_MOVIE_PRIMARY","text":"[jvm]\\ val KEY_MOVIE_PRIMARY: UniqueKey<MovieRecord>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.testgen.tables
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/#types","title":"Types","text":"Name Summary Movie [jvm]open class Movie(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?) : TableImpl<MovieRecord> This class is generated by jOOQ."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/","title":"Movie - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#movie","title":"Movie","text":"[jvm]\\ open class Movie(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?) : TableImpl<MovieRecord>
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#constructors","title":"Constructors","text":"Movie [jvm]constructor(alias: String)Create an aliasedjooq.movie table referenceconstructor(alias: Name)Create an aliased jooq.movie table referenceconstructor()Create a jooq.movie table referenceconstructor(child: Table<out Record>, key: ForeignKey<out Record, MovieRecord>)constructor(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#properties","title":"Properties","text":"Name Summary CREATED_AT [jvm]val CREATED_AT: TableField<MovieRecord, LocalDateTime?>The column jooq.movie.created_at. GENRE [jvm]val GENRE: TableField<MovieRecord, String?>The column jooq.movie.genre. ID [jvm]val ID: TableField<MovieRecord, Long?>The column jooq.movie.id. NAME [jvm]val NAME: TableField<MovieRecord, String?>The column jooq.movie.name. UPDATED_AT [jvm]val UPDATED_AT: TableField<MovieRecord, LocalDateTime?>The column jooq.movie.updated_at. VERSION [jvm]val VERSION: TableField<MovieRecord, Int?>The column jooq.movie.version."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/#functions","title":"Functions","text":"Name Summary $alias [jvm]open override fun $alias(): Name? $aliased [jvm]open override fun $aliased(): Table<MovieRecord> $dataType [jvm]override fun $dataType(): DataType<MovieRecord> $name [jvm]override fun $name(): Name $schema [jvm]override fun $schema(): Schema? accept [jvm]override fun accept(p0: Context<*>) as [jvm]open override fun as(alias: String): Movieopen override fun as(alias: Name): Movieoverride fun as(p0: Field<>): SelectField<MovieRecord>open override fun as(p0: Table<>): Table<MovieRecord>override fun as(p0: String, p1: BiFunction<in Field<>, in Int, out String>): Table<MovieRecord>override fun as(p0: String, p1: Function<in Field<>, out String>): Table<MovieRecord>override fun as(p0: String, vararg p1: String): Table<MovieRecord>override fun as(p0: String, p1: MutableCollection<out String>): Table<MovieRecord>override fun as(p0: Name, p1: BiFunction<in Field<>, in Int, out Name>): Table<MovieRecord>override fun as(p0: Name, p1: Function<in Field<>, out Name>): Table<MovieRecord>override fun as(p0: Name, p1: MutableCollection<out Name>): Table<MovieRecord>override fun as(p0: Table<>, p1: BiFunction<in Field<>, in Int, out Field<>>): Table<MovieRecord>override fun as(p0: Table<>, p1: Function<in Field<>, out Field<>>): Table<MovieRecord>override fun as(p0: Table<>, vararg p1: Field<>): Table<MovieRecord>override fun as(p0: Table<>, p1: MutableCollection<out Field<>>): Table<MovieRecord>open override fun as(p0: Name, vararg p1: Name): Table<MovieRecord> asMultiset [jvm]override fun asMultiset(): Field<Result<MovieRecord>>override fun asMultiset(p0: String): Field<Result<MovieRecord>>override fun asMultiset(p0: Field<*>): Field<Result<MovieRecord>>override fun asMultiset(p0: Name): Field<Result<MovieRecord>> asTable [jvm]override fun asTable(): Table<MovieRecord>override fun asTable(p0: String): Table<MovieRecord>override fun asTable(p0: Name): Table<MovieRecord>override fun asTable(p0: Table<>): Table<MovieRecord>override fun asTable(p0: String, p1: BiFunction<in Field<>, in Int, out String>): Table<MovieRecord>override fun asTable(p0: String, p1: Function<in Field<>, out String>): Table<MovieRecord>override fun asTable(p0: String, vararg p1: String): Table<MovieRecord>override fun asTable(p0: String, p1: MutableCollection<out String>): Table<MovieRecord>override fun asTable(p0: Name, vararg p1: Name): Table<MovieRecord>override fun asTable(p0: Name, p1: MutableCollection<out Name>): Table<MovieRecord>override fun asTable(p0: Table<>, vararg p1: Field<>): Table<MovieRecord>override fun asTable(p0: Table<>, p1: MutableCollection<out Field<*>>): Table<MovieRecord> asterisk [jvm]override fun asterisk(): QualifiedAsterisk clauses [jvm]override fun clauses(p0: Context<*>): Array<Clause> convert [jvm]override fun <U : Any> convert(p0: Binding<MovieRecord, U>): SelectField<U>override fun <U : Any> convert(p0: Converter<MovieRecord, U>): SelectField<U>override fun <U : Any> convert(p0: Class<U>, p1: Function<in MovieRecord, out U>, p2: Function<in U, out MovieRecord>): SelectField<U> convertFrom [jvm]override fun <U : Any> convertFrom(p0: Function<in MovieRecord, out U>): SelectField<U>override fun <U : Any> convertFrom(p0: Class<U>, p1: Function<in MovieRecord, out U>): SelectField<U> convertTo [jvm]override fun <U : Any> convertTo(p0: Function<in U, out MovieRecord>): SelectField<U>override fun <U : Any> convertTo(p0: Class<U>, p1: Function<in U, out MovieRecord>): SelectField<U> crossApply [jvm]override fun crossApply(p0: String): Table<Record>override fun crossApply(p0: Name): Table<Record>override fun crossApply(p0: SQL): Table<Record>override fun crossApply(p0: TableLike<*>): Table<Record>override fun crossApply(p0: String, vararg p1: Any): Table<Record>override fun crossApply(p0: String, vararg p1: QueryPart): Table<Record> crossJoin [jvm]override fun crossJoin(p0: String): Table<Record>override fun crossJoin(p0: Name): Table<Record>override fun crossJoin(p0: SQL): Table<Record>override fun crossJoin(p0: TableLike<*>): Table<Record>override fun crossJoin(p0: String, vararg p1: Any): Table<Record>override fun crossJoin(p0: String, vararg p1: QueryPart): Table<Record> dataType [jvm]@Nullableabstract fun dataType(p0: Int): @NullableDataType<>?@Nullableabstract fun dataType(p0: String): @NullableDataType<>?@Nullableabstract fun dataType(p0: Name): @NullableDataType<*>? dataTypes [jvm]@NotNullabstract fun dataTypes(): @NotNullArray<@NotNullDataType<*>> declaresCTE [jvm]open override fun declaresCTE(): Boolean declaresFields [jvm]open override fun declaresFields(): Boolean declaresTables [jvm]open override fun declaresTables(): Boolean declaresWindows [jvm]open override fun declaresWindows(): Boolean divideBy [jvm]override fun divideBy(p0: Table<*>): DivideByOnStep eq [jvm]override fun eq(p0: Table<MovieRecord>): Condition equal [jvm]override fun equal(p0: Table<MovieRecord>): Condition equals [jvm]open operator override fun equals(other: Any?): Boolean field [jvm]@Nullableabstract fun field(p0: Int): @NullableField<>?@Nullableabstract fun <T : Any> field(p0: Field<T>): @NullableField<T>?@Nullableabstract fun <T : Any> field(p0: Int, p1: Class<T>): @NullableField<T>?@Nullableabstract fun <T : Any> field(p0: Int, p1: DataType<T>): @NullableField<T>?open override fun field(p0: String): Field<>?open override fun field(p0: Name): Field<*>?open override fun <T : Any> field(p0: String, p1: Class<T>): Field<T>?open override fun <T : Any> field(p0: String, p1: DataType<T>): Field<T>?open override fun <T : Any> field(p0: Name, p1: Class<T>): Field<T>?open override fun <T : Any> field(p0: Name, p1: DataType<T>): Field<T>? fields [jvm]@Nullableabstract fun fields(vararg p0: String): @NotNullArray<@NullableField<>?>@Nullableabstract fun fields(vararg p0: Field<>): @NotNullArray<@NullableField<>?>@Nullableabstract fun fields(vararg p0: Name): @NotNullArray<@NullableField<>?>@Nullableabstract fun fields(vararg p0: Int): @NotNullArray<@NullableField<>?>override fun fields(): Array<Field<>> fieldsRow [jvm]open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> fieldStream [jvm]@NotNullabstract fun fieldStream(): @NotNullStream<Field<*>> forceIndex [jvm]override fun forceIndex(vararg p0: String): Table<MovieRecord> forceIndexForGroupBy [jvm]override fun forceIndexForGroupBy(vararg p0: String): Table<MovieRecord> forceIndexForJoin [jvm]override fun forceIndexForJoin(vararg p0: String): Table<MovieRecord> forceIndexForOrderBy [jvm]override fun forceIndexForOrderBy(vararg p0: String): Table<MovieRecord> from [jvm]override fun from(p0: Record): MovieRecord fullJoin [jvm]override fun fullJoin(p0: String): TablePartitionByStep<Record>override fun fullJoin(p0: Name): TablePartitionByStep<Record>override fun fullJoin(p0: SQL): TablePartitionByStep<Record>override fun fullJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun fullJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun fullJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> fullOuterJoin [jvm]override fun fullOuterJoin(p0: String): TablePartitionByStep<Record>override fun fullOuterJoin(p0: Name): TablePartitionByStep<Record>override fun fullOuterJoin(p0: SQL): TablePartitionByStep<Record>override fun fullOuterJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun fullOuterJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun fullOuterJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> generatesCast [jvm]open override fun generatesCast(): Boolean getBinding [jvm]override fun getBinding(): Binding<*, MovieRecord> getCatalog [jvm]override fun getCatalog(): Catalog? getChecks [jvm]open override fun getChecks(): MutableList<Check<MovieRecord>> getComment [jvm]override fun getComment(): String getCommentPart [jvm]override fun getCommentPart(): Comment getConverter [jvm]override fun getConverter(): ContextConverter<*, MovieRecord> getDataType [jvm]override fun getDataType(): DataType<MovieRecord>override fun getDataType(p0: Configuration): DataType<MovieRecord> getIdentity [jvm]open override fun getIdentity(): Identity<MovieRecord, Long?> getIndexes [jvm]open override fun getIndexes(): MutableList<Index> getKeys [jvm]open override fun getKeys(): List<UniqueKey<MovieRecord>> getName [jvm]override fun getName(): String getOptions [jvm]override fun getOptions(): TableOptions getPackage [jvm]override fun getPackage(): Package? getPrimaryKey [jvm]open override fun getPrimaryKey(): UniqueKey<MovieRecord> getQualifiedName [jvm]open override fun getQualifiedName(): Name getRecordTimestamp [jvm]open override fun getRecordTimestamp(): TableField<MovieRecord, *>? getRecordType [jvm]open override fun getRecordType(): Class<MovieRecord>The class holding records for this type getRecordVersion [jvm]open override fun getRecordVersion(): TableField<MovieRecord, Int?> getReferences [jvm]open override fun getReferences(): MutableList<ForeignKey<MovieRecord, *>> getReferencesFrom [jvm]override fun <O : Record> getReferencesFrom(p0: Table<O>): MutableList<ForeignKey<O, MovieRecord>> getReferencesTo [jvm]override fun <O : Record> getReferencesTo(p0: Table<O>): MutableList<ForeignKey<MovieRecord, O>> getSchema [jvm]open override fun getSchema(): Schema getTableType [jvm]override fun getTableType(): TableOptions.TableType getType [jvm]override fun getType(): Class<MovieRecord> getUniqueKeys [jvm]open override fun getUniqueKeys(): MutableList<UniqueKey<MovieRecord>> getUnqualifiedName [jvm]override fun getUnqualifiedName(): Name hashCode [jvm]open override fun hashCode(): Int ignoreIndex [jvm]override fun ignoreIndex(vararg p0: String): Table<MovieRecord> ignoreIndexForGroupBy [jvm]override fun ignoreIndexForGroupBy(vararg p0: String): Table<MovieRecord> ignoreIndexForJoin [jvm]override fun ignoreIndexForJoin(vararg p0: String): Table<MovieRecord> ignoreIndexForOrderBy [jvm]override fun ignoreIndexForOrderBy(vararg p0: String): Table<MovieRecord> indexOf [jvm]abstract fun indexOf(p0: String): Intabstract fun indexOf(p0: Field<*>): Intabstract fun indexOf(p0: Name): Int innerJoin [jvm]override fun innerJoin(p0: String): TableOnStep<Record>override fun innerJoin(p0: Name): TableOnStep<Record>override fun innerJoin(p0: SQL): TableOnStep<Record>override fun innerJoin(p0: TableLike<*>): TableOnStep<Record>override fun innerJoin(p0: String, vararg p1: Any): TableOnStep<Record>override fun innerJoin(p0: String, vararg p1: QueryPart): TableOnStep<Record> isSimple [jvm]@Internaloverride fun isSimple(p0: Context<*>): Boolean join [jvm]override fun join(p0: String): TableOnStep<Record>override fun join(p0: Name): TableOnStep<Record>override fun join(p0: SQL): TableOnStep<Record>override fun join(p0: TableLike<>): TableOnStep<Record>override fun join(p0: String, vararg p1: Any): TableOnStep<Record>override fun join(p0: String, vararg p1: QueryPart): TableOnStep<Record>override fun join(p0: TableLike<>, p1: JoinType): JoinTable<*> leftAntiJoin [jvm]override fun leftAntiJoin(p0: TableLike<*>): TableOnStep<MovieRecord> leftJoin [jvm]override fun leftJoin(p0: String): TablePartitionByStep<Record>override fun leftJoin(p0: Name): TablePartitionByStep<Record>override fun leftJoin(p0: SQL): TablePartitionByStep<Record>override fun leftJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun leftJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun leftJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> leftOuterJoin [jvm]override fun leftOuterJoin(p0: String): TablePartitionByStep<Record>override fun leftOuterJoin(p0: Name): TablePartitionByStep<Record>override fun leftOuterJoin(p0: SQL): TablePartitionByStep<Record>override fun leftOuterJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun leftOuterJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun leftOuterJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> leftSemiJoin [jvm]override fun leftSemiJoin(p0: TableLike<*>): TableOnStep<MovieRecord> naturalFullOuterJoin [jvm]override fun naturalFullOuterJoin(p0: String): Table<Record>override fun naturalFullOuterJoin(p0: Name): Table<Record>override fun naturalFullOuterJoin(p0: SQL): Table<Record>override fun naturalFullOuterJoin(p0: TableLike<*>): Table<Record>override fun naturalFullOuterJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalFullOuterJoin(p0: String, vararg p1: QueryPart): Table<Record> naturalJoin [jvm]override fun naturalJoin(p0: String): Table<Record>override fun naturalJoin(p0: Name): Table<Record>override fun naturalJoin(p0: SQL): Table<Record>override fun naturalJoin(p0: TableLike<*>): Table<Record>override fun naturalJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalJoin(p0: String, vararg p1: QueryPart): Table<Record> naturalLeftOuterJoin [jvm]override fun naturalLeftOuterJoin(p0: String): Table<Record>override fun naturalLeftOuterJoin(p0: Name): Table<Record>override fun naturalLeftOuterJoin(p0: SQL): Table<Record>override fun naturalLeftOuterJoin(p0: TableLike<*>): Table<Record>override fun naturalLeftOuterJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalLeftOuterJoin(p0: String, vararg p1: QueryPart): Table<Record> naturalRightOuterJoin [jvm]override fun naturalRightOuterJoin(p0: String): Table<Record>override fun naturalRightOuterJoin(p0: Name): Table<Record>override fun naturalRightOuterJoin(p0: SQL): Table<Record>override fun naturalRightOuterJoin(p0: TableLike<*>): Table<Record>override fun naturalRightOuterJoin(p0: String, vararg p1: Any): Table<Record>override fun naturalRightOuterJoin(p0: String, vararg p1: QueryPart): Table<Record> ne [jvm]override fun ne(p0: Table<MovieRecord>): Condition newRecord [jvm]override fun newRecord(): MovieRecord notEqual [jvm]override fun notEqual(p0: Table<MovieRecord>): Condition outerApply [jvm]override fun outerApply(p0: String): Table<Record>override fun outerApply(p0: Name): Table<Record>override fun outerApply(p0: SQL): Table<Record>override fun outerApply(p0: TableLike<*>): Table<Record>override fun outerApply(p0: String, vararg p1: Any): Table<Record>override fun outerApply(p0: String, vararg p1: QueryPart): Table<Record> recordType [jvm]override fun recordType(): RecordType<MovieRecord> rename [jvm]open override fun rename(name: String): Movieopen override fun rename(name: Name): MovieRename this table[jvm]open fun rename(p0: Table<*>): Table<MovieRecord> rendersContent [jvm]open override fun rendersContent(p0: Context<*>): Boolean rightJoin [jvm]override fun rightJoin(p0: String): TablePartitionByStep<Record>override fun rightJoin(p0: Name): TablePartitionByStep<Record>override fun rightJoin(p0: SQL): TablePartitionByStep<Record>override fun rightJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun rightJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun rightJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> rightOuterJoin [jvm]override fun rightOuterJoin(p0: String): TablePartitionByStep<Record>override fun rightOuterJoin(p0: Name): TablePartitionByStep<Record>override fun rightOuterJoin(p0: SQL): TablePartitionByStep<Record>override fun rightOuterJoin(p0: TableLike<*>): TablePartitionByStep<Record>override fun rightOuterJoin(p0: String, vararg p1: Any): TablePartitionByStep<Record>override fun rightOuterJoin(p0: String, vararg p1: QueryPart): TablePartitionByStep<Record> rowid [jvm]open override fun rowid(): Field<RowId> straightJoin [jvm]override fun straightJoin(p0: String): TableOptionalOnStep<Record>override fun straightJoin(p0: Name): TableOptionalOnStep<Record>override fun straightJoin(p0: SQL): TableOptionalOnStep<Record>override fun straightJoin(p0: TableLike<*>): TableOptionalOnStep<Record>override fun straightJoin(p0: String, vararg p1: Any): TableOptionalOnStep<Record>override fun straightJoin(p0: String, vararg p1: QueryPart): TableOptionalOnStep<Record> toString [jvm]open override fun toString(): String type [jvm]@Nullableabstract fun type(p0: Int): @NullableClass<>?@Nullableabstract fun type(p0: String): @NullableClass<>?@Nullableabstract fun type(p0: Name): @NullableClass<*>? types [jvm]@NotNullabstract fun types(): @NotNullArray<@NotNullClass<*>> useIndex [jvm]override fun useIndex(vararg p0: String): Table<MovieRecord> useIndexForGroupBy [jvm]override fun useIndexForGroupBy(vararg p0: String): Table<MovieRecord> useIndexForJoin [jvm]override fun useIndexForJoin(vararg p0: String): Table<MovieRecord> useIndexForOrderBy [jvm]override fun useIndexForOrderBy(vararg p0: String): Table<MovieRecord> where [jvm]open override fun where(vararg p0: Condition): Table<MovieRecord>open override fun where(p0: String): Table<MovieRecord>open override fun where(p0: MutableCollection<out Condition>): Table<MovieRecord>open override fun where(p0: Condition): Table<MovieRecord>open override fun where(p0: Field<Boolean>): Table<MovieRecord>open override fun where(p0: SQL): Table<MovieRecord>open override fun where(p0: String, vararg p1: Any): Table<MovieRecord>open override fun where(p0: String, vararg p1: QueryPart): Table<MovieRecord> whereExists [jvm]open override fun whereExists(p0: Select<*>): Table<MovieRecord> whereNotExists [jvm]open override fun whereNotExists(p0: Select<*>): Table<MovieRecord> withOrdinality [jvm]override fun withOrdinality(): Table<Record>"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-c-r-e-a-t-e-d_-a-t/","title":"CREATED_AT - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/CREATED_AT
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-c-r-e-a-t-e-d_-a-t/#created_at","title":"CREATED_AT","text":"[jvm]\\ val CREATED_AT: TableField<MovieRecord, LocalDateTime?>
The column jooq.movie.created_at.
//misk-jooq/misk.jooq.testgen.tables/Movie/GENRE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-g-e-n-r-e/#genre","title":"GENRE","text":"[jvm]\\ val GENRE: TableField<MovieRecord, String?>
The column jooq.movie.genre.
//misk-jooq/misk.jooq.testgen.tables/Movie/ID
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-i-d/#id","title":"ID","text":"[jvm]\\ val ID: TableField<MovieRecord, Long?>
The column jooq.movie.id.
//misk-jooq/misk.jooq.testgen.tables/Movie/Movie
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-movie/#movie","title":"Movie","text":"[jvm]\\ constructor(alias: String)
constructor(alias: Name)
Create an aliased jooq.movie table reference
[jvm]\\ constructor()
Create a jooq.movie table reference
[jvm]\\ constructor(child: Table<out Record>, key: ForeignKey<out Record, MovieRecord>)
constructor(alias: Name, child: Table<out Record>?, path: ForeignKey<out Record, MovieRecord>?, aliased: Table<MovieRecord>?, parameters: Array<Field<*>?>?)
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-n-a-m-e/","title":"NAME - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/NAME
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-n-a-m-e/#name","title":"NAME","text":"[jvm]\\ val NAME: TableField<MovieRecord, String?>
The column jooq.movie.name.
//misk-jooq/misk.jooq.testgen.tables/Movie/UPDATED_AT
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-u-p-d-a-t-e-d_-a-t/#updated_at","title":"UPDATED_AT","text":"[jvm]\\ val UPDATED_AT: TableField<MovieRecord, LocalDateTime?>
The column jooq.movie.updated_at.
//misk-jooq/misk.jooq.testgen.tables/Movie/VERSION
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-v-e-r-s-i-o-n/#version","title":"VERSION","text":"[jvm]\\ val VERSION: TableField<MovieRecord, Int?>
The column jooq.movie.version.
//misk-jooq/misk.jooq.testgen.tables/Movie/as
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/as/#as","title":"as","text":"[jvm]\\ open override fun as(alias: String): Movie
open override fun as(alias: Name): Movie
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/fields-row/","title":"fieldsRow - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/fieldsRow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/fields-row/#fieldsrow","title":"fieldsRow","text":"[jvm]\\ open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-identity/","title":"getIdentity - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getIdentity
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-identity/#getidentity","title":"getIdentity","text":"[jvm]\\ open override fun getIdentity(): Identity<MovieRecord, Long?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-keys/","title":"getKeys - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getKeys
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-keys/#getkeys","title":"getKeys","text":"[jvm]\\ open override fun getKeys(): List<UniqueKey<MovieRecord>>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-primary-key/","title":"getPrimaryKey - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getPrimaryKey
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-primary-key/#getprimarykey","title":"getPrimaryKey","text":"[jvm]\\ open override fun getPrimaryKey(): UniqueKey<MovieRecord>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-type/","title":"getRecordType - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getRecordType
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-type/#getrecordtype","title":"getRecordType","text":"[jvm]\\ open override fun getRecordType(): Class<MovieRecord>
The class holding records for this type
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-version/","title":"getRecordVersion - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getRecordVersion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-record-version/#getrecordversion","title":"getRecordVersion","text":"[jvm]\\ open override fun getRecordVersion(): TableField<MovieRecord, Int?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-schema/","title":"getSchema - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/getSchema
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/get-schema/#getschema","title":"getSchema","text":"[jvm]\\ open override fun getSchema(): Schema
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/rename/","title":"rename - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/rename
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/rename/#rename","title":"rename","text":"[jvm]\\ open override fun rename(name: String): Movie
open override fun rename(name: Name): Movie
Rename this table
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/","title":"Companion - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/#properties","title":"Properties","text":"Name Summary MOVIE [jvm]val MOVIE: MovieThe reference instance ofjooq.movie"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/-m-o-v-i-e/","title":"MOVIE - Misk","text":"//misk-jooq/misk.jooq.testgen.tables/Movie/Companion/MOVIE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables/-movie/-companion/-m-o-v-i-e/#movie","title":"MOVIE","text":"[jvm]\\ val MOVIE: Movie
The reference instance of jooq.movie
//misk-jooq/misk.jooq.testgen.tables.records
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/#types","title":"Types","text":"Name Summary MovieRecord [jvm]open class MovieRecord : UpdatableRecordImpl<MovieRecord> , Record6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> This class is generated by jOOQ."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/","title":"MovieRecord - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#movierecord","title":"MovieRecord","text":"[jvm]\\ open class MovieRecord : UpdatableRecordImpl<MovieRecord> , Record6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
This class is generated by jOOQ.
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#constructors","title":"Constructors","text":"MovieRecord [jvm]constructor(id: Long? = null, name: String? = null, genre: String? = null, version: Int? = null, createdAt: LocalDateTime? = null, updatedAt: LocalDateTime? = null)Create a detached, initialised MovieRecordconstructor()"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#properties","title":"Properties","text":"Name Summary createdAt [jvm]var createdAt: LocalDateTime? genre [jvm]var genre: String? id [jvm]var id: Long? name [jvm]var name: String? updatedAt [jvm]var updatedAt: LocalDateTime? version [jvm]var version: Int?"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/#functions","title":"Functions","text":"Name Summary attach [jvm]override fun attach(p0: Configuration) changed [jvm]override fun changed(): Booleanoverride fun changed(p0: Boolean)override fun changed(p0: Int): Booleanoverride fun changed(p0: String): Booleanoverride fun changed(p0: Field<>): Booleanoverride fun changed(p0: Name): Booleanoverride fun changed(p0: Int, p1: Boolean)override fun changed(p0: String, p1: Boolean)override fun changed(p0: Field<>, p1: Boolean)override fun changed(p0: Name, p1: Boolean) children [jvm]override fun <O : TableRecord<O>> children(p0: ForeignKey<O, MovieRecord>): Table<O> compareTo [jvm]open operator override fun compareTo(other: Record): Int component1 [jvm]open operator override fun component1(): Long? component2 [jvm]open operator override fun component2(): String? component3 [jvm]open operator override fun component3(): String? component4 [jvm]open operator override fun component4(): Int? component5 [jvm]open operator override fun component5(): LocalDateTime? component6 [jvm]open operator override fun component6(): LocalDateTime? configuration [jvm]override fun configuration(): Configuration? copy [jvm]override fun copy(): MovieRecord dataType [jvm]override fun dataType(p0: Int): DataType<>?override fun dataType(p0: String): DataType<>?override fun dataType(p0: Name): DataType<*>? dataTypes [jvm]override fun dataTypes(): Array<DataType<*>> delete [jvm]override fun delete(): Int detach [jvm]override fun detach() equals [jvm]open operator override fun equals(other: Any?): Boolean fetchChild [jvm]override fun <O : TableRecord<O>> fetchChild(p0: ForeignKey<O, MovieRecord>): O? fetchChildren [jvm]override fun <O : TableRecord<O>> fetchChildren(p0: ForeignKey<O, MovieRecord>): Result<O> fetchParent [jvm]override fun <O : UpdatableRecord<O>> fetchParent(p0: ForeignKey<MovieRecord, O>): O? field [jvm]override fun field(p0: Int): Field<>?override fun field(p0: String): Field<>?override fun <T : Any> field(p0: Field<T>): Field<T>?override fun field(p0: Name): Field<*>?override fun <T : Any> field(p0: Int, p1: Class<T>): Field<T>?override fun <T : Any> field(p0: Int, p1: DataType<T>): Field<T>?override fun <T : Any> field(p0: String, p1: Class<T>): Field<T>?override fun <T : Any> field(p0: String, p1: DataType<T>): Field<T>?override fun <T : Any> field(p0: Name, p1: Class<T>): Field<T>?override fun <T : Any> field(p0: Name, p1: DataType<T>): Field<T>? field1 [jvm]open override fun field1(): Field<Long?> field2 [jvm]open override fun field2(): Field<String?> field3 [jvm]open override fun field3(): Field<String?> field4 [jvm]open override fun field4(): Field<Int?> field5 [jvm]open override fun field5(): Field<LocalDateTime?> field6 [jvm]open override fun field6(): Field<LocalDateTime?> fields [jvm]override fun fields(): Array<Field<>>override fun fields(vararg p0: String): Array<Field<>?>override fun fields(vararg p0: Field<>): Array<Field<>?>override fun fields(vararg p0: Name): Array<Field<>?>override fun fields(vararg p0: Int): Array<Field<>?> fieldsRow [jvm]open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> fieldStream [jvm]override fun fieldStream(): Stream<Field<*>> format [jvm]override fun format(): Stringoverride fun format(p0: OutputStream)override fun format(p0: Writer)override fun format(p0: Int): Stringoverride fun format(p0: TXTFormat): Stringoverride fun format(p0: OutputStream, p1: Int)override fun format(p0: OutputStream, p1: TXTFormat)override fun format(p0: Writer, p1: Int)override fun format(p0: Writer, p1: TXTFormat) formatChart [jvm]override fun formatChart(): Stringoverride fun formatChart(p0: OutputStream)override fun formatChart(p0: Writer)override fun formatChart(p0: ChartFormat): Stringoverride fun formatChart(p0: OutputStream, p1: ChartFormat)override fun formatChart(p0: Writer, p1: ChartFormat) formatCSV [jvm]override fun formatCSV(): Stringoverride fun formatCSV(p0: OutputStream)override fun formatCSV(p0: Writer)override fun formatCSV(p0: Boolean): Stringoverride fun formatCSV(p0: Char): Stringoverride fun formatCSV(p0: CSVFormat): Stringoverride fun formatCSV(p0: OutputStream, p1: Boolean)override fun formatCSV(p0: OutputStream, p1: Char)override fun formatCSV(p0: OutputStream, p1: CSVFormat)override fun formatCSV(p0: Writer, p1: Boolean)override fun formatCSV(p0: Writer, p1: Char)override fun formatCSV(p0: Boolean, p1: Char): Stringoverride fun formatCSV(p0: Char, p1: String): Stringoverride fun formatCSV(p0: OutputStream, p1: Boolean, p2: Char)override fun formatCSV(p0: OutputStream, p1: Char, p2: String)override fun formatCSV(p0: Writer, p1: Boolean, p2: Char)override fun formatCSV(p0: Writer, p1: Char, p2: String)override fun formatCSV(p0: Boolean, p1: Char, p2: String): Stringoverride fun formatCSV(p0: OutputStream, p1: Boolean, p2: Char, p3: String)override fun formatCSV(p0: Writer, p1: Boolean, p2: Char, p3: String)override fun formatCSV(p0: Writer, p1: CSVFormat) formatHTML [jvm]override fun formatHTML(): Stringoverride fun formatHTML(p0: OutputStream)override fun formatHTML(p0: Writer) formatInsert [jvm]override fun formatInsert(): Stringoverride fun formatInsert(p0: OutputStream)override fun formatInsert(p0: Table<>, vararg p1: Field<>): Stringoverride fun formatInsert(p0: OutputStream, p1: Table<>, vararg p2: Field<>)override fun formatInsert(p0: Writer)override fun formatInsert(p0: Writer, p1: Table<>, vararg p2: Field<>) formatJSON [jvm]override fun formatJSON(): Stringoverride fun formatJSON(p0: OutputStream)override fun formatJSON(p0: Writer)override fun formatJSON(p0: JSONFormat): Stringoverride fun formatJSON(p0: OutputStream, p1: JSONFormat)override fun formatJSON(p0: Writer, p1: JSONFormat) formatXML [jvm]override fun formatXML(): Stringoverride fun formatXML(p0: OutputStream)override fun formatXML(p0: Writer)override fun formatXML(p0: XMLFormat): Stringoverride fun formatXML(p0: OutputStream, p1: XMLFormat)override fun formatXML(p0: Writer, p1: XMLFormat) from [jvm]override fun from(p0: Any)override fun from(p0: Any, vararg p1: String)override fun from(p0: Any, vararg p1: Field<*>)override fun from(p0: Any, vararg p1: Name)override fun from(p0: Any, vararg p1: Int) fromArray [jvm]override fun fromArray(vararg p0: Any)override fun fromArray(p0: Array<Any>, vararg p1: String)override fun fromArray(p0: Array<Any>, vararg p1: Field<*>)override fun fromArray(p0: Array<Any>, vararg p1: Name)override fun fromArray(p0: Array<Any>, vararg p1: Int) fromMap [jvm]override fun fromMap(p0: MutableMap<String, >)override fun fromMap(p0: MutableMap<String, *>, vararg p1: String)override fun fromMap(p0: MutableMap<String, *>, vararg p1: Field<>)override fun fromMap(p0: MutableMap<String, *>, vararg p1: Name)override fun fromMap(p0: MutableMap<String, *>, vararg p1: Int) get [jvm]operator override fun get(p0: Int): Any?operator override fun get(p0: String): Any?operator override fun <T : Any> get(p0: Field<T>): Toperator override fun get(p0: Name): Any?operator override fun <U : Any> get(p0: Int, p1: Class<out U>): Uoperator override fun <U : Any> get(p0: Int, p1: Converter<, out U>): Uoperator override fun <T : Any> get(p0: String, p1: Class<out T>): Toperator override fun <U : Any> get(p0: String, p1: Converter<, out U>): Uoperator override fun <U : Any> get(p0: Field<>, p1: Class<out U>): Uoperator override fun <T : Any, U : Any> get(p0: Field<T>, p1: Converter<in T, out U>): Uoperator override fun <T : Any> get(p0: Name, p1: Class<out T>): Toperator override fun <U : Any> get(p0: Name, p1: Converter<, out U>): U getQualifier [jvm]override fun getQualifier(): RecordQualifier<MovieRecord> getSQLTypeName [jvm]override fun getSQLTypeName(): String getTable [jvm]override fun getTable(): Table<MovieRecord> getValue [jvm]override fun getValue(p0: Int): Anyoverride fun getValue(p0: String): Anyoverride fun <T : Any> getValue(p0: Field<T>): Toverride fun getValue(p0: Name): Anyoverride fun <T : Any> getValue(p0: Int, p1: Class<out T>): Toverride fun <U : Any> getValue(p0: Int, p1: Converter<, out U>): Uoverride fun <T : Any> getValue(p0: String, p1: Class<out T>): Toverride fun <U : Any> getValue(p0: String, p1: Converter<, out U>): Uoverride fun <T : Any> getValue(p0: Field<>, p1: Class<out T>): Toverride fun <T : Any, U : Any> getValue(p0: Field<T>, p1: Converter<in T, out U>): Uoverride fun <T : Any> getValue(p0: Name, p1: Class<out T>): Toverride fun <U : Any> getValue(p0: Name, p1: Converter<, out U>): U hashCode [jvm]open override fun hashCode(): Int indexOf [jvm]override fun indexOf(p0: String): Intoverride fun indexOf(p0: Field<*>): Intoverride fun indexOf(p0: Name): Int insert [jvm]override fun insert(): Intoverride fun insert(vararg p0: Field<>): Intoverride fun insert(p0: MutableCollection<out Field<>>): Int into [jvm]open override fun <E : Any> into(p0: E): E & Anyoverride fun <E : Any> into(p0: Class<out E>): Eoverride fun into(vararg p0: Field<*>): Recordoverride fun <T1 : Any> into(p0: Field<T1>): Record1<T1>override fun <R : Record> into(p0: Table<R>): R & Anyoverride fun <T1 : Any, T2 : Any> into(p0: Field<T1>, p1: Field<T2>): Record2<T1, T2>override fun <T1 : Any, T2 : Any, T3 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>): Record3<T1, T2, T3>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>): Record4<T1, T2, T3, T4>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>): Record5<T1, T2, T3, T4, T5>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>): Record6<T1, T2, T3, T4, T5, T6>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>): Record7<T1, T2, T3, T4, T5, T6, T7>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>): Record8<T1, T2, T3, T4, T5, T6, T7, T8>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>): Record9<T1, T2, T3, T4, T5, T6, T7, T8, T9>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>): Record10<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>): Record11<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>): Record12<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>): Record13<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>): Record14<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>): Record15<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>): Record16<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>): Record17<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>): Record18<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>): Record19<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any, T20 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>, p19: Field<T20>): Record20<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any, T20 : Any, T21 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>, p19: Field<T20>, p20: Field<T21>): Record21<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21>override fun <T1 : Any, T2 : Any, T3 : Any, T4 : Any, T5 : Any, T6 : Any, T7 : Any, T8 : Any, T9 : Any, T10 : Any, T11 : Any, T12 : Any, T13 : Any, T14 : Any, T15 : Any, T16 : Any, T17 : Any, T18 : Any, T19 : Any, T20 : Any, T21 : Any, T22 : Any> into(p0: Field<T1>, p1: Field<T2>, p2: Field<T3>, p3: Field<T4>, p4: Field<T5>, p5: Field<T6>, p6: Field<T7>, p7: Field<T8>, p8: Field<T9>, p9: Field<T10>, p10: Field<T11>, p11: Field<T12>, p12: Field<T13>, p13: Field<T14>, p14: Field<T15>, p15: Field<T16>, p16: Field<T17>, p17: Field<T18>, p18: Field<T19>, p19: Field<T20>, p20: Field<T21>, p21: Field<T22>): Record22<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> intoArray [jvm]override fun intoArray(): Array<Any?> intoList [jvm]override fun intoList(): MutableList<Any> intoMap [jvm]override fun intoMap(): MutableMap<String, Any> intoResultSet [jvm]override fun intoResultSet(): ResultSet intoStream [jvm]override fun intoStream(): Stream<Any> intoXML [jvm]override fun intoXML(): Documentoverride fun <H : ContentHandler> intoXML(p0: H): Hoverride fun intoXML(p0: XMLFormat): Documentoverride fun <H : ContentHandler> intoXML(p0: H, p1: XMLFormat): H key [jvm]open override fun key(): Record1<Long?> map [jvm]override fun <E : Any> map(p0: RecordMapper<Record, E>): E & Any merge [jvm]override fun merge(): Intopen override fun merge(vararg p0: Field<>): Intoverride fun merge(p0: MutableCollection<out Field<>>): Int original [jvm]override fun original(p0: Int): Any?override fun original(p0: String): Any?override fun <T : Any> original(p0: Field<T>): Toverride fun original(p0: Name): Any?override fun original(): MovieRecord parent [jvm]override fun <O : UpdatableRecord<O>> parent(p0: ForeignKey<MovieRecord, O>): Table<O> readSQL [jvm]override fun readSQL(p0: SQLInput, p1: String) refresh [jvm]override fun refresh()override fun refresh(vararg p0: Field<>)override fun refresh(p0: MutableCollection<out Field<>>) reset [jvm]override fun reset()override fun reset(p0: Int)override fun reset(p0: String)override fun reset(p0: Field<*>)override fun reset(p0: Name) set [jvm]operator override fun <T : Any> set(p0: Field<T>, p1: T)operator override fun <T : Any, U : Any> set(p0: Field<T>, p1: U, p2: Converter<out T, in U>) setValue [jvm]override fun <T : Any> setValue(p0: Field<T>, p1: T)override fun <T : Any, U : Any> setValue(p0: Field<T>, p1: U, p2: Converter<out T, in U>) size [jvm]override fun size(): Int store [jvm]override fun store(): Intoverride fun store(vararg p0: Field<>): Intoverride fun store(p0: MutableCollection<out Field<>>): Int toString [jvm]open override fun toString(): String type [jvm]override fun type(p0: Int): Class<>?override fun type(p0: String): Class<>?override fun type(p0: Name): Class<*>? types [jvm]override fun types(): Array<Class<*>> update [jvm]override fun update(): Intopen override fun update(vararg p0: Field<>): Intoverride fun update(p0: MutableCollection<out Field<>>): Int value1 [jvm]open override fun value1(): Long?open override fun value1(value: Long?): MovieRecord value2 [jvm]open override fun value2(): String?open override fun value2(value: String?): MovieRecord value3 [jvm]open override fun value3(): String?open override fun value3(value: String?): MovieRecord value4 [jvm]open override fun value4(): Int?open override fun value4(value: Int?): MovieRecord value5 [jvm]open override fun value5(): LocalDateTime?open override fun value5(value: LocalDateTime?): MovieRecord value6 [jvm]open override fun value6(): LocalDateTime?open override fun value6(value: LocalDateTime?): MovieRecord values [jvm]open override fun values(value1: Long?, value2: String?, value3: String?, value4: Int?, value5: LocalDateTime?, value6: LocalDateTime?): MovieRecord valuesRow [jvm]open override fun valuesRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?> with [jvm]override fun <T : Any> with(p0: Field<T>, p1: T): MovieRecordoverride fun <T : Any, U : Any> with(p0: Field<T>, p1: U, p2: Converter<out T, in U>): MovieRecord writeSQL [jvm]override fun writeSQL(p0: SQLOutput)"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/-movie-record/","title":"MovieRecord - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/-movie-record/#movierecord","title":"MovieRecord","text":"[jvm]\\ constructor(id: Long? = null, name: String? = null, genre: String? = null, version: Int? = null, createdAt: LocalDateTime? = null, updatedAt: LocalDateTime? = null)
Create a detached, initialised MovieRecord
[jvm]\\ constructor()
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component1/","title":"component1 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component1/#component1","title":"component1","text":"[jvm]\\ open operator override fun component1(): Long?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component2/","title":"component2 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component2
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component2/#component2","title":"component2","text":"[jvm]\\ open operator override fun component2(): String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component3/","title":"component3 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component3/#component3","title":"component3","text":"[jvm]\\ open operator override fun component3(): String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component4/","title":"component4 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component4
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component4/#component4","title":"component4","text":"[jvm]\\ open operator override fun component4(): Int?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component5/","title":"component5 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component5
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component5/#component5","title":"component5","text":"[jvm]\\ open operator override fun component5(): LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component6/","title":"component6 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/component6
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/component6/#component6","title":"component6","text":"[jvm]\\ open operator override fun component6(): LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/created-at/","title":"createdAt - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/createdAt
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/created-at/#createdat","title":"createdAt","text":"[jvm]\\ var createdAt: LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field1/","title":"field1 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field1/#field1","title":"field1","text":"[jvm]\\ open override fun field1(): Field<Long?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field2/","title":"field2 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field2
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field2/#field2","title":"field2","text":"[jvm]\\ open override fun field2(): Field<String?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field3/","title":"field3 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field3/#field3","title":"field3","text":"[jvm]\\ open override fun field3(): Field<String?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field4/","title":"field4 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field4
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field4/#field4","title":"field4","text":"[jvm]\\ open override fun field4(): Field<Int?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field5/","title":"field5 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field5
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field5/#field5","title":"field5","text":"[jvm]\\ open override fun field5(): Field<LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field6/","title":"field6 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/field6
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/field6/#field6","title":"field6","text":"[jvm]\\ open override fun field6(): Field<LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/fields-row/","title":"fieldsRow - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/fieldsRow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/fields-row/#fieldsrow","title":"fieldsRow","text":"[jvm]\\ open override fun fieldsRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/genre/","title":"genre - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/genre
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/genre/#genre","title":"genre","text":"[jvm]\\ var genre: String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/id/","title":"id - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/id
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/id/#id","title":"id","text":"[jvm]\\ var id: Long?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/key/","title":"key - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/key
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/key/#key","title":"key","text":"[jvm]\\ open override fun key(): Record1<Long?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/name/","title":"name - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/name
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/name/#name","title":"name","text":"[jvm]\\ var name: String?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/updated-at/","title":"updatedAt - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/updatedAt
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/updated-at/#updatedat","title":"updatedAt","text":"[jvm]\\ var updatedAt: LocalDateTime?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value1/","title":"value1 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value1
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value1/#value1","title":"value1","text":"[jvm]\\ open override fun value1(): Long?
open override fun value1(value: Long?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value2/","title":"value2 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value2
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value2/#value2","title":"value2","text":"[jvm]\\ open override fun value2(): String?
open override fun value2(value: String?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value3/","title":"value3 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value3
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value3/#value3","title":"value3","text":"[jvm]\\ open override fun value3(): String?
open override fun value3(value: String?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value4/","title":"value4 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value4
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value4/#value4","title":"value4","text":"[jvm]\\ open override fun value4(): Int?
open override fun value4(value: Int?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value5/","title":"value5 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value5
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value5/#value5","title":"value5","text":"[jvm]\\ open override fun value5(): LocalDateTime?
open override fun value5(value: LocalDateTime?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value6/","title":"value6 - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/value6
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/value6/#value6","title":"value6","text":"[jvm]\\ open override fun value6(): LocalDateTime?
open override fun value6(value: LocalDateTime?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values-row/","title":"valuesRow - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/valuesRow
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values-row/#valuesrow","title":"valuesRow","text":"[jvm]\\ open override fun valuesRow(): Row6<Long?, String?, String?, Int?, LocalDateTime?, LocalDateTime?>
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values/","title":"values - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/values
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/values/#values","title":"values","text":"[jvm]\\ open override fun values(value1: Long?, value2: String?, value3: String?, value4: Int?, value5: LocalDateTime?, value6: LocalDateTime?): MovieRecord
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/version/","title":"version - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.records/MovieRecord/version
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.records/-movie-record/version/#version","title":"version","text":"[jvm]\\ var version: Int?
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/","title":"Package-level declarations - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.references
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/#properties","title":"Properties","text":"Name Summary MOVIE [jvm]val MOVIE: MovieThe tablejooq.movie."},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/-m-o-v-i-e/","title":"MOVIE - Misk","text":"//misk-jooq/misk.jooq.testgen.tables.references/MOVIE
"},{"location":"0.x/misk-jooq/misk-jooq/misk.jooq.testgen.tables.references/-m-o-v-i-e/#movie","title":"MOVIE","text":"[jvm]\\ val MOVIE: Movie
The table jooq.movie.
//misk-launchdarkly
"},{"location":"0.x/misk-launchdarkly/#misk-launchdarkly","title":"misk-launchdarkly","text":""},{"location":"0.x/misk-launchdarkly/#packages","title":"Packages","text":"Name misk.feature.launchdarkly"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/","title":"Package-level declarations - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/#types","title":"Types","text":"Name Summary LaunchDarklyConfig [jvm]data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val use_relay_proxy: Boolean = true, val ssl: HttpClientSSLConfig? = null, val event_capacity: Int = DEFAULT_CAPACITY) : Config LaunchDarklyModule [jvm]class LaunchDarklyModule@JvmOverloadsconstructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null) : KAbstractModuleBinds a FeatureFlags backed by LaunchDarkly (https://launchdarkly.com)."},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\ data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val use_relay_proxy: Boolean = true, val ssl: HttpClientSSLConfig? = null, val event_capacity: Int = DEFAULT_CAPACITY) : Config
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/#constructors","title":"Constructors","text":"LaunchDarklyConfig [jvm]@JvmOverloadsconstructor(sdk_key: String, base_uri: String, use_relay_proxy: Boolean = true, ssl: HttpClientSSLConfig? = null, event_capacity: Int = DEFAULT_CAPACITY)"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/#properties","title":"Properties","text":"Name Summary base_uri [jvm]val base_uri: String event_capacity [jvm]val event_capacity: Int sdk_key [jvm]val sdk_key: String ssl [jvm]val ssl: HttpClientSSLConfig? = null use_relay_proxy [jvm]val use_relay_proxy: Boolean = true"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/LaunchDarklyConfig
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\
@JvmOverloads
constructor(sdk_key: String, base_uri: String, use_relay_proxy: Boolean = true, ssl: HttpClientSSLConfig? = null, event_capacity: Int = DEFAULT_CAPACITY)
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/base_uri/","title":"base_uri - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/base_uri
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/base_uri/#base_uri","title":"base_uri","text":"[jvm]\\ val base_uri: String
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/event_capacity/","title":"event_capacity - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/event_capacity
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/event_capacity/#event_capacity","title":"event_capacity","text":"[jvm]\\ val event_capacity: Int
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/sdk_key/","title":"sdk_key - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/sdk_key
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/sdk_key/#sdk_key","title":"sdk_key","text":"[jvm]\\ val sdk_key: String
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/ssl/","title":"ssl - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/ssl
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/use_relay_proxy/","title":"use_relay_proxy - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyConfig/use_relay_proxy
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-config/use_relay_proxy/#use_relay_proxy","title":"use_relay_proxy","text":"[jvm]\\ val use_relay_proxy: Boolean = true
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/","title":"LaunchDarklyModule - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyModule
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/#launchdarklymodule","title":"LaunchDarklyModule","text":"[jvm]\\ class LaunchDarklyModule@JvmOverloadsconstructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null) : KAbstractModule
Binds a FeatureFlags backed by LaunchDarkly (https://launchdarkly.com).
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/#constructors","title":"Constructors","text":"LaunchDarklyModule [jvm]@JvmOverloadsconstructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null)"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/-launch-darkly-module/","title":"LaunchDarklyModule - Misk","text":"//misk-launchdarkly/misk.feature.launchdarkly/LaunchDarklyModule/LaunchDarklyModule
"},{"location":"0.x/misk-launchdarkly/misk-launchdarkly/misk.feature.launchdarkly/-launch-darkly-module/-launch-darkly-module/#launchdarklymodule","title":"LaunchDarklyModule","text":"[jvm]\\
@JvmOverloads
constructor(config: LaunchDarklyConfig, qualifier: KClass<out Annotation>? = null)
"},{"location":"0.x/misk-launchdarkly-core/","title":"misk-launchdarkly-core - Misk","text":"//misk-launchdarkly-core
"},{"location":"0.x/misk-launchdarkly-core/#misk-launchdarkly-core","title":"misk-launchdarkly-core","text":""},{"location":"0.x/misk-launchdarkly-core/#packages","title":"Packages","text":"Name misk.feature.launchdarkly"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/","title":"Package-level declarations - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/#types","title":"Types","text":"Name Summary LaunchDarklyDynamicConfig [jvm]@Singletonclass LaunchDarklyDynamicConfig@Injectconstructor(featureFlags: FeatureFlags) : DynamicConfig LaunchDarklyFeatureFlags [jvm]@Singletonclass LaunchDarklyFeatureFlags@Injectconstructor(delegate: LaunchDarklyFeatureFlags) : AbstractIdleService, FeatureFlags, FeatureServiceImplementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation."},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\ @Singleton
class LaunchDarklyDynamicConfig@Injectconstructor(featureFlags: FeatureFlags) : DynamicConfig
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#constructors","title":"Constructors","text":"LaunchDarklyDynamicConfig [jvm]@Injectconstructor(featureFlags: FeatureFlags)"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open override fun getBoolean(feature: Feature): Boolean getDouble [jvm]open override fun getDouble(feature: Feature): Double getEnum [jvm]open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T getInt [jvm]open override fun getInt(feature: Feature): Int getJson [jvm]open override fun <T> getJson(feature: Feature, clazz: Class<T>): T getString [jvm]open override fun getString(feature: Feature): String trackBoolean [jvm]open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/LaunchDarklyDynamicConfig
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\
@Inject
constructor(featureFlags: FeatureFlags)
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature): Boolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-double/","title":"getDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature): Double
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-int/","title":"getInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature): Int
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-json/","title":"getJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-string/","title":"getString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/getString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature): String
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-int/","title":"trackInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-json/","title":"trackJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-string/","title":"trackString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/trackString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/","title":"Companion - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/Companion
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/#properties","title":"Properties","text":"Name Summary ATTRIBUTES [jvm]val ATTRIBUTES: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/","title":"ATTRIBUTES - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/Companion/ATTRIBUTES
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/#attributes","title":"ATTRIBUTES","text":"[jvm]\\ val ATTRIBUTES: Attributes
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/","title":"KEY - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyDynamicConfig/Companion/KEY
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\ @Singleton
class LaunchDarklyFeatureFlags@Injectconstructor(delegate: LaunchDarklyFeatureFlags) : AbstractIdleService, FeatureFlags, FeatureService
Implementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation.
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/#constructors","title":"Constructors","text":"LaunchDarklyFeatureFlags [jvm]@Injectconstructor(delegate: LaunchDarklyFeatureFlags)"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getDouble [jvm]open fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getString [jvm]open fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/LaunchDarklyFeatureFlags
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\
@Inject
constructor(delegate: LaunchDarklyFeatureFlags)
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-double/","title":"getDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-enum/","title":"getEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-int/","title":"getInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature, key: String, attributes: Attributes): Int
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-json/","title":"getJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-string/","title":"getString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/getString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature, key: String, attributes: Attributes): String
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get/","title":"get - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/get
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/get/#get","title":"get","text":"[jvm]\\ open override fun get(flag: BooleanFeatureFlag): Boolean
open override fun get(flag: StringFeatureFlag): String
open override fun get(flag: IntFeatureFlag): Int
open override fun get(flag: DoubleFeatureFlag): Double
open override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
open override fun <T : Any> get(flag: JsonFeatureFlag<T>): T
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackBoolean
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-double/","title":"trackDouble - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackDouble
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackEnum
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-int/","title":"trackInt - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackInt
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-json/","title":"trackJson - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackJson
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-string/","title":"trackString - Misk","text":"//misk-launchdarkly-core/misk.feature.launchdarkly/LaunchDarklyFeatureFlags/trackString
"},{"location":"0.x/misk-launchdarkly-core/misk-launchdarkly-core/misk.feature.launchdarkly/-launch-darkly-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/misk-lease/","title":"misk-lease - Misk","text":"//misk-lease
"},{"location":"0.x/misk-lease/#misk-lease","title":"misk-lease","text":""},{"location":"0.x/misk-lease/#packages","title":"Packages","text":"Name misk.lease"},{"location":"0.x/misk-lease/misk-lease/misk.lease/","title":"Package-level declarations - Misk","text":"//misk-lease/misk.lease
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-lease/misk-lease/misk.lease/#types","title":"Types","text":"Name Summary LeaseService [jvm]@Singletonclass LeaseService@Injectconstructor(leaseManager: LeaseManager) : AbstractIdleService"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/","title":"LeaseService - Misk","text":"//misk-lease/misk.lease/LeaseService
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#leaseservice","title":"LeaseService","text":"[jvm]\\ @Singleton
class LeaseService@Injectconstructor(leaseManager: LeaseManager) : AbstractIdleService
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#constructors","title":"Constructors","text":"LeaseService [jvm]@Injectconstructor(leaseManager: LeaseManager)"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-lease-service/","title":"LeaseService - Misk","text":"//misk-lease/misk.lease/LeaseService/LeaseService
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-lease-service/#leaseservice","title":"LeaseService","text":"[jvm]\\
@Inject
constructor(leaseManager: LeaseManager)
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-companion/","title":"Companion - Misk","text":"//misk-lease/misk.lease/LeaseService/Companion
"},{"location":"0.x/misk-lease/misk-lease/misk.lease/-lease-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/","title":"misk-metrics - Misk","text":"//misk-metrics
"},{"location":"0.x/misk-metrics/#misk-metrics","title":"misk-metrics","text":""},{"location":"0.x/misk-metrics/#packages","title":"Packages","text":"Name misk.metrics misk.metrics.v2"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/","title":"Package-level declarations - Misk","text":"//misk-metrics/misk.metrics
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/#types","title":"Types","text":"Name Summary Histogram [jvm]interface HistogramSkeleton for the functionality of histograms MetricsModule [jvm]class MetricsModule : KAbstractModule"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/#properties","title":"Properties","text":"Name Summary defaultQuantiles [jvm]val defaultQuantiles: Map<Double, Double>"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/default-quantiles/","title":"defaultQuantiles - Misk","text":"//misk-metrics/misk.metrics/defaultQuantiles
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/default-quantiles/#defaultquantiles","title":"defaultQuantiles","text":"[jvm]\\ val defaultQuantiles: Map<Double, Double>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/","title":"Histogram - Misk","text":"//misk-metrics/misk.metrics/Histogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/#histogram","title":"Histogram","text":"[jvm]\\ interface Histogram
Skeleton for the functionality of histograms
A histogram samples observations (usually things like request durations or response sizes) and counts them in configurable buckets.
A sample implementation can be found in PrometheusHistogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/#functions","title":"Functions","text":"Name Summary count [jvm]open fun count(vararg labelValues: String): Intreturns the number of buckets getHistogram [jvm]abstract fun getHistogram(): Summary record [jvm]open fun record(duration: Double, vararg labelValues: String)records a new set of labels and accompanying duration timedMills [jvm]open fun <T> timedMills(vararg labelValues: String, work: () -> T): Trecords a new set of labels and the time to execute the work lambda in milliseconds"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/count/","title":"count - Misk","text":"//misk-metrics/misk.metrics/Histogram/count
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/count/#count","title":"count","text":"[jvm]\\ open fun count(vararg labelValues: String): Int
returns the number of buckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/get-histogram/","title":"getHistogram - Misk","text":"//misk-metrics/misk.metrics/Histogram/getHistogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/get-histogram/#gethistogram","title":"getHistogram","text":"[jvm]\\ abstract fun getHistogram(): Summary
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/record/","title":"record - Misk","text":"//misk-metrics/misk.metrics/Histogram/record
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/record/#record","title":"record","text":"[jvm]\\ open fun record(duration: Double, vararg labelValues: String)
records a new set of labels and accompanying duration
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/timed-mills/","title":"timedMills - Misk","text":"//misk-metrics/misk.metrics/Histogram/timedMills
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/timed-mills/#timedmills","title":"timedMills","text":"[jvm]\\ open fun <T> timedMills(vararg labelValues: String, work: () -> T): T
records a new set of labels and the time to execute the work lambda in milliseconds
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/","title":"Companion - Misk","text":"//misk-metrics/misk.metrics/Histogram/Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/#functions","title":"Functions","text":"Name Summary factory [jvm]fun factory(summary: Summary): Histogram"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/factory/","title":"factory - Misk","text":"//misk-metrics/misk.metrics/Histogram/Companion/factory
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-histogram/-companion/factory/#factory","title":"factory","text":"[jvm]\\ fun factory(summary: Summary): Histogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/","title":"MetricsModule - Misk","text":"//misk-metrics/misk.metrics/MetricsModule
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/#metricsmodule","title":"MetricsModule","text":"[jvm]\\ class MetricsModule : KAbstractModule
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/#constructors","title":"Constructors","text":"MetricsModule [jvm]constructor()"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/-metrics-module/","title":"MetricsModule - Misk","text":"//misk-metrics/misk.metrics/MetricsModule/MetricsModule
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics/-metrics-module/-metrics-module/#metricsmodule","title":"MetricsModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/","title":"Package-level declarations - Misk","text":"//misk-metrics/misk.metrics.v2
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#types","title":"Types","text":"Name Summary Metrics [jvm]interface MetricsInterface for application code to emit metrics to a metrics backend like Prometheus. PeakGauge [jvm]@ThreadSafeclass PeakGauge : SimpleCollector<PeakGauge.Child> A peak gauge is a variant of a io.prometheus.client.Gauge that resets to an initial value of 0 after a metric collection."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#properties","title":"Properties","text":"Name Summary defaultBuckets [jvm]val defaultBuckets: List<Double>defaultBuckets is a default set of buckets which assumes the value is in milliseconds (ms). defaultQuantiles [jvm]val defaultQuantiles: Map<Double, Double> defaultSparseBuckets [jvm]val defaultSparseBuckets: List<Double>defaultSparseBuckets is a default set of buckets which assumes the value is in milliseconds (ms)."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/#functions","title":"Functions","text":"Name Summary exponentialBuckets [jvm]fun exponentialBuckets(start: Double, factor: Double, count: Int): List<Double>Generate a list of upper bounds of buckets for a histogram with an exponential sequence. linearBuckets [jvm]fun linearBuckets(start: Double, width: Double, count: Int): List<Double>Generate a list of upper bounds of buckets for a histogram with a linear sequence."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-buckets/","title":"defaultBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/defaultBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-buckets/#defaultbuckets","title":"defaultBuckets","text":"[jvm]\\ val defaultBuckets: List<Double>
defaultBuckets is a default set of buckets which assumes the value is in milliseconds (ms).
It contains 58 buckets which range from 1ms to 1hr.
Adapted from the default M3 buckets.
https://github.com/m3db/m3/blob/v1.1.0/src/x/instrument/methods.go#L57-L83
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-quantiles/","title":"defaultQuantiles - Misk","text":"//misk-metrics/misk.metrics.v2/defaultQuantiles
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-quantiles/#defaultquantiles","title":"defaultQuantiles","text":"[jvm]\\ val defaultQuantiles: Map<Double, Double>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-sparse-buckets/","title":"defaultSparseBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/defaultSparseBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/default-sparse-buckets/#defaultsparsebuckets","title":"defaultSparseBuckets","text":"[jvm]\\ val defaultSparseBuckets: List<Double>
defaultSparseBuckets is a default set of buckets which assumes the value is in milliseconds (ms).
It contains 21 buckets which range from 1ms to 8m.
Adapted from the default M3 buckets.
https://github.com/m3db/m3/blob/v1.1.0/src/x/instrument/methods.go#L85-L147
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/exponential-buckets/","title":"exponentialBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/exponentialBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/exponential-buckets/#exponentialbuckets","title":"exponentialBuckets","text":"[jvm]\\ fun exponentialBuckets(start: Double, factor: Double, count: Int): List<Double>
Generate a list of upper bounds of buckets for a histogram with an exponential sequence.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/linear-buckets/","title":"linearBuckets - Misk","text":"//misk-metrics/misk.metrics.v2/linearBuckets
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/linear-buckets/#linearbuckets","title":"linearBuckets","text":"[jvm]\\ fun linearBuckets(start: Double, width: Double, count: Int): List<Double>
Generate a list of upper bounds of buckets for a histogram with a linear sequence.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/","title":"Metrics - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/#metrics","title":"Metrics","text":"[jvm]\\ interface Metrics
Interface for application code to emit metrics to a metrics backend like Prometheus.
NOTE: misk.metrics.v2.Metrics is NOT backward compatible with misk.metrics.Metrics. This is because the metric type of the histogram(...) function has changed. If a callsite which used misk.metrics.Metrics.histogram(...) is upgraded to use misk.metrics.v2.Metrics.histogram(...), the dashboards and monitors based on the metric will break because the data type of the metric will have changed.
Tests that use this should install a metrics client like PrometheusMetricsClientModule. Services that use this should install a metrics service like PrometheusMetricsServiceModule.
Counter prometheus type. gauge [jvm]open fun gauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): Gaugegauge creates and registers a new Gauge prometheus type. getRegistry [jvm]abstract fun getRegistry(): CollectorRegistry histogram [jvm]open fun histogram(name: String, help: String = \"\", labelNames: List<String> = listOf(), buckets: List<Double> = defaultBuckets): Histogramhistogram creates a new Histogram prometheus type with the supplied parameters. peakGauge [jvm]open fun peakGauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): PeakGaugepeakGauge creates and registers a new Gauge prometheus type that resets to its initial value after each metrics collection. summary [jvm]open fun summary(name: String, help: String = \"\", labelNames: List<String> = listOf(), quantiles: Map<Double, Double> = defaultQuantiles, maxAgeSeconds: Long? = null): Summarysummary creates and registers a new Summary prometheus type."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/counter/","title":"counter - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/counter
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/counter/#counter","title":"counter","text":"[jvm]\\ open fun counter(name: String, help: String, labelNames: List<String> = listOf()): Counter
counter creates and registers a new Counter prometheus type.
See https://prometheus.github.io/client_java/io/prometheus/client/Counter.html for more info.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/counter/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/gauge/","title":"gauge - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/gauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/gauge/#gauge","title":"gauge","text":"[jvm]\\ open fun gauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): Gauge
gauge creates and registers a new Gauge prometheus type.
See https://prometheus.github.io/client_java/io/prometheus/client/Gauge.html for more info.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/gauge/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/get-registry/","title":"getRegistry - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/getRegistry
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/get-registry/#getregistry","title":"getRegistry","text":"[jvm]\\ abstract fun getRegistry(): CollectorRegistry
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/histogram/","title":"histogram - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/histogram
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/histogram/#histogram","title":"histogram","text":"[jvm]\\ open fun histogram(name: String, help: String = \"\", labelNames: List<String> = listOf(), buckets: List<Double> = defaultBuckets): Histogram
histogram creates a new Histogram prometheus type with the supplied parameters.
NOTE: misk.metrics.v2.Metrics is NOT backward compatible with misk.metrics.Metrics. This is because the metric type of the histogram(...) function has changed. If a callsite which used misk.metrics.Metrics.histogram(...) is upgraded to use misk.metrics.v2.Metrics.histogram(...), the dashboards and monitors based on the metric will break because the data type of the metric will have changed.
See https://prometheus.github.io/client_java/io/prometheus/client/Histogram.html for more info.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/histogram/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric. buckets a list of upper bounds of buckets for the histogram."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/peak-gauge/","title":"peakGauge - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/peakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/peak-gauge/#peakgauge","title":"peakGauge","text":"[jvm]\\ open fun peakGauge(name: String, help: String = \"\", labelNames: List<String> = listOf()): PeakGauge
peakGauge creates and registers a new Gauge prometheus type that resets to its initial value after each metrics collection.
jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/summary/","title":"summary - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/summary
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/summary/#summary","title":"summary","text":"[jvm]\\ open fun summary(name: String, help: String = \"\", labelNames: List<String> = listOf(), quantiles: Map<Double, Double> = defaultQuantiles, maxAgeSeconds: Long? = null): Summary
summary creates and registers a new Summary prometheus type.
See https://prometheus.github.io/client_java/io/prometheus/client/Summary.html for more info.
NB: Summaries can be an order of magnitude more expensive than histograms in terms of CPU. Unless you require the specific properties of a summary, consider using histogram instead.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/summary/#parameters","title":"Parameters","text":"jvm
name the name of the metric which will be supplied to prometheus. Must be unique across all metric types. help human-readable help text that will be supplied to prometheus. labelNames the names (a.k.a. keys) of all the labels that will be used for this metric. quantiles is a map of all of the quantiles (a.k.a. percentiles) that will be computed for the metric. The key of the map is the quantile as a ratio (e.g. 0.99 represents p99) and the value is the \"tolerable error\" of the computed quantile."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/","title":"Companion - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/#functions","title":"Functions","text":"Name Summary factory [jvm]fun factory(registry: CollectorRegistry): Metrics"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/factory/","title":"factory - Misk","text":"//misk-metrics/misk.metrics.v2/Metrics/Companion/factory
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-metrics/-companion/factory/#factory","title":"factory","text":"[jvm]\\ fun factory(registry: CollectorRegistry): Metrics
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/","title":"PeakGauge - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#peakgauge","title":"PeakGauge","text":"[jvm]\\ @ThreadSafe
class PeakGauge : SimpleCollector<PeakGauge.Child>
A peak gauge is a variant of a io.prometheus.client.Gauge that resets to an initial value of 0 after a metric collection.
This is useful for accurately capturing maximum observed values over time. In contrast to the histogram maximum which tracks the maximum value in its sampling window. That sampling window typically covers multiple metric collections.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#constructors","title":"Constructors","text":"PeakGauge [jvm]constructor(builder: PeakGauge.Builder)"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : SimpleCollector.Builder<PeakGauge.Builder, PeakGauge> Child [jvm]class Child Companion [jvm]object Companion"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/#functions","title":"Functions","text":"Name Summary clear [jvm]open fun clear() collect [jvm]open fun collect(p0: Predicate<String>): MutableList<Collector.MetricFamilySamples>open override fun collect(): MutableList<Collector.MetricFamilySamples> labels [jvm]open fun labels(vararg p0: String): PeakGauge.Child record [jvm]fun record(newValue: Double)Convenience method for recording values without labels register [jvm]open fun <T : Collector> register(): Topen fun <T : Collector> register(p0: CollectorRegistry): T remove [jvm]open fun remove(vararg p0: String) setChild [jvm]open fun <T : Collector> setChild(p0: PeakGauge.Child, vararg p1: String): T"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-peak-gauge/","title":"PeakGauge - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/PeakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-peak-gauge/#peakgauge","title":"PeakGauge","text":"[jvm]\\ constructor(builder: PeakGauge.Builder)
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/collect/","title":"collect - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/collect
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/collect/#collect","title":"collect","text":"[jvm]\\ open override fun collect(): MutableList<Collector.MetricFamilySamples>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/record/","title":"record - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/record
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/record/#record","title":"record","text":"[jvm]\\ fun record(newValue: Double)
Convenience method for recording values without labels
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/","title":"Builder - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Builder
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : SimpleCollector.Builder<PeakGauge.Builder, PeakGauge>
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(): PeakGauge help [jvm]open fun help(p0: String): PeakGauge.Builder labelNames [jvm]open fun labelNames(vararg p0: String): PeakGauge.Builder name [jvm]open fun name(p0: String): PeakGauge.Builder namespace [jvm]open fun namespace(p0: String): PeakGauge.Builder register [jvm]open fun register(): PeakGaugeopen fun register(p0: CollectorRegistry): PeakGauge subsystem [jvm]open fun subsystem(p0: String): PeakGauge.Builder unit [jvm]open fun unit(p0: String): PeakGauge.Builder"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Builder/Builder
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/create/","title":"create - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Builder/create
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-builder/create/#create","title":"create","text":"[jvm]\\ open override fun create(): PeakGauge
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/","title":"Child - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/#child","title":"Child","text":"[jvm]\\ class Child
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/#constructors","title":"Constructors","text":"Child [jvm]constructor()"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/#functions","title":"Functions","text":"Name Summary getAndClear [jvm]fun getAndClear(): DoubleReset to the initial value and return previously held value. record [jvm]fun record(newValue: Double)Updates the stored value if the new value is greater."},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/-child/","title":"Child - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child/Child
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/-child/#child","title":"Child","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/get-and-clear/","title":"getAndClear - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child/getAndClear
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/get-and-clear/#getandclear","title":"getAndClear","text":"[jvm]\\ fun getAndClear(): Double
Reset to the initial value and return previously held value.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/record/","title":"record - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Child/record
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-child/record/#record","title":"record","text":"[jvm]\\ fun record(newValue: Double)
Updates the stored value if the new value is greater.
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/","title":"Companion - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/#functions","title":"Functions","text":"Name Summary builder [jvm]fun builder(name: String, help: String): PeakGauge.Builder"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/builder/","title":"builder - Misk","text":"//misk-metrics/misk.metrics.v2/PeakGauge/Companion/builder
"},{"location":"0.x/misk-metrics/misk-metrics/misk.metrics.v2/-peak-gauge/-companion/builder/#builder","title":"builder","text":"[jvm]\\ fun builder(name: String, help: String): PeakGauge.Builder
"},{"location":"0.x/misk-metrics-digester/","title":"misk-metrics-digester - Misk","text":"//misk-metrics-digester
"},{"location":"0.x/misk-metrics-digester/#misk-metrics-digester","title":"misk-metrics-digester","text":""},{"location":"0.x/misk-metrics-digester/#packages","title":"Packages","text":"Name com.squareup.digester.protos.service com.squareup.digester.protos.tdigest misk.metrics.digester"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/","title":"Package-level declarations - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/#types","title":"Types","text":"Name Summary DigestData [jvm]class DigestData : Message<M, B> Representation of internals of a t-digest implementation. GetDigestsRequest [jvm]class GetDigestsRequest : Message<M, B> GetDigestsResponse [jvm]class GetDigestsResponse : Message<M, B> MetricFamily [jvm]class MetricFamily : Message<M, B> A group of digest metrics all having the same name and label names."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/","title":"DigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#digestdata","title":"DigestData","text":"[jvm]\\ class DigestData : Message<M, B>
Representation of internals of a t-digest implementation.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#constructors","title":"Constructors","text":"DigestData [jvm]constructor(count: Long, sum: Double, veneur_digest: ByteString)constructor(count: Long, sum: Double, veneur_digest: ByteString, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<DigestData> Companion [jvm]val Companion: Message.Companion count [jvm]val count: LongCount of values observed. DEFAULT_COUNT [jvm]val DEFAULT_COUNT: Long DEFAULT_SUM [jvm]val DEFAULT_SUM: Double DEFAULT_VENEUR_DIGEST [jvm]val DEFAULT_VENEUR_DIGEST: ByteString sum [jvm]val sum: DoubleSum of observed values. veneur_digest [jvm]val veneur_digest: ByteStringSerialized Veneur t-digest proto bytes."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): DigestData.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<DigestData>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-c-o-u-n-t/","title":"DEFAULT_COUNT - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DEFAULT_COUNT
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-c-o-u-n-t/#default_count","title":"DEFAULT_COUNT","text":"[jvm]\\ val DEFAULT_COUNT: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-s-u-m/","title":"DEFAULT_SUM - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DEFAULT_SUM
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-s-u-m/#default_sum","title":"DEFAULT_SUM","text":"[jvm]\\ val DEFAULT_SUM: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-v-e-n-e-u-r_-d-i-g-e-s-t/","title":"DEFAULT_VENEUR_DIGEST - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DEFAULT_VENEUR_DIGEST
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-d-e-f-a-u-l-t_-v-e-n-e-u-r_-d-i-g-e-s-t/#default_veneur_digest","title":"DEFAULT_VENEUR_DIGEST","text":"[jvm]\\ val DEFAULT_VENEUR_DIGEST: ByteString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-digest-data/","title":"DigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-digest-data/#digestdata","title":"DigestData","text":"[jvm]\\ constructor(count: Long, sum: Double, veneur_digest: ByteString)
constructor(count: Long, sum: Double, veneur_digest: ByteString, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/count/","title":"count - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/count/#count","title":"count","text":"[jvm]\\ val count: Long
Count of values observed.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): DigestData.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/sum/","title":"sum - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/sum/#sum","title":"sum","text":"[jvm]\\ val sum: Double
Sum of observed values.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/veneur_digest/","title":"veneur_digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/veneur_digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/veneur_digest/#veneur_digest","title":"veneur_digest","text":"[jvm]\\ val veneur_digest: ByteString
Serialized Veneur t-digest proto bytes. github.com/stripe/veneur/tdigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#properties","title":"Properties","text":"Name Summary count [jvm]open var count: Long sum [jvm]open var sum: Double veneur_digest [jvm]open var veneur_digest: ByteString"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): DigestData buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> count [jvm]open fun count(count: Long): DigestData.BuilderCount of values observed. getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) sum [jvm]open fun sum(sum: Double): DigestData.BuilderSum of observed values. veneur_digest [jvm]open fun veneur_digest(veneur_digest: ByteString): DigestData.BuilderSerialized Veneur t-digest proto bytes."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/count/","title":"count - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/count/#count","title":"count","text":"[jvm]\\ open fun count(count: Long): DigestData.Builder
Count of values observed.
[jvm]\\ open var count: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/sum/","title":"sum - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/sum/#sum","title":"sum","text":"[jvm]\\ open fun sum(sum: Double): DigestData.Builder
Sum of observed values.
[jvm]\\ open var sum: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/veneur_digest/","title":"veneur_digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/DigestData/Builder/veneur_digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-digest-data/-builder/veneur_digest/#veneur_digest","title":"veneur_digest","text":"[jvm]\\ open fun veneur_digest(veneur_digest: ByteString): DigestData.Builder
Serialized Veneur t-digest proto bytes. github.com/stripe/veneur/tdigest
[jvm]\\ open var veneur_digest: ByteString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/","title":"GetDigestsRequest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#getdigestsrequest","title":"GetDigestsRequest","text":"[jvm]\\ class GetDigestsRequest : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#constructors","title":"Constructors","text":"GetDigestsRequest [jvm]constructor(windows_end_from_ms: Long, windows_end_to_ms: Long)constructor(windows_end_from_ms: Long, windows_end_to_ms: Long, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<GetDigestsRequest> Companion [jvm]val Companion: Message.Companion DEFAULT_WINDOWS_END_FROM_MS [jvm]val DEFAULT_WINDOWS_END_FROM_MS: Long DEFAULT_WINDOWS_END_TO_MS [jvm]val DEFAULT_WINDOWS_END_TO_MS: Long windows_end_from_ms [jvm]val windows_end_from_ms: LongEarliest end time of windows to return, inclusive. windows_end_to_ms [jvm]val windows_end_to_ms: LongLatest end time of windows to return, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): GetDigestsRequest.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<GetDigestsRequest>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-f-r-o-m_-m-s/","title":"DEFAULT_WINDOWS_END_FROM_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/DEFAULT_WINDOWS_END_FROM_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-f-r-o-m_-m-s/#default_windows_end_from_ms","title":"DEFAULT_WINDOWS_END_FROM_MS","text":"[jvm]\\ val DEFAULT_WINDOWS_END_FROM_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-t-o_-m-s/","title":"DEFAULT_WINDOWS_END_TO_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/DEFAULT_WINDOWS_END_TO_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-d-e-f-a-u-l-t_-w-i-n-d-o-w-s_-e-n-d_-t-o_-m-s/#default_windows_end_to_ms","title":"DEFAULT_WINDOWS_END_TO_MS","text":"[jvm]\\ val DEFAULT_WINDOWS_END_TO_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-get-digests-request/","title":"GetDigestsRequest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/GetDigestsRequest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-get-digests-request/#getdigestsrequest","title":"GetDigestsRequest","text":"[jvm]\\ constructor(windows_end_from_ms: Long, windows_end_to_ms: Long)
constructor(windows_end_from_ms: Long, windows_end_to_ms: Long, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): GetDigestsRequest.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_from_ms/","title":"windows_end_from_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/windows_end_from_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_from_ms/#windows_end_from_ms","title":"windows_end_from_ms","text":"[jvm]\\ val windows_end_from_ms: Long
Earliest end time of windows to return, inclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_to_ms/","title":"windows_end_to_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/windows_end_to_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/windows_end_to_ms/#windows_end_to_ms","title":"windows_end_to_ms","text":"[jvm]\\ val windows_end_to_ms: Long
Latest end time of windows to return, inclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#properties","title":"Properties","text":"Name Summary windows_end_from_ms [jvm]open var windows_end_from_ms: Long windows_end_to_ms [jvm]open var windows_end_to_ms: Long"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): GetDigestsRequest buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) windows_end_from_ms [jvm]open fun windows_end_from_ms(windows_end_from_ms: Long): GetDigestsRequest.BuilderEarliest end time of windows to return, inclusive. windows_end_to_ms [jvm]open fun windows_end_to_ms(windows_end_to_ms: Long): GetDigestsRequest.BuilderLatest end time of windows to return, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): GetDigestsRequest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_from_ms/","title":"windows_end_from_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/windows_end_from_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_from_ms/#windows_end_from_ms","title":"windows_end_from_ms","text":"[jvm]\\ open fun windows_end_from_ms(windows_end_from_ms: Long): GetDigestsRequest.Builder
Earliest end time of windows to return, inclusive.
[jvm]\\ open var windows_end_from_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_to_ms/","title":"windows_end_to_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsRequest/Builder/windows_end_to_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-request/-builder/windows_end_to_ms/#windows_end_to_ms","title":"windows_end_to_ms","text":"[jvm]\\ open fun windows_end_to_ms(windows_end_to_ms: Long): GetDigestsRequest.Builder
Latest end time of windows to return, inclusive.
[jvm]\\ open var windows_end_to_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/","title":"GetDigestsResponse - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#getdigestsresponse","title":"GetDigestsResponse","text":"[jvm]\\ class GetDigestsResponse : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#constructors","title":"Constructors","text":"GetDigestsResponse [jvm]constructor(metric_family: MetricFamily)constructor(metric_family: MetricFamily, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<GetDigestsResponse> Companion [jvm]val Companion: Message.Companion metric_family [jvm]val metric_family: MetricFamily"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): GetDigestsResponse.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<GetDigestsResponse>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-get-digests-response/","title":"GetDigestsResponse - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/GetDigestsResponse
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-get-digests-response/#getdigestsresponse","title":"GetDigestsResponse","text":"[jvm]\\ constructor(metric_family: MetricFamily)
constructor(metric_family: MetricFamily, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/metric_family/","title":"metric_family - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/metric_family
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/metric_family/#metric_family","title":"metric_family","text":"[jvm]\\ val metric_family: MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): GetDigestsResponse.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#properties","title":"Properties","text":"Name Summary metric_family [jvm]open var metric_family: MetricFamily"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): GetDigestsResponse buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter metric_family [jvm]open fun metric_family(metric_family: MetricFamily): GetDigestsResponse.Builder setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): GetDigestsResponse
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/metric_family/","title":"metric_family - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/GetDigestsResponse/Builder/metric_family
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-get-digests-response/-builder/metric_family/#metric_family","title":"metric_family","text":"[jvm]\\ open fun metric_family(metric_family: MetricFamily): GetDigestsResponse.Builder
open var metric_family: MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/","title":"MetricFamily - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#metricfamily","title":"MetricFamily","text":"[jvm]\\ class MetricFamily : Message<M, B>
A group of digest metrics all having the same name and label names.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#constructors","title":"Constructors","text":"MetricFamily [jvm]constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>)constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B> Digest [jvm]class Digest : Message<M, B> Digest holds a t-digest of data points observed in a specific time range. Metric [jvm]class Metric : Message<M, B> MetricDescriptor [jvm]class MetricDescriptor : Message<M, B> MetricDescriptor describes a named metric."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily> Companion [jvm]val Companion: Message.Companion metric_descriptor [jvm]val metric_descriptor: MetricFamily.MetricDescriptorDescriptor shared by each metric in this family. metrics [jvm]val metrics: List<MetricFamily.Metric>Metrics in the family, each having a unique set of labels."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-family/","title":"MetricFamily - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-family/#metricfamily","title":"MetricFamily","text":"[jvm]\\ constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>)
constructor(metric_descriptor: MetricFamily.MetricDescriptor, metrics: List<MetricFamily.Metric>, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metric_descriptor/","title":"metric_descriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/metric_descriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metric_descriptor/#metric_descriptor","title":"metric_descriptor","text":"[jvm]\\ val metric_descriptor: MetricFamily.MetricDescriptor
Descriptor shared by each metric in this family.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metrics/","title":"metrics - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/metrics
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/metrics/#metrics","title":"metrics","text":"[jvm]\\ val metrics: List<MetricFamily.Metric>
Metrics in the family, each having a unique set of labels.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#properties","title":"Properties","text":"Name Summary metric_descriptor [jvm]open var metric_descriptor: MetricFamily.MetricDescriptor metrics [jvm]open var metrics: List<MetricFamily.Metric>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter metric_descriptor [jvm]open fun metric_descriptor(metric_descriptor: MetricFamily.MetricDescriptor): MetricFamily.BuilderDescriptor shared by each metric in this family. metrics [jvm]open fun metrics(metrics: List<MetricFamily.Metric>): MetricFamily.BuilderMetrics in the family, each having a unique set of labels. setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metric_descriptor/","title":"metric_descriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/metric_descriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metric_descriptor/#metric_descriptor","title":"metric_descriptor","text":"[jvm]\\ open fun metric_descriptor(metric_descriptor: MetricFamily.MetricDescriptor): MetricFamily.Builder
Descriptor shared by each metric in this family.
[jvm]\\ open var metric_descriptor: MetricFamily.MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metrics/","title":"metrics - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Builder/metrics
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-builder/metrics/#metrics","title":"metrics","text":"[jvm]\\ open fun metrics(metrics: List<MetricFamily.Metric>): MetricFamily.Builder
Metrics in the family, each having a unique set of labels.
[jvm]\\ open var metrics: List<MetricFamily.Metric>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/","title":"Digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#digest","title":"Digest","text":"[jvm]\\ class Digest : Message<M, B>
Digest holds a t-digest of data points observed in a specific time range.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#constructors","title":"Constructors","text":"Digest [jvm]constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData)constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily.Digest> Companion [jvm]val Companion: Message.Companion DEFAULT_END_AT_MS [jvm]val DEFAULT_END_AT_MS: Long DEFAULT_STAGGER [jvm]val DEFAULT_STAGGER: Long DEFAULT_START_AT_MS [jvm]val DEFAULT_START_AT_MS: Long digest_data [jvm]val digest_data: DigestDatat-digest of observed values. end_at_ms [jvm]val end_at_ms: LongEnd time window of data points, exclusive. stagger [jvm]val stagger: LongNumber of overlapping windows. start_at_ms [jvm]val start_at_ms: LongStart time window of data points, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.Digest.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily.Digest>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-e-n-d_-a-t_-m-s/","title":"DEFAULT_END_AT_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/DEFAULT_END_AT_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-e-n-d_-a-t_-m-s/#default_end_at_ms","title":"DEFAULT_END_AT_MS","text":"[jvm]\\ val DEFAULT_END_AT_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-g-g-e-r/","title":"DEFAULT_STAGGER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/DEFAULT_STAGGER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-g-g-e-r/#default_stagger","title":"DEFAULT_STAGGER","text":"[jvm]\\ val DEFAULT_STAGGER: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-r-t_-a-t_-m-s/","title":"DEFAULT_START_AT_MS - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/DEFAULT_START_AT_MS
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-d-e-f-a-u-l-t_-s-t-a-r-t_-a-t_-m-s/#default_start_at_ms","title":"DEFAULT_START_AT_MS","text":"[jvm]\\ val DEFAULT_START_AT_MS: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-digest/","title":"Digest - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-digest/#digest","title":"Digest","text":"[jvm]\\ constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData)
constructor(start_at_ms: Long, end_at_ms: Long, stagger: Long, digest_data: DigestData, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/digest_data/","title":"digest_data - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/digest_data
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/digest_data/#digest_data","title":"digest_data","text":"[jvm]\\ val digest_data: DigestData
t-digest of observed values. The registry and server must agree on the format of the digest.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/end_at_ms/","title":"end_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/end_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/end_at_ms/#end_at_ms","title":"end_at_ms","text":"[jvm]\\ val end_at_ms: Long
End time window of data points, exclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.Digest.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/stagger/","title":"stagger - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/stagger
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/stagger/#stagger","title":"stagger","text":"[jvm]\\ val stagger: Long
Number of overlapping windows. This is not directly related to the data, but is used by the collector to validate that registry and server configurations are compatible.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/start_at_ms/","title":"start_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/start_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/start_at_ms/#start_at_ms","title":"start_at_ms","text":"[jvm]\\ val start_at_ms: Long
Start time window of data points, inclusive.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#properties","title":"Properties","text":"Name Summary digest_data [jvm]open var digest_data: DigestData end_at_ms [jvm]open var end_at_ms: Long stagger [jvm]open var stagger: Long start_at_ms [jvm]open var start_at_ms: Long"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily.Digest buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> digest_data [jvm]open fun digest_data(digest_data: DigestData): MetricFamily.Digest.Buildert-digest of observed values. end_at_ms [jvm]open fun end_at_ms(end_at_ms: Long): MetricFamily.Digest.BuilderEnd time window of data points, exclusive. getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) stagger [jvm]open fun stagger(stagger: Long): MetricFamily.Digest.BuilderNumber of overlapping windows. start_at_ms [jvm]open fun start_at_ms(start_at_ms: Long): MetricFamily.Digest.BuilderStart time window of data points, inclusive."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily.Digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/digest_data/","title":"digest_data - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/digest_data
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/digest_data/#digest_data","title":"digest_data","text":"[jvm]\\ open fun digest_data(digest_data: DigestData): MetricFamily.Digest.Builder
t-digest of observed values. The registry and server must agree on the format of the digest.
[jvm]\\ open var digest_data: DigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/end_at_ms/","title":"end_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/end_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/end_at_ms/#end_at_ms","title":"end_at_ms","text":"[jvm]\\ open fun end_at_ms(end_at_ms: Long): MetricFamily.Digest.Builder
End time window of data points, exclusive.
[jvm]\\ open var end_at_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/stagger/","title":"stagger - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/stagger
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/stagger/#stagger","title":"stagger","text":"[jvm]\\ open fun stagger(stagger: Long): MetricFamily.Digest.Builder
Number of overlapping windows. This is not directly related to the data, but is used by the collector to validate that registry and server configurations are compatible.
[jvm]\\ open var stagger: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/start_at_ms/","title":"start_at_ms - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Digest/Builder/start_at_ms
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-digest/-builder/start_at_ms/#start_at_ms","title":"start_at_ms","text":"[jvm]\\ open fun start_at_ms(start_at_ms: Long): MetricFamily.Digest.Builder
Start time window of data points, inclusive.
[jvm]\\ open var start_at_ms: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/","title":"Metric - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#metric","title":"Metric","text":"[jvm]\\ class Metric : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#constructors","title":"Constructors","text":"Metric [jvm]constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>)constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily.Metric> Companion [jvm]val Companion: Message.Companion digests [jvm]val digests: List<MetricFamily.Digest>t-digests for the metric, each for a different window of time. labels [jvm]val labels: Map<String, String>Label values."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.Metric.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily.Metric>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-metric/","title":"Metric - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Metric
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-metric/#metric","title":"Metric","text":"[jvm]\\ constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>)
constructor(labels: Map<String, String>, digests: List<MetricFamily.Digest>, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/digests/","title":"digests - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/digests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/digests/#digests","title":"digests","text":"[jvm]\\ val digests: List<MetricFamily.Digest>
t-digests for the metric, each for a different window of time.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/labels/","title":"labels - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/labels
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/labels/#labels","title":"labels","text":"[jvm]\\ val labels: Map<String, String>
Label values. There will be one value corresponding to each entry in the MetricDescriptor\u2019s label_names.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.Metric.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#properties","title":"Properties","text":"Name Summary digests [jvm]open var digests: List<MetricFamily.Digest> labels [jvm]open var labels: Map<String, String>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily.Metric buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> digests [jvm]open fun digests(digests: List<MetricFamily.Digest>): MetricFamily.Metric.Buildert-digests for the metric, each for a different window of time. getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter labels [jvm]open fun labels(labels: Map<String, String>): MetricFamily.Metric.BuilderLabel values. setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily.Metric
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/digests/","title":"digests - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/digests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/digests/#digests","title":"digests","text":"[jvm]\\ open fun digests(digests: List<MetricFamily.Digest>): MetricFamily.Metric.Builder
t-digests for the metric, each for a different window of time.
[jvm]\\ open var digests: List<MetricFamily.Digest>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/labels/","title":"labels - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/Metric/Builder/labels
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric/-builder/labels/#labels","title":"labels","text":"[jvm]\\ open fun labels(labels: Map<String, String>): MetricFamily.Metric.Builder
Label values. There will be one value corresponding to each entry in the MetricDescriptor\u2019s label_names.
[jvm]\\ open var labels: Map<String, String>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/","title":"MetricDescriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#metricdescriptor","title":"MetricDescriptor","text":"[jvm]\\ class MetricDescriptor : Message<M, B>
MetricDescriptor describes a named metric.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#constructors","title":"Constructors","text":"MetricDescriptor [jvm]constructor(name: String, help: String)constructor(name: String, help: String, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MetricFamily.MetricDescriptor> Companion [jvm]val Companion: Message.Companion DEFAULT_HELP [jvm]val DEFAULT_HELP: String = \"\" DEFAULT_NAME [jvm]val DEFAULT_NAME: String = \"\" help [jvm]val help: StringUser-friendly description of the metric. name [jvm]val name: StringName of the metric."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MetricFamily.MetricDescriptor.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MetricFamily.MetricDescriptor>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-h-e-l-p/","title":"DEFAULT_HELP - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/DEFAULT_HELP
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-h-e-l-p/#default_help","title":"DEFAULT_HELP","text":"[jvm]\\ val DEFAULT_HELP: String = \"\"
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-n-a-m-e/","title":"DEFAULT_NAME - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/DEFAULT_NAME
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-d-e-f-a-u-l-t_-n-a-m-e/#default_name","title":"DEFAULT_NAME","text":"[jvm]\\ val DEFAULT_NAME: String = \"\"
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-metric-descriptor/","title":"MetricDescriptor - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-metric-descriptor/#metricdescriptor","title":"MetricDescriptor","text":"[jvm]\\ constructor(name: String, help: String)
constructor(name: String, help: String, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/help/","title":"help - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/help
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/help/#help","title":"help","text":"[jvm]\\ val help: String
User-friendly description of the metric.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/name/","title":"name - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/name
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/name/#name","title":"name","text":"[jvm]\\ val name: String
Name of the metric.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MetricFamily.MetricDescriptor.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#properties","title":"Properties","text":"Name Summary help [jvm]open var help: String name [jvm]open var name: String"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MetricFamily.MetricDescriptor buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter help [jvm]open fun help(help: String): MetricFamily.MetricDescriptor.BuilderUser-friendly description of the metric. name [jvm]open fun name(name: String): MetricFamily.MetricDescriptor.BuilderName of the metric. setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MetricFamily.MetricDescriptor
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/help/","title":"help - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/help
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/help/#help","title":"help","text":"[jvm]\\ open fun help(help: String): MetricFamily.MetricDescriptor.Builder
User-friendly description of the metric.
[jvm]\\ open var help: String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/name/","title":"name - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.service/MetricFamily/MetricDescriptor/Builder/name
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.service/-metric-family/-metric-descriptor/-builder/name/#name","title":"name","text":"[jvm]\\ open fun name(name: String): MetricFamily.MetricDescriptor.Builder
Name of the metric.
[jvm]\\ open var name: String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/","title":"Package-level declarations - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/#types","title":"Types","text":"Name Summary Centroid [jvm]class Centroid : Message<M, B> MergingDigestData [jvm]class MergingDigestData : Message<M, B> MergingDigestData contains all fields necessary to generate a MergingDigest."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/","title":"Centroid - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#centroid","title":"Centroid","text":"[jvm]\\ class Centroid : Message<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#constructors","title":"Constructors","text":"Centroid [jvm]constructor(mean: Double, weight: Double, samples: List<Double>)constructor(mean: Double, weight: Double, samples: List<Double>, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<Centroid> Companion [jvm]val Companion: Message.Companion DEFAULT_MEAN [jvm]val DEFAULT_MEAN: Double DEFAULT_WEIGHT [jvm]val DEFAULT_WEIGHT: Double mean [jvm]val mean: Double samples [jvm]val samples: List<Double> weight [jvm]val weight: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): Centroid.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<Centroid>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-centroid/","title":"Centroid - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Centroid
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-centroid/#centroid","title":"Centroid","text":"[jvm]\\ constructor(mean: Double, weight: Double, samples: List<Double>)
constructor(mean: Double, weight: Double, samples: List<Double>, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-m-e-a-n/","title":"DEFAULT_MEAN - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/DEFAULT_MEAN
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-m-e-a-n/#default_mean","title":"DEFAULT_MEAN","text":"[jvm]\\ val DEFAULT_MEAN: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-w-e-i-g-h-t/","title":"DEFAULT_WEIGHT - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/DEFAULT_WEIGHT
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-d-e-f-a-u-l-t_-w-e-i-g-h-t/#default_weight","title":"DEFAULT_WEIGHT","text":"[jvm]\\ val DEFAULT_WEIGHT: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/mean/","title":"mean - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/mean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/mean/#mean","title":"mean","text":"[jvm]\\ val mean: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): Centroid.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/samples/","title":"samples - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/samples
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/samples/#samples","title":"samples","text":"[jvm]\\ val samples: List<Double>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/weight/","title":"weight - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/weight
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/weight/#weight","title":"weight","text":"[jvm]\\ val weight: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#properties","title":"Properties","text":"Name Summary mean [jvm]open var mean: Double samples [jvm]open var samples: List<Double> weight [jvm]open var weight: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): Centroid buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter mean [jvm]open fun mean(mean: Double): Centroid.Builder samples [jvm]open fun samples(samples: List<Double>): Centroid.Builder setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter) weight [jvm]open fun weight(weight: Double): Centroid.Builder"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): Centroid
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/mean/","title":"mean - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/mean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/mean/#mean","title":"mean","text":"[jvm]\\ open fun mean(mean: Double): Centroid.Builder
open var mean: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/samples/","title":"samples - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/samples
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/samples/#samples","title":"samples","text":"[jvm]\\ open fun samples(samples: List<Double>): Centroid.Builder
open var samples: List<Double>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/weight/","title":"weight - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/Centroid/Builder/weight
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-centroid/-builder/weight/#weight","title":"weight","text":"[jvm]\\ open fun weight(weight: Double): Centroid.Builder
open var weight: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/","title":"MergingDigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#mergingdigestdata","title":"MergingDigestData","text":"[jvm]\\ class MergingDigestData : Message<M, B>
MergingDigestData contains all fields necessary to generate a MergingDigest. This type should generally just be used when serializing MergingDigest\u2019s, and doesn\u2019t have much of a purpose on its own. Replica of stripe\u2019s tdigest implementation https://github.com/stripe/veneur/blob/master/tdigest/tdigest.proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#constructors","title":"Constructors","text":"MergingDigestData [jvm]constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double)constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double, unknownFields: ByteString)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#types","title":"Types","text":"Name Summary Builder [jvm]class Builder : Message.Builder<M, B>"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#properties","title":"Properties","text":"Name Summary ADAPTER [jvm]val ADAPTER: ProtoAdapter<MergingDigestData> Companion [jvm]val Companion: Message.Companion compression [jvm]val compression: Double DEFAULT_COMPRESSION [jvm]val DEFAULT_COMPRESSION: Double DEFAULT_MAX [jvm]val DEFAULT_MAX: Double DEFAULT_MIN [jvm]val DEFAULT_MIN: Double main_centroids [jvm]val main_centroids: List<Centroid> max [jvm]val max: Double min [jvm]val min: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/#functions","title":"Functions","text":"Name Summary adapter [jvm]fun adapter(): ProtoAdapter<M> encode [jvm]fun encode(): Array<Byte>fun encode(sink: BufferedSink) encodeByteString [jvm]fun encodeByteString(): ByteString equals [jvm]open fun equals(other: Any): Boolean getCachedSerializedSize$wire_runtime [jvm]fun getCachedSerializedSize$wire_runtime(): Int hashCode [jvm]open fun hashCode(): Int newBuilder [jvm]open fun newBuilder(): MergingDigestData.Builder setCachedSerializedSize$wire_runtime [jvm]fun setCachedSerializedSize$wire_runtime(p: Int) toString [jvm]open fun toString(): String unknownFields [jvm]fun unknownFields(): ByteString withoutUnknownFields [jvm]fun withoutUnknownFields(): M"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-a-d-a-p-t-e-r/","title":"ADAPTER - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/ADAPTER
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-a-d-a-p-t-e-r/#adapter","title":"ADAPTER","text":"[jvm]\\ val ADAPTER: ProtoAdapter<MergingDigestData>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-c-o-m-p-r-e-s-s-i-o-n/","title":"DEFAULT_COMPRESSION - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/DEFAULT_COMPRESSION
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-c-o-m-p-r-e-s-s-i-o-n/#default_compression","title":"DEFAULT_COMPRESSION","text":"[jvm]\\ val DEFAULT_COMPRESSION: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-a-x/","title":"DEFAULT_MAX - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/DEFAULT_MAX
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-a-x/#default_max","title":"DEFAULT_MAX","text":"[jvm]\\ val DEFAULT_MAX: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-i-n/","title":"DEFAULT_MIN - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/DEFAULT_MIN
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-d-e-f-a-u-l-t_-m-i-n/#default_min","title":"DEFAULT_MIN","text":"[jvm]\\ val DEFAULT_MIN: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-merging-digest-data/","title":"MergingDigestData - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/MergingDigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-merging-digest-data/#mergingdigestdata","title":"MergingDigestData","text":"[jvm]\\ constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double)
constructor(main_centroids: List<Centroid>, compression: Double, min: Double, max: Double, unknownFields: ByteString)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/compression/","title":"compression - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/compression
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/compression/#compression","title":"compression","text":"[jvm]\\ val compression: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/equals/","title":"equals - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/equals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/equals/#equals","title":"equals","text":"[jvm]\\ open fun equals(other: Any): Boolean
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/hash-code/","title":"hashCode - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/hashCode
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open fun hashCode(): Int
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/main_centroids/","title":"main_centroids - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/main_centroids
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/main_centroids/#main_centroids","title":"main_centroids","text":"[jvm]\\ val main_centroids: List<Centroid>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/max/","title":"max - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/max
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/max/#max","title":"max","text":"[jvm]\\ val max: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/min/","title":"min - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/min
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/min/#min","title":"min","text":"[jvm]\\ val min: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/new-builder/","title":"newBuilder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/newBuilder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/new-builder/#newbuilder","title":"newBuilder","text":"[jvm]\\ open fun newBuilder(): MergingDigestData.Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/to-string/","title":"toString - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/toString
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/to-string/#tostring","title":"toString","text":"[jvm]\\ open fun toString(): String
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#builder","title":"Builder","text":"[jvm]\\ class Builder : Message.Builder<M, B>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#constructors","title":"Constructors","text":"Builder [jvm]constructor()"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#properties","title":"Properties","text":"Name Summary compression [jvm]open var compression: Double main_centroids [jvm]open var main_centroids: List<Centroid> max [jvm]open var max: Double min [jvm]open var min: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/#functions","title":"Functions","text":"Name Summary addUnknownField [jvm]fun addUnknownField(tag: Int, fieldEncoding: FieldEncoding, value: Any): Message.Builder<M, B> addUnknownFields [jvm]fun addUnknownFields(unknownFields: ByteString): Message.Builder<M, B> build [jvm]open fun build(): MergingDigestData buildUnknownFields [jvm]fun buildUnknownFields(): ByteString clearUnknownFields [jvm]fun clearUnknownFields(): Message.Builder<M, B> compression [jvm]open fun compression(compression: Double): MergingDigestData.Builder getUnknownFieldsBuffer$wire_runtime [jvm]fun getUnknownFieldsBuffer$wire_runtime(): Buffer getUnknownFieldsByteString$wire_runtime [jvm]fun getUnknownFieldsByteString$wire_runtime(): ByteString getUnknownFieldsWriter$wire_runtime [jvm]fun getUnknownFieldsWriter$wire_runtime(): ProtoWriter main_centroids [jvm]open fun main_centroids(main_centroids: List<Centroid>): MergingDigestData.Builder max [jvm]open fun max(max: Double): MergingDigestData.Builder min [jvm]open fun min(min: Double): MergingDigestData.Builder setUnknownFieldsBuffer$wire_runtime [jvm]fun setUnknownFieldsBuffer$wire_runtime(p: Buffer) setUnknownFieldsByteString$wire_runtime [jvm]fun setUnknownFieldsByteString$wire_runtime(p: ByteString) setUnknownFieldsWriter$wire_runtime [jvm]fun setUnknownFieldsWriter$wire_runtime(p: ProtoWriter)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/-builder/","title":"Builder - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/Builder
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/-builder/#builder","title":"Builder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/build/","title":"build - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/build
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/build/#build","title":"build","text":"[jvm]\\ open fun build(): MergingDigestData
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/compression/","title":"compression - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/compression
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/compression/#compression","title":"compression","text":"[jvm]\\ open fun compression(compression: Double): MergingDigestData.Builder
open var compression: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/main_centroids/","title":"main_centroids - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/main_centroids
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/main_centroids/#main_centroids","title":"main_centroids","text":"[jvm]\\ open fun main_centroids(main_centroids: List<Centroid>): MergingDigestData.Builder
open var main_centroids: List<Centroid>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/max/","title":"max - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/max
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/max/#max","title":"max","text":"[jvm]\\ open fun max(max: Double): MergingDigestData.Builder
open var max: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/min/","title":"min - Misk","text":"//misk-metrics-digester/com.squareup.digester.protos.tdigest/MergingDigestData/Builder/min
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/com.squareup.digester.protos.tdigest/-merging-digest-data/-builder/min/#min","title":"min","text":"[jvm]\\ open fun min(min: Double): MergingDigestData.Builder
open var min: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/","title":"Package-level declarations - Misk","text":"//misk-metrics-digester/misk.metrics.digester
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/#types","title":"Types","text":"Name Summary FakeDigest [jvm]class FakeDigest : TDigest<FakeDigest> Simulates VeneurDigest for testing purposes MergingDigest [jvm]class MergingDigest(compression: Double)Provides an implementation of t-digest to be used to send histogram data SlidingWindowDigest [jvm]class SlidingWindowDigest<T : TDigest<T>>@JvmOverloadsconstructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())SlidingWindowDigest approximates quantiles of data for a trailing time period. It is thread-safe. Snapshot [jvm]data class Snapshot(val quantileVals: List<Double>, val count: Long, val sum: Double)Snapshot is the state of a SlidingWindowDigest at a point in time. TDigest [jvm]interface TDigest<T : TDigest<T>>TDigest abstract common methods for t-digest implementations VeneurDigest [jvm]class VeneurDigest : TDigest<VeneurDigest> Wraps an adapted t-digest implementation from Stripe\u2019s Veneur project Window [jvm]data class Window(val start: ZonedDateTime, val end: ZonedDateTime)Window represents a time range WindowDigest [jvm]data class WindowDigest<T : TDigest<T>>(val window: Window, val digest: T)WindowDigest holds a t-digest whose data points are scoped to a specific time window. Windower [jvm]class Windower(windowSecs: Int, stagger: Int)Windower contains multiple windows with a specified duration"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/","title":"FakeDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/#fakedigest","title":"FakeDigest","text":"[jvm]\\ class FakeDigest : TDigest<FakeDigest>
Simulates VeneurDigest for testing purposes
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/#constructors","title":"Constructors","text":"FakeDigest [jvm]constructor()constructor(values: List<Double>)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(value: Double)Adds a new observation to the t-digest count [jvm]open override fun count(): LongReturns the count of the number of observations recorded within the t-digest mergeInto [jvm]open override fun mergeInto(other: FakeDigest)Merges this t-digest into another t-digest proto [jvm]open override fun proto(): DigestDataReturns a representation fo the t-digest that can be later be reconstituted into an instance of the same type quantile [jvm]open override fun quantile(quantile: Double): DoubleQuantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned. sum [jvm]open override fun sum(): DoubleReturns the sum of all values added into the digest, or NaN if no values have been added"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/-fake-digest/","title":"FakeDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/FakeDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/-fake-digest/#fakedigest","title":"FakeDigest","text":"[jvm]\\ constructor()
constructor(values: List<Double>)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/add/#add","title":"add","text":"[jvm]\\ open override fun add(value: Double)
Adds a new observation to the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/count/#count","title":"count","text":"[jvm]\\ open override fun count(): Long
Returns the count of the number of observations recorded within the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/merge-into/","title":"mergeInto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/mergeInto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/merge-into/#mergeinto","title":"mergeInto","text":"[jvm]\\ open override fun mergeInto(other: FakeDigest)
Merges this t-digest into another t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/proto/","title":"proto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/proto/#proto","title":"proto","text":"[jvm]\\ open override fun proto(): DigestData
Returns a representation fo the t-digest that can be later be reconstituted into an instance of the same type
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ open override fun quantile(quantile: Double): Double
Quantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/FakeDigest/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-fake-digest/sum/#sum","title":"sum","text":"[jvm]\\ open override fun sum(): Double
Returns the sum of all values added into the digest, or NaN if no values have been added
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/","title":"MergingDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/#mergingdigest","title":"MergingDigest","text":"[jvm]\\ class MergingDigest(compression: Double)
Provides an implementation of t-digest to be used to send histogram data
Direct port of Veneur digest created by Stripe https://github.com/stripe/veneur/blob/master/tdigest/merging_digest.go
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/#constructors","title":"Constructors","text":"MergingDigest [jvm]constructor(mergingDigestData: MergingDigestData)Constructs a MergingDigest with values initialized from MergingDigestData. This should be the way to generate a MergingDigest from a serialized protobuf.constructor(compression: Double)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(value: Double, weight: Double)Adds a new value to the t-digest, with a given weight that must be positive. Infinities and NaN cannot be added. data [jvm]fun data(): MergingDigestDataMergingDigestData contains all fields necessary to generate a MergingDigest. This type should generally just be used when serializing MergingDigest\u2019s, and doesn\u2019t have much of a purpose on its own. mergeFrom [jvm]fun mergeFrom(other: MergingDigest)Merge another digest into this one. Neither td nor other can be shared concurrently during the execution of this method. quantile [jvm]fun quantile(quantile: Double): DoubleReturns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/-merging-digest/","title":"MergingDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/MergingDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/-merging-digest/#mergingdigest","title":"MergingDigest","text":"[jvm]\\ constructor(mergingDigestData: MergingDigestData)
Constructs a MergingDigest with values initialized from MergingDigestData. This should be the way to generate a MergingDigest from a serialized protobuf.
[jvm]\\ constructor(compression: Double)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/add/#add","title":"add","text":"[jvm]\\ fun add(value: Double, weight: Double)
Adds a new value to the t-digest, with a given weight that must be positive. Infinities and NaN cannot be added.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/data/","title":"data - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/data
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/data/#data","title":"data","text":"[jvm]\\ fun data(): MergingDigestData
MergingDigestData contains all fields necessary to generate a MergingDigest. This type should generally just be used when serializing MergingDigest\u2019s, and doesn\u2019t have much of a purpose on its own.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/merge-from/","title":"mergeFrom - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/mergeFrom
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/merge-from/#mergefrom","title":"mergeFrom","text":"[jvm]\\ fun mergeFrom(other: MergingDigest)
Merge another digest into this one. Neither td nor other can be shared concurrently during the execution of this method.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/MergingDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-merging-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ fun quantile(quantile: Double): Double
Returns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/","title":"SlidingWindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/#slidingwindowdigest","title":"SlidingWindowDigest","text":"[jvm]\\ class SlidingWindowDigest<T : TDigest<T>>@JvmOverloadsconstructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())
SlidingWindowDigest approximates quantiles of data for a trailing time period. It is thread-safe.
To efficiently store observed data in a mergeable way, t-openDigests are used. As t-openDigests do not support discarding older data points, the sliding window aspect is approximated by keeping multiple separate t-openDigests scoped to discrete overlapping time windows. As a result, quantile data is reported from the most recent window that has ended.
The following example creates a 1 minute sliding window where there are 6 overlapping windows at a given time. Reported quantiles are at most 10 seconds out of date. SlidingWindowDigest(Windower(60, 6), fun() = VeneurDigest())
The following example creates a 10 second sliding window where there are 2 overlapping windows at a given time. Reported quantiles are at most 5 seconds out of date: NewSlidingWindowDigest(Windower(10, 2), fun() = VeneurDigest())
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/#constructors","title":"Constructors","text":"SlidingWindowDigest [jvm]@JvmOverloadsconstructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/#functions","title":"Functions","text":"Name Summary closedDigests [jvm]@Synchronizedfun closedDigests(from: ZonedDateTime): List<WindowDigest<T>>Returns all WindowDigests that ended starting from the given time (inclusive). The returned WindowDigest are ordered by their start time. mergeIn [jvm]@Synchronizedfun mergeIn(windowDigests: List<WindowDigest<T>>)Merges in the data from the given WindowDigests. The given windowDigests should use the same windowing boundaries as this; if they do not then quantiles reported by this sliding window digest may be incorrect. observe [jvm]@Synchronizedfun observe(value: Double)Adds the given value to all currently open t-openDigests. It is important to note that an observed value is not immediately reflected in calls to Quantile. openDigests [jvm]fun openDigests(gc: Boolean): List<WindowDigest<T>>Returns all WindowDigests that are currently open, creating new windows if necessary. Older openDigests that ended more than 1 minute earlier are discarded if gc is true. quantile [jvm]@Synchronizedfun quantile(quantile: Double): DoubleReturns estimated value for a quantile. The returned value may not include recently observed values due to how sliding windows are approximated. If no data has been observed then NaN is returned. snapshot [jvm]@Synchronizedfun snapshot(quantiles: List<Double>): SnapshotReturns a snapshot of estimated values for quantiles, along with the count of observations and their sum. The returned values may not include recent observations due to how sliding windows are approximated. If no data has been observed then a slice of NaNs of having quantiles.count() is returned and NaN is returned for the sum."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/-sliding-window-digest/","title":"SlidingWindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/SlidingWindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/-sliding-window-digest/#slidingwindowdigest","title":"SlidingWindowDigest","text":"[jvm]\\
@JvmOverloads
constructor(windower: Windower, tDigest: () -> T, utcNowClock: Clock = Clock.systemUTC())
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/closed-digests/","title":"closedDigests - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/closedDigests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/closed-digests/#closeddigests","title":"closedDigests","text":"[jvm]\\
@Synchronized
fun closedDigests(from: ZonedDateTime): List<WindowDigest<T>>
Returns all WindowDigests that ended starting from the given time (inclusive). The returned WindowDigest are ordered by their start time.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/merge-in/","title":"mergeIn - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/mergeIn
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/merge-in/#mergein","title":"mergeIn","text":"[jvm]\\
@Synchronized
fun mergeIn(windowDigests: List<WindowDigest<T>>)
Merges in the data from the given WindowDigests. The given windowDigests should use the same windowing boundaries as this; if they do not then quantiles reported by this sliding window digest may be incorrect.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/observe/","title":"observe - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/observe
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/observe/#observe","title":"observe","text":"[jvm]\\
@Synchronized
fun observe(value: Double)
Adds the given value to all currently open t-openDigests. It is important to note that an observed value is not immediately reflected in calls to Quantile.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/open-digests/","title":"openDigests - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/openDigests
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/open-digests/#opendigests","title":"openDigests","text":"[jvm]\\ fun openDigests(gc: Boolean): List<WindowDigest<T>>
Returns all WindowDigests that are currently open, creating new windows if necessary. Older openDigests that ended more than 1 minute earlier are discarded if gc is true.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\
@Synchronized
fun quantile(quantile: Double): Double
Returns estimated value for a quantile. The returned value may not include recently observed values due to how sliding windows are approximated. If no data has been observed then NaN is returned.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/snapshot/","title":"snapshot - Misk","text":"//misk-metrics-digester/misk.metrics.digester/SlidingWindowDigest/snapshot
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-sliding-window-digest/snapshot/#snapshot","title":"snapshot","text":"[jvm]\\
@Synchronized
fun snapshot(quantiles: List<Double>): Snapshot
Returns a snapshot of estimated values for quantiles, along with the count of observations and their sum. The returned values may not include recent observations due to how sliding windows are approximated. If no data has been observed then a slice of NaNs of having quantiles.count() is returned and NaN is returned for the sum.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/","title":"Snapshot - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\ data class Snapshot(val quantileVals: List<Double>, val count: Long, val sum: Double)
Snapshot is the state of a SlidingWindowDigest at a point in time.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/#constructors","title":"Constructors","text":"Snapshot [jvm]constructor(quantileVals: List<Double>, count: Long, sum: Double)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/#properties","title":"Properties","text":"Name Summary count [jvm]val count: Long quantileVals [jvm]val quantileVals: List<Double> sum [jvm]val sum: Double"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/-snapshot/","title":"Snapshot - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/Snapshot
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/-snapshot/#snapshot","title":"Snapshot","text":"[jvm]\\ constructor(quantileVals: List<Double>, count: Long, sum: Double)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/count/#count","title":"count","text":"[jvm]\\ val count: Long
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/quantile-vals/","title":"quantileVals - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/quantileVals
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/quantile-vals/#quantilevals","title":"quantileVals","text":"[jvm]\\ val quantileVals: List<Double>
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Snapshot/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-snapshot/sum/#sum","title":"sum","text":"[jvm]\\ val sum: Double
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/","title":"TDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/#tdigest","title":"TDigest","text":"interface TDigest<T : TDigest<T>>
TDigest abstract common methods for t-digest implementations
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/#inheritors","title":"Inheritors","text":"FakeDigest VeneurDigest"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/#functions","title":"Functions","text":"Name Summary add [jvm]abstract fun add(value: Double)Adds an observed value to the digest. count [jvm]abstract fun count(): LongReturns the count of values added into the digest. mergeInto [jvm]abstract fun mergeInto(other: T)MergeInto merges the data in this digest into the other digest. The other digest is mutated and must be of the same TDigest type. proto [jvm]abstract fun proto(): DigestDataProto returns a representation of the t-digest that can be later reconstituted into an instance of the same type. quantile [jvm]abstract fun quantile(quantile: Double): DoubleQuantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned. sum [jvm]abstract fun sum(): DoubleReturns the sum of all values added into the digest, or NaN if no values have been added."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/add/#add","title":"add","text":"[jvm]\\ abstract fun add(value: Double)
Adds an observed value to the digest.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/count/#count","title":"count","text":"[jvm]\\ abstract fun count(): Long
Returns the count of values added into the digest.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/merge-into/","title":"mergeInto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/mergeInto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/merge-into/#mergeinto","title":"mergeInto","text":"[jvm]\\ abstract fun mergeInto(other: T)
MergeInto merges the data in this digest into the other digest. The other digest is mutated and must be of the same TDigest type.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/proto/","title":"proto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/proto/#proto","title":"proto","text":"[jvm]\\ abstract fun proto(): DigestData
Proto returns a representation of the t-digest that can be later reconstituted into an instance of the same type.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ abstract fun quantile(quantile: Double): Double
Quantile returns the estimated value at quantile. A given quantile should be in the range of 0, 1.0. If no data has been added then NaN is returned.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/TDigest/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-t-digest/sum/#sum","title":"sum","text":"[jvm]\\ abstract fun sum(): Double
Returns the sum of all values added into the digest, or NaN if no values have been added.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/","title":"VeneurDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/#veneurdigest","title":"VeneurDigest","text":"[jvm]\\ class VeneurDigest : TDigest<VeneurDigest>
Wraps an adapted t-digest implementation from Stripe\u2019s Veneur project
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/#constructors","title":"Constructors","text":"VeneurDigest [jvm]constructor()Creates a TDigest backed by a VeneurDigest, using a default compression levelconstructor(digestData: DigestData)Creates a VeneurDigest from a DigestData proto The DigestData proto must have veneur_digest set correctly"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/#functions","title":"Functions","text":"Name Summary add [jvm]open override fun add(value: Double)Adds a new observation to the t-digest count [jvm]open override fun count(): LongReturns the count of the number of observations recorded within the t-digest mergeInto [jvm]open override fun mergeInto(other: VeneurDigest)Merges this t-digest into another t-digest mergingDigest [jvm]fun mergingDigest(): MergingDigestReturns the mergingDigest instance proto [jvm]open override fun proto(): DigestDataReturns a representation fo the t-digest that can be later be reconstituted into an instance of the same type quantile [jvm]open override fun quantile(quantile: Double): DoubleReturns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty. sum [jvm]open override fun sum(): DoubleReturns the sum of all values added into the digest, or NaN if no values have been added"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/-veneur-digest/","title":"VeneurDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/VeneurDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/-veneur-digest/#veneurdigest","title":"VeneurDigest","text":"[jvm]\\ constructor()
Creates a TDigest backed by a VeneurDigest, using a default compression level
[jvm]\\ constructor(digestData: DigestData)
Creates a VeneurDigest from a DigestData proto The DigestData proto must have veneur_digest set correctly
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/add/","title":"add - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/add
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/add/#add","title":"add","text":"[jvm]\\ open override fun add(value: Double)
Adds a new observation to the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/count/","title":"count - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/count
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/count/#count","title":"count","text":"[jvm]\\ open override fun count(): Long
Returns the count of the number of observations recorded within the t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merge-into/","title":"mergeInto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/mergeInto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merge-into/#mergeinto","title":"mergeInto","text":"[jvm]\\ open override fun mergeInto(other: VeneurDigest)
Merges this t-digest into another t-digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merging-digest/","title":"mergingDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/mergingDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/merging-digest/#mergingdigest","title":"mergingDigest","text":"[jvm]\\ fun mergingDigest(): MergingDigest
Returns the mergingDigest instance
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/proto/","title":"proto - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/proto
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/proto/#proto","title":"proto","text":"[jvm]\\ open override fun proto(): DigestData
Returns a representation fo the t-digest that can be later be reconstituted into an instance of the same type
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/quantile/","title":"quantile - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/quantile
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/quantile/#quantile","title":"quantile","text":"[jvm]\\ open override fun quantile(quantile: Double): Double
Returns a value such that the fraction of values in td below that value is approximately equal to quantile. Returns NaN if the digest is empty.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/sum/","title":"sum - Misk","text":"//misk-metrics-digester/misk.metrics.digester/VeneurDigest/sum
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-veneur-digest/sum/#sum","title":"sum","text":"[jvm]\\ open override fun sum(): Double
Returns the sum of all values added into the digest, or NaN if no values have been added
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/","title":"Window - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#window","title":"Window","text":"[jvm]\\ data class Window(val start: ZonedDateTime, val end: ZonedDateTime)
Window represents a time range
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#constructors","title":"Constructors","text":"Window [jvm]constructor(start: ZonedDateTime, end: ZonedDateTime)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#properties","title":"Properties","text":"Name Summary end [jvm]val end: ZonedDateTime start [jvm]val start: ZonedDateTime"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/#functions","title":"Functions","text":"Name Summary contains [jvm]fun contains(t: ZonedDateTime): BooleanReturns true if the given time t falls within the window\u2019s Start <= t < End."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/-window/","title":"Window - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/Window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/-window/#window","title":"Window","text":"[jvm]\\ constructor(start: ZonedDateTime, end: ZonedDateTime)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/contains/","title":"contains - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/contains
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/contains/#contains","title":"contains","text":"[jvm]\\ fun contains(t: ZonedDateTime): Boolean
Returns true if the given time t falls within the window\u2019s Start <= t < End.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/end/","title":"end - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/end
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/end/#end","title":"end","text":"[jvm]\\ val end: ZonedDateTime
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/start/","title":"start - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Window/start
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window/start/#start","title":"start","text":"[jvm]\\ val start: ZonedDateTime
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/","title":"WindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/#windowdigest","title":"WindowDigest","text":"[jvm]\\ data class WindowDigest<T : TDigest<T>>(val window: Window, val digest: T)
WindowDigest holds a t-digest whose data points are scoped to a specific time window.
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/#constructors","title":"Constructors","text":"WindowDigest [jvm]constructor(window: Window, digest: T)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/#properties","title":"Properties","text":"Name Summary digest [jvm]val digest: T window [jvm]val window: Window"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/-window-digest/","title":"WindowDigest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest/WindowDigest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/-window-digest/#windowdigest","title":"WindowDigest","text":"[jvm]\\ constructor(window: Window, digest: T)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/digest/","title":"digest - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest/digest
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/digest/#digest","title":"digest","text":"[jvm]\\ val digest: T
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/window/","title":"window - Misk","text":"//misk-metrics-digester/misk.metrics.digester/WindowDigest/window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-window-digest/window/#window","title":"window","text":"[jvm]\\ val window: Window
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/","title":"Windower - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Windower
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/#windower","title":"Windower","text":"[jvm]\\ class Windower(windowSecs: Int, stagger: Int)
Windower contains multiple windows with a specified duration
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/#constructors","title":"Constructors","text":"Windower [jvm]constructor(windowSecs: Int, stagger: Int)"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/#functions","title":"Functions","text":"Name Summary windowsContaining [jvm]fun windowsContaining(t: ZonedDateTime): List<Window>Returns all windows that the given time falls into. The returned slice will be ordered by window start time, and the number of windows in the returned slice will the same as the stagger given when the Windower was created."},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/-windower/","title":"Windower - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Windower/Windower
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/-windower/#windower","title":"Windower","text":"[jvm]\\ constructor(windowSecs: Int, stagger: Int)
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/windows-containing/","title":"windowsContaining - Misk","text":"//misk-metrics-digester/misk.metrics.digester/Windower/windowsContaining
"},{"location":"0.x/misk-metrics-digester/misk-metrics-digester/misk.metrics.digester/-windower/windows-containing/#windowscontaining","title":"windowsContaining","text":"[jvm]\\ fun windowsContaining(t: ZonedDateTime): List<Window>
Returns all windows that the given time falls into. The returned slice will be ordered by window start time, and the number of windows in the returned slice will the same as the stagger given when the Windower was created.
"},{"location":"0.x/misk-policy/","title":"misk-policy - Misk","text":"//misk-policy
"},{"location":"0.x/misk-policy/#misk-policy","title":"misk-policy","text":""},{"location":"0.x/misk-policy/#packages","title":"Packages","text":"Name misk.policy.opa"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/","title":"Package-level declarations - Misk","text":"//misk-policy/misk.policy.opa
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/#types","title":"Types","text":"Name Summary Metrics [jvm]data class Metrics(val counter_server_query_cache_hit: Long, val timer_rego_external_resolve_ns: Long, val timer_rego_input_parse_ns: Long, val timer_rego_query_eval_ns: Long, val timer_server_handler_ns: Long) MiskOpaMetrics [jvm]@Singletonclass MiskOpaMetrics@Injectconstructor(metrics: Metrics) : OpaMetricsMaps OpaResponse.metrics into prometheus counters and histograms. OpaApi [jvm]interface OpaApi OpaConfig [jvm]data class OpaConfig@JvmOverloadsconstructor(val baseUrl: String, val unixSocket: String?, val provenance: Boolean = false, val metrics: Boolean = true) : Config OpaMetrics [jvm]interface OpaMetrics OpaModule [jvm]class OpaModule@Injectconstructor(config: OpaConfig) : KAbstractModule OpaPolicyEngine [jvm]interface OpaPolicyEngine OpaRequest [jvm]abstract class OpaRequest OpaResponse [jvm]abstract class OpaResponse PolicyEngineException [jvm]class PolicyEngineException@JvmOverloadsconstructor(message: String, cause: Throwable? = null) : Exception Provenance [jvm]data class Provenance(val version: String?, val build_commit: String?, val build_timestamp: String?, val build_hostname: String?, val revision: String?, val bundles: Map<String, ProvenanceBundle>?) ProvenanceBundle [jvm]data class ProvenanceBundle(val revision: String?) RealOpaPolicyEngine [jvm]class RealOpaPolicyEngine@Injectconstructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig) : OpaPolicyEngineSupport for the Open Policy Engine (OPA). OPA provides a means to decouple policy from business logic. The resulting query response may have arbitrary shapes. Request [jvm]data class Request<T>(val input: T)OPA Request wrapper. Response [jvm]data class Response<T>(val decision_id: String?, val result: T?, val provenance: Provenance?, val metrics: Metrics?)OPA Response wrapper. Every response has this standard shape, made concrete by the expected response type."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/#functions","title":"Functions","text":"Name Summary evaluate [jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/","title":"evaluate - Misk","text":"//misk-policy/misk.policy.opa/evaluate
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#evaluate","title":"evaluate","text":"[jvm]\\ inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): R
Evaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified.[jvm]\\ inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): R
Evaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#return_1","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#parameters_1","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time (the input global field)."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#throws_1","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified.[jvm]\\ inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): R
Evaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#return_2","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#parameters_2","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time. Must be valid JSON."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/evaluate/#throws_2","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/","title":"Metrics - Misk","text":"//misk-policy/misk.policy.opa/Metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/#metrics","title":"Metrics","text":"[jvm]\\ data class Metrics(val counter_server_query_cache_hit: Long, val timer_rego_external_resolve_ns: Long, val timer_rego_input_parse_ns: Long, val timer_rego_query_eval_ns: Long, val timer_server_handler_ns: Long)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/#constructors","title":"Constructors","text":"Metrics [jvm]constructor(counter_server_query_cache_hit: Long, timer_rego_external_resolve_ns: Long, timer_rego_input_parse_ns: Long, timer_rego_query_eval_ns: Long, timer_server_handler_ns: Long)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/#properties","title":"Properties","text":"Name Summary counter_server_query_cache_hit [jvm]val counter_server_query_cache_hit: Long timer_rego_external_resolve_ns [jvm]val timer_rego_external_resolve_ns: Long timer_rego_input_parse_ns [jvm]val timer_rego_input_parse_ns: Long timer_rego_query_eval_ns [jvm]val timer_rego_query_eval_ns: Long timer_server_handler_ns [jvm]val timer_server_handler_ns: Long"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/-metrics/","title":"Metrics - Misk","text":"//misk-policy/misk.policy.opa/Metrics/Metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/-metrics/#metrics","title":"Metrics","text":"[jvm]\\ constructor(counter_server_query_cache_hit: Long, timer_rego_external_resolve_ns: Long, timer_rego_input_parse_ns: Long, timer_rego_query_eval_ns: Long, timer_server_handler_ns: Long)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/counter_server_query_cache_hit/","title":"counter_server_query_cache_hit - Misk","text":"//misk-policy/misk.policy.opa/Metrics/counter_server_query_cache_hit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/counter_server_query_cache_hit/#counter_server_query_cache_hit","title":"counter_server_query_cache_hit","text":"[jvm]\\ val counter_server_query_cache_hit: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_external_resolve_ns/","title":"timer_rego_external_resolve_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_rego_external_resolve_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_external_resolve_ns/#timer_rego_external_resolve_ns","title":"timer_rego_external_resolve_ns","text":"[jvm]\\ val timer_rego_external_resolve_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_input_parse_ns/","title":"timer_rego_input_parse_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_rego_input_parse_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_input_parse_ns/#timer_rego_input_parse_ns","title":"timer_rego_input_parse_ns","text":"[jvm]\\ val timer_rego_input_parse_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_query_eval_ns/","title":"timer_rego_query_eval_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_rego_query_eval_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_rego_query_eval_ns/#timer_rego_query_eval_ns","title":"timer_rego_query_eval_ns","text":"[jvm]\\ val timer_rego_query_eval_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_server_handler_ns/","title":"timer_server_handler_ns - Misk","text":"//misk-policy/misk.policy.opa/Metrics/timer_server_handler_ns
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-metrics/timer_server_handler_ns/#timer_server_handler_ns","title":"timer_server_handler_ns","text":"[jvm]\\ val timer_server_handler_ns: Long
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/","title":"MiskOpaMetrics - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/#miskopametrics","title":"MiskOpaMetrics","text":"[jvm]\\ @Singleton
class MiskOpaMetrics@Injectconstructor(metrics: Metrics) : OpaMetrics
Maps OpaResponse.metrics into prometheus counters and histograms.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/#constructors","title":"Constructors","text":"MiskOpaMetrics [jvm]@Injectconstructor(metrics: Metrics)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/#functions","title":"Functions","text":"Name Summary evaluated [jvm]open override fun evaluated(document: String)Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not. observe [jvm]open override fun observe(document: String, response: OpaResponse)Dispatches OpaResponse.metrics into the prometheus client."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/-misk-opa-metrics/","title":"MiskOpaMetrics - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics/MiskOpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/-misk-opa-metrics/#miskopametrics","title":"MiskOpaMetrics","text":"[jvm]\\
@Inject
constructor(metrics: Metrics)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/evaluated/","title":"evaluated - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics/evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/evaluated/#evaluated","title":"evaluated","text":"[jvm]\\ open override fun evaluated(document: String)
Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/observe/","title":"observe - Misk","text":"//misk-policy/misk.policy.opa/MiskOpaMetrics/observe
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-misk-opa-metrics/observe/#observe","title":"observe","text":"[jvm]\\ open override fun observe(document: String, response: OpaResponse)
Dispatches OpaResponse.metrics into the prometheus client.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/","title":"OpaApi - Misk","text":"//misk-policy/misk.policy.opa/OpaApi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/#opaapi","title":"OpaApi","text":"[jvm]\\ interface OpaApi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/#functions","title":"Functions","text":"Name Summary queryDocument [jvm]@Headers(value = [\"Content-Type: application/json\"])@POST(value = \"/v1/data/{documentPath}\")abstract fun queryDocument(@Path(value = \"documentPath\", encoded = true)documentPath: String, @Bodyinput: String, @Query(value = \"provenance\")provenance: Boolean, @Query(value = \"metrics\")metrics: Boolean): Call<ResponseBody>"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/query-document/","title":"queryDocument - Misk","text":"//misk-policy/misk.policy.opa/OpaApi/queryDocument
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-api/query-document/#querydocument","title":"queryDocument","text":"[jvm]\\
@Headers(value = [\"Content-Type: application/json\"])
@POST(value = \"/v1/data/{documentPath}\")
abstract fun queryDocument(@Path(value = \"documentPath\", encoded = true)documentPath: String, @Bodyinput: String, @Query(value = \"provenance\")provenance: Boolean, @Query(value = \"metrics\")metrics: Boolean): Call<ResponseBody>
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/","title":"OpaConfig - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/#opaconfig","title":"OpaConfig","text":"[jvm]\\ data class OpaConfig@JvmOverloadsconstructor(val baseUrl: String, val unixSocket: String?, val provenance: Boolean = false, val metrics: Boolean = true) : Config
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/#constructors","title":"Constructors","text":"OpaConfig [jvm]@JvmOverloadsconstructor(baseUrl: String, unixSocket: String?, provenance: Boolean = false, metrics: Boolean = true)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/#properties","title":"Properties","text":"Name Summary baseUrl [jvm]val baseUrl: String metrics [jvm]val metrics: Boolean = true provenance [jvm]val provenance: Boolean = false unixSocket [jvm]val unixSocket: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/-opa-config/","title":"OpaConfig - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/OpaConfig
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/-opa-config/#opaconfig","title":"OpaConfig","text":"[jvm]\\
@JvmOverloads
constructor(baseUrl: String, unixSocket: String?, provenance: Boolean = false, metrics: Boolean = true)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/base-url/","title":"baseUrl - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/baseUrl
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/base-url/#baseurl","title":"baseUrl","text":"[jvm]\\ val baseUrl: String
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/metrics/","title":"metrics - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/metrics/#metrics","title":"metrics","text":"[jvm]\\ val metrics: Boolean = true
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/provenance/","title":"provenance - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/provenance/#provenance","title":"provenance","text":"[jvm]\\ val provenance: Boolean = false
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/unix-socket/","title":"unixSocket - Misk","text":"//misk-policy/misk.policy.opa/OpaConfig/unixSocket
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-config/unix-socket/#unixsocket","title":"unixSocket","text":"[jvm]\\ val unixSocket: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/","title":"OpaMetrics - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#opametrics","title":"OpaMetrics","text":"interface OpaMetrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#inheritors","title":"Inheritors","text":"MiskOpaMetrics"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#types","title":"Types","text":"Name Summary Names [jvm]enum Names : Enum<OpaMetrics.Names>"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/#functions","title":"Functions","text":"Name Summary evaluated [jvm]abstract fun evaluated(document: String)Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not. observe [jvm]abstract fun observe(document: String, response: OpaResponse)Dispatches OpaResponse.metrics into a metrics client."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/evaluated/","title":"evaluated - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/evaluated/#evaluated","title":"evaluated","text":"[jvm]\\ abstract fun evaluated(document: String)
Increments a counter to indicate policy evaluation, whether metrics are enabled on the request or not.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/observe/","title":"observe - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/observe
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/observe/#observe","title":"observe","text":"[jvm]\\ abstract fun observe(document: String, response: OpaResponse)
Dispatches OpaResponse.metrics into a metrics client.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/","title":"Names - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#names","title":"Names","text":"[jvm]\\ enum Names : Enum<OpaMetrics.Names>
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#entries","title":"Entries","text":"opa_server_query_cache_hit [jvm]opa_server_query_cache_hit opa_rego_external_resolve [jvm]opa_rego_external_resolve opa_rego_input_parse [jvm]opa_rego_input_parse opa_rego_query_eval [jvm]opa_rego_query_eval opa_server_handler [jvm]opa_server_handler opa_rego_evaluated [jvm]opa_rego_evaluated"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<OpaMetrics.Names>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): OpaMetrics.NamesReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<OpaMetrics.Names>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/entries/","title":"entries - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/entries
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<OpaMetrics.Names>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/value-of/","title":"valueOf - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/valueOf
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): OpaMetrics.Names
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/values/","title":"values - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/values
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<OpaMetrics.Names>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_evaluated/","title":"opa_rego_evaluated - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_evaluated/#opa_rego_evaluated","title":"opa_rego_evaluated","text":"[jvm]\\ opa_rego_evaluated
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_evaluated/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_external_resolve/","title":"opa_rego_external_resolve - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_external_resolve
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_external_resolve/#opa_rego_external_resolve","title":"opa_rego_external_resolve","text":"[jvm]\\ opa_rego_external_resolve
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_external_resolve/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_input_parse/","title":"opa_rego_input_parse - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_input_parse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_input_parse/#opa_rego_input_parse","title":"opa_rego_input_parse","text":"[jvm]\\ opa_rego_input_parse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_input_parse/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_query_eval/","title":"opa_rego_query_eval - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_rego_query_eval
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_query_eval/#opa_rego_query_eval","title":"opa_rego_query_eval","text":"[jvm]\\ opa_rego_query_eval
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_rego_query_eval/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_handler/","title":"opa_server_handler - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_server_handler
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_handler/#opa_server_handler","title":"opa_server_handler","text":"[jvm]\\ opa_server_handler
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_handler/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_query_cache_hit/","title":"opa_server_query_cache_hit - Misk","text":"//misk-policy/misk.policy.opa/OpaMetrics/Names/opa_server_query_cache_hit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_query_cache_hit/#opa_server_query_cache_hit","title":"opa_server_query_cache_hit","text":"[jvm]\\ opa_server_query_cache_hit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-metrics/-names/opa_server_query_cache_hit/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/","title":"OpaModule - Misk","text":"//misk-policy/misk.policy.opa/OpaModule
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/#opamodule","title":"OpaModule","text":"[jvm]\\ class OpaModule@Injectconstructor(config: OpaConfig) : KAbstractModule
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/#constructors","title":"Constructors","text":"OpaModule [jvm]@Injectconstructor(config: OpaConfig)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singleton@Named(value = \"opa-moshi\")fun provideMoshi(): Moshi"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/-opa-module/","title":"OpaModule - Misk","text":"//misk-policy/misk.policy.opa/OpaModule/OpaModule
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/-opa-module/#opamodule","title":"OpaModule","text":"[jvm]\\
@Inject
constructor(config: OpaConfig)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/provide-moshi/","title":"provideMoshi - Misk","text":"//misk-policy/misk.policy.opa/OpaModule/provideMoshi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"[jvm]\\
@Provides
@Singleton
@Named(value = \"opa-moshi\")
fun provideMoshi(): Moshi
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/","title":"OpaPolicyEngine - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/#opapolicyengine","title":"OpaPolicyEngine","text":"interface OpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/#inheritors","title":"Inheritors","text":"RealOpaPolicyEngine"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/#functions","title":"Functions","text":"Name Summary evaluate [jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support. evaluateNoInput [jvm]abstract fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): R evaluateRawJsonInput [jvm]abstract fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): R evaluateWithInput [jvm]abstract fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): R"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-no-input/","title":"evaluateNoInput - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine/evaluateNoInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-no-input/#evaluatenoinput","title":"evaluateNoInput","text":"[jvm]\\ abstract fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): R
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-raw-json-input/","title":"evaluateRawJsonInput - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine/evaluateRawJsonInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-raw-json-input/#evaluaterawjsoninput","title":"evaluateRawJsonInput","text":"[jvm]\\ abstract fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): R
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-with-input/","title":"evaluateWithInput - Misk","text":"//misk-policy/misk.policy.opa/OpaPolicyEngine/evaluateWithInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-policy-engine/evaluate-with-input/#evaluatewithinput","title":"evaluateWithInput","text":"[jvm]\\ abstract fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): R
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/","title":"OpaRequest - Misk","text":"//misk-policy/misk.policy.opa/OpaRequest
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/#oparequest","title":"OpaRequest","text":"[jvm]\\ abstract class OpaRequest
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/#constructors","title":"Constructors","text":"OpaRequest [jvm]constructor()"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/-opa-request/","title":"OpaRequest - Misk","text":"//misk-policy/misk.policy.opa/OpaRequest/OpaRequest
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-request/-opa-request/#oparequest","title":"OpaRequest","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/","title":"OpaResponse - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/#oparesponse","title":"OpaResponse","text":"[jvm]\\ abstract class OpaResponse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/#constructors","title":"Constructors","text":"OpaResponse [jvm]constructor()"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/#properties","title":"Properties","text":"Name Summary metrics [jvm]var metrics: Metrics? provenance [jvm]var provenance: Provenance?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/-opa-response/","title":"OpaResponse - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse/OpaResponse
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/-opa-response/#oparesponse","title":"OpaResponse","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/metrics/","title":"metrics - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse/metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/metrics/#metrics","title":"metrics","text":"[jvm]\\ var metrics: Metrics?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/provenance/","title":"provenance - Misk","text":"//misk-policy/misk.policy.opa/OpaResponse/provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-opa-response/provenance/#provenance","title":"provenance","text":"[jvm]\\ var provenance: Provenance?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/","title":"PolicyEngineException - Misk","text":"//misk-policy/misk.policy.opa/PolicyEngineException
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#policyengineexception","title":"PolicyEngineException","text":"[jvm]\\ class PolicyEngineException@JvmOverloadsconstructor(message: String, cause: Throwable? = null) : Exception
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#constructors","title":"Constructors","text":"PolicyEngineException [jvm]@JvmOverloadsconstructor(message: String, cause: Throwable? = null)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/-policy-engine-exception/","title":"PolicyEngineException - Misk","text":"//misk-policy/misk.policy.opa/PolicyEngineException/PolicyEngineException
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-policy-engine-exception/-policy-engine-exception/#policyengineexception","title":"PolicyEngineException","text":"[jvm]\\
@JvmOverloads
constructor(message: String, cause: Throwable? = null)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/","title":"Provenance - Misk","text":"//misk-policy/misk.policy.opa/Provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/#provenance","title":"Provenance","text":"[jvm]\\ data class Provenance(val version: String?, val build_commit: String?, val build_timestamp: String?, val build_hostname: String?, val revision: String?, val bundles: Map<String, ProvenanceBundle>?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/#constructors","title":"Constructors","text":"Provenance [jvm]constructor(version: String?, build_commit: String?, build_timestamp: String?, build_hostname: String?, revision: String?, bundles: Map<String, ProvenanceBundle>?)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/#properties","title":"Properties","text":"Name Summary build_commit [jvm]val build_commit: String? build_hostname [jvm]val build_hostname: String? build_timestamp [jvm]val build_timestamp: String? bundles [jvm]val bundles: Map<String, ProvenanceBundle>? revision [jvm]val revision: String? version [jvm]val version: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/-provenance/","title":"Provenance - Misk","text":"//misk-policy/misk.policy.opa/Provenance/Provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/-provenance/#provenance","title":"Provenance","text":"[jvm]\\ constructor(version: String?, build_commit: String?, build_timestamp: String?, build_hostname: String?, revision: String?, bundles: Map<String, ProvenanceBundle>?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_commit/","title":"build_commit - Misk","text":"//misk-policy/misk.policy.opa/Provenance/build_commit
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_commit/#build_commit","title":"build_commit","text":"[jvm]\\ val build_commit: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_hostname/","title":"build_hostname - Misk","text":"//misk-policy/misk.policy.opa/Provenance/build_hostname
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_hostname/#build_hostname","title":"build_hostname","text":"[jvm]\\ val build_hostname: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_timestamp/","title":"build_timestamp - Misk","text":"//misk-policy/misk.policy.opa/Provenance/build_timestamp
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/build_timestamp/#build_timestamp","title":"build_timestamp","text":"[jvm]\\ val build_timestamp: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/bundles/","title":"bundles - Misk","text":"//misk-policy/misk.policy.opa/Provenance/bundles
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/bundles/#bundles","title":"bundles","text":"[jvm]\\ val bundles: Map<String, ProvenanceBundle>?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/revision/","title":"revision - Misk","text":"//misk-policy/misk.policy.opa/Provenance/revision
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/revision/#revision","title":"revision","text":"[jvm]\\ val revision: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/version/","title":"version - Misk","text":"//misk-policy/misk.policy.opa/Provenance/version
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance/version/#version","title":"version","text":"[jvm]\\ val version: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/","title":"ProvenanceBundle - Misk","text":"//misk-policy/misk.policy.opa/ProvenanceBundle
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/#provenancebundle","title":"ProvenanceBundle","text":"[jvm]\\ data class ProvenanceBundle(val revision: String?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/#constructors","title":"Constructors","text":"ProvenanceBundle [jvm]constructor(revision: String?)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/#properties","title":"Properties","text":"Name Summary revision [jvm]val revision: String?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/-provenance-bundle/","title":"ProvenanceBundle - Misk","text":"//misk-policy/misk.policy.opa/ProvenanceBundle/ProvenanceBundle
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/-provenance-bundle/#provenancebundle","title":"ProvenanceBundle","text":"[jvm]\\ constructor(revision: String?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/revision/","title":"revision - Misk","text":"//misk-policy/misk.policy.opa/ProvenanceBundle/revision
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-provenance-bundle/revision/#revision","title":"revision","text":"[jvm]\\ val revision: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/","title":"RealOpaPolicyEngine - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/#realopapolicyengine","title":"RealOpaPolicyEngine","text":"[jvm]\\ class RealOpaPolicyEngine@Injectconstructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig) : OpaPolicyEngine
Support for the Open Policy Engine (OPA). OPA provides a means to decouple policy from business logic. The resulting query response may have arbitrary shapes.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/#constructors","title":"Constructors","text":"RealOpaPolicyEngine [jvm]@Injectconstructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/#functions","title":"Functions","text":"Name Summary evaluate [jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <T : OpaRequest, R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: T): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.[jvm]inline fun <R : OpaResponse> OpaPolicyEngine.evaluate(document: String, input: String): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries that the automatic JSON serialization doesn\u2019t support. evaluateNoInput [jvm]open override fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): REvaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. evaluateRawJsonInput [jvm]open override fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): REvaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries the automatic JSON serialization doesn\u2019t support. evaluateWithInput [jvm]open override fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): REvaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/-real-opa-policy-engine/","title":"RealOpaPolicyEngine - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/RealOpaPolicyEngine
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/-real-opa-policy-engine/#realopapolicyengine","title":"RealOpaPolicyEngine","text":"[jvm]\\
@Inject
constructor(opaApi: OpaApi, @Named(value = \"opa-moshi\")moshi: Moshi, metrics: OpaMetrics, config: OpaConfig)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/","title":"evaluateNoInput - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/evaluateNoInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#evaluatenoinput","title":"evaluateNoInput","text":"[jvm]\\ open override fun <R : OpaResponse> evaluateNoInput(document: String, returnType: Class<R>): R
Evaluate / Query a document with no additional input. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. returnType Shape of response to be demarshelled from OPA"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-no-input/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/","title":"evaluateRawJsonInput - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/evaluateRawJsonInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#evaluaterawjsoninput","title":"evaluateRawJsonInput","text":"[jvm]\\ open override fun <R : OpaResponse> evaluateRawJsonInput(document: String, input: String, returnType: Class<R>): R
Evaluate / Query a document with given input of raw JSON. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST. This consumes raw JSON for corner cases where developers need to do queries the automatic JSON serialization doesn\u2019t support.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time. Must be valid JSON. returnType Return shape to be JSONified from OPA."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-raw-json-input/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/","title":"evaluateWithInput - Misk","text":"//misk-policy/misk.policy.opa/RealOpaPolicyEngine/evaluateWithInput
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#evaluatewithinput","title":"evaluateWithInput","text":"[jvm]\\ open override fun <T : OpaRequest, R : OpaResponse> evaluateWithInput(document: String, input: T, inputType: Class<T>, returnType: Class<R>): R
Evaluate / Query a document with given input of shape T. This will connect to OPA via a retrofit interface and perform a /v1/data/{document} POST.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#return","title":"Return","text":"Response shape R from OPA.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#parameters","title":"Parameters","text":"jvm
document Name or Path of the OPA document to query. input Input data to be supplied to OPA at evaluation time (the input global field). inputType Input shape to be JSONified for OPA returnType Return shape to be JSONified from OPA"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-real-opa-policy-engine/evaluate-with-input/#throws","title":"Throws","text":"PolicyEngineException if the request to OPA failed or the response shape didn\u2019t match R. IllegalArgumentException if no document path was specified."},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/","title":"Request - Misk","text":"//misk-policy/misk.policy.opa/Request
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/#request","title":"Request","text":"[jvm]\\ data class Request<T>(val input: T)
OPA Request wrapper.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/#constructors","title":"Constructors","text":"Request [jvm]constructor(input: T)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/#properties","title":"Properties","text":"Name Summary input [jvm]val input: T"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/-request/","title":"Request - Misk","text":"//misk-policy/misk.policy.opa/Request/Request
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/-request/#request","title":"Request","text":"[jvm]\\ constructor(input: T)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/input/","title":"input - Misk","text":"//misk-policy/misk.policy.opa/Request/input
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-request/input/#input","title":"input","text":"[jvm]\\ val input: T
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/","title":"Response - Misk","text":"//misk-policy/misk.policy.opa/Response
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/#response","title":"Response","text":"[jvm]\\ data class Response<T>(val decision_id: String?, val result: T?, val provenance: Provenance?, val metrics: Metrics?)
OPA Response wrapper. Every response has this standard shape, made concrete by the expected response type.
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/#constructors","title":"Constructors","text":"Response [jvm]constructor(decision_id: String?, result: T?, provenance: Provenance?, metrics: Metrics?)"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/#properties","title":"Properties","text":"Name Summary decision_id [jvm]val decision_id: String? metrics [jvm]val metrics: Metrics? provenance [jvm]val provenance: Provenance? result [jvm]val result: T?"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/-response/","title":"Response - Misk","text":"//misk-policy/misk.policy.opa/Response/Response
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/-response/#response","title":"Response","text":"[jvm]\\ constructor(decision_id: String?, result: T?, provenance: Provenance?, metrics: Metrics?)
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/decision_id/","title":"decision_id - Misk","text":"//misk-policy/misk.policy.opa/Response/decision_id
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/decision_id/#decision_id","title":"decision_id","text":"[jvm]\\ val decision_id: String?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/metrics/","title":"metrics - Misk","text":"//misk-policy/misk.policy.opa/Response/metrics
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/metrics/#metrics","title":"metrics","text":"[jvm]\\ val metrics: Metrics?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/provenance/","title":"provenance - Misk","text":"//misk-policy/misk.policy.opa/Response/provenance
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/provenance/#provenance","title":"provenance","text":"[jvm]\\ val provenance: Provenance?
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/result/","title":"result - Misk","text":"//misk-policy/misk.policy.opa/Response/result
"},{"location":"0.x/misk-policy/misk-policy/misk.policy.opa/-response/result/#result","title":"result","text":"[jvm]\\ val result: T?
"},{"location":"0.x/misk-prometheus/","title":"misk-prometheus - Misk","text":"//misk-prometheus
"},{"location":"0.x/misk-prometheus/#misk-prometheus","title":"misk-prometheus","text":""},{"location":"0.x/misk-prometheus/#packages","title":"Packages","text":"Name misk.metrics.backends.prometheus"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/","title":"Package-level declarations - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/#types","title":"Types","text":"Name Summary PrometheusConfig [jvm]data class PrometheusConfig(val hostname: String? = null, val http_port: Int = 9102, val max_age_in_seconds: Long? = null) : ConfigConfiguration for exporting metrics to prometheus PrometheusHttpService [jvm]@Singletonclass PrometheusHttpService : AbstractIdleService PrometheusMetricsServiceModule [jvm]class PrometheusMetricsServiceModule(config: PrometheusConfig) : KAbstractModuleExposes prometheus metrics over a dedicated port. Allows internal metrics to be exposed via a k8s ClusterIP address, where they can be scraped by a cluster local Prometheus server without also exposing them to the outside world via the port bound to the service load balancer. If using the prometheus operator, one would generally create a k8s ClusterIP service exporting the metrics port, then a prometheus ServiceMonitor selecting that service via a label."},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/","title":"PrometheusConfig - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/#prometheusconfig","title":"PrometheusConfig","text":"[jvm]\\ data class PrometheusConfig(val hostname: String? = null, val http_port: Int = 9102, val max_age_in_seconds: Long? = null) : Config
Configuration for exporting metrics to prometheus
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/#constructors","title":"Constructors","text":"PrometheusConfig [jvm]@Injectconstructor()constructor(hostname: String? = null, http_port: Int = 9102, max_age_in_seconds: Long? = null)"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/#properties","title":"Properties","text":"Name Summary hostname [jvm]val hostname: String? = null http_port [jvm]val http_port: Int = 9102 max_age_in_seconds [jvm]val max_age_in_seconds: Long? = null"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/-prometheus-config/","title":"PrometheusConfig - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/PrometheusConfig
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/-prometheus-config/#prometheusconfig","title":"PrometheusConfig","text":"[jvm]\\
@Inject
constructor()
constructor(hostname: String? = null, http_port: Int = 9102, max_age_in_seconds: Long? = null)
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/hostname/","title":"hostname - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/hostname
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/hostname/#hostname","title":"hostname","text":"[jvm]\\ val hostname: String? = null
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/http_port/","title":"http_port - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/http_port
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/http_port/#http_port","title":"http_port","text":"[jvm]\\ val http_port: Int = 9102
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/max_age_in_seconds/","title":"max_age_in_seconds - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusConfig/max_age_in_seconds
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-config/max_age_in_seconds/#max_age_in_seconds","title":"max_age_in_seconds","text":"[jvm]\\ val max_age_in_seconds: Long? = null
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-http-service/","title":"PrometheusHttpService - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusHttpService
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-http-service/#prometheushttpservice","title":"PrometheusHttpService","text":"[jvm]\\ @Singleton
class PrometheusHttpService : AbstractIdleService
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-http-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/","title":"PrometheusMetricsServiceModule - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusMetricsServiceModule
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/#prometheusmetricsservicemodule","title":"PrometheusMetricsServiceModule","text":"[jvm]\\ class PrometheusMetricsServiceModule(config: PrometheusConfig) : KAbstractModule
Exposes prometheus metrics over a dedicated port. Allows internal metrics to be exposed via a k8s ClusterIP address, where they can be scraped by a cluster local Prometheus server without also exposing them to the outside world via the port bound to the service load balancer. If using the prometheus operator, one would generally create a k8s ClusterIP service exporting the metrics port, then a prometheus ServiceMonitor selecting that service via a label.
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/#constructors","title":"Constructors","text":"PrometheusMetricsServiceModule [jvm]constructor(config: PrometheusConfig)"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/-prometheus-metrics-service-module/","title":"PrometheusMetricsServiceModule - Misk","text":"//misk-prometheus/misk.metrics.backends.prometheus/PrometheusMetricsServiceModule/PrometheusMetricsServiceModule
"},{"location":"0.x/misk-prometheus/misk-prometheus/misk.metrics.backends.prometheus/-prometheus-metrics-service-module/-prometheus-metrics-service-module/#prometheusmetricsservicemodule","title":"PrometheusMetricsServiceModule","text":"[jvm]\\ constructor(config: PrometheusConfig)
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/","title":"misk-rate-limiting-bucket4j-dynamodb-v1 - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/#misk-rate-limiting-bucket4j-dynamodb-v1","title":"misk-rate-limiting-bucket4j-dynamodb-v1","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/#packages","title":"Packages","text":"Name misk.ratelimiting.bucket4j.dynamodb.v1"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/","title":"Package-level declarations - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/#types","title":"Types","text":"Name Summary DynamoDbV1Bucket4jRateLimiterModule [jvm]class DynamoDbV1Bucket4jRateLimiterModule@JvmOverloadsconstructor(tableName: String, prunerPageSize: Int = 1000) : KAbstractModuleConfigures a RateLimiter that uses DynamoDb as a backend. DynamoDbV1BucketPruner [jvm]class DynamoDbV1BucketPruner@JvmOverloadsconstructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000) : Bucket4jPruner"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/","title":"DynamoDbV1BucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#dynamodbv1bucketpruner","title":"DynamoDbV1BucketPruner","text":"[jvm]\\ class DynamoDbV1BucketPruner@JvmOverloadsconstructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000) : Bucket4jPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#constructors","title":"Constructors","text":"DynamoDbV1BucketPruner [jvm]@JvmOverloadsconstructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]open override val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]open override fun prune()"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-dynamo-db-v1-bucket-pruner/","title":"DynamoDbV1BucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/DynamoDbV1BucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-dynamo-db-v1-bucket-pruner/#dynamodbv1bucketpruner","title":"DynamoDbV1BucketPruner","text":"[jvm]\\
@JvmOverloads
constructor(clock: Clock, amazonDynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry, tableName: String, pageSize: Int = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/clockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"[jvm]\\ open override val clockTimeMeter: ClockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/prune/","title":"prune - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/prune
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/prune/#prune","title":"prune","text":"[jvm]\\ open override fun prune()
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-companion/","title":"Companion - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1BucketPruner/Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket-pruner/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/","title":"DynamoDbV1Bucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/#dynamodbv1bucket4jratelimitermodule","title":"DynamoDbV1Bucket4jRateLimiterModule","text":"[jvm]\\ class DynamoDbV1Bucket4jRateLimiterModule@JvmOverloadsconstructor(tableName: String, prunerPageSize: Int = 1000) : KAbstractModule
Configures a RateLimiter that uses DynamoDb as a backend.
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/#constructors","title":"Constructors","text":"DynamoDbV1Bucket4jRateLimiterModule [jvm]@JvmOverloadsconstructor(tableName: String, prunerPageSize: Int = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providedPruner [jvm]@Provides@Singletonfun providedPruner(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimitPruner providedRateLimiter [jvm]@Provides@Singletonfun providedRateLimiter(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimiter"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/-dynamo-db-v1-bucket4j-rate-limiter-module/","title":"DynamoDbV1Bucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule/DynamoDbV1Bucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/-dynamo-db-v1-bucket4j-rate-limiter-module/#dynamodbv1bucket4jratelimitermodule","title":"DynamoDbV1Bucket4jRateLimiterModule","text":"[jvm]\\
@JvmOverloads
constructor(tableName: String, prunerPageSize: Int = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-pruner/","title":"providedPruner - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule/providedPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-pruner/#providedpruner","title":"providedPruner","text":"[jvm]\\
@Provides
@Singleton
fun providedPruner(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimitPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-rate-limiter/","title":"providedRateLimiter - Misk","text":"//misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/DynamoDbV1Bucket4jRateLimiterModule/providedRateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-dynamodb-v1/misk-rate-limiting-bucket4j-dynamodb-v1/misk.ratelimiting.bucket4j.dynamodb.v1/-dynamo-db-v1-bucket4j-rate-limiter-module/provided-rate-limiter/#providedratelimiter","title":"providedRateLimiter","text":"[jvm]\\
@Provides
@Singleton
fun providedRateLimiter(clock: Clock, dynamoDB: AmazonDynamoDB, meterRegistry: MeterRegistry): RateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/","title":"misk-rate-limiting-bucket4j-mysql - Misk","text":"//misk-rate-limiting-bucket4j-mysql
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/#misk-rate-limiting-bucket4j-mysql","title":"misk-rate-limiting-bucket4j-mysql","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/#packages","title":"Packages","text":"Name misk.ratelimiting.bucket4j.mysql"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/","title":"Package-level declarations - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/#types","title":"Types","text":"Name Summary MySQLBucket4jRateLimiterModule [jvm]class MySQLBucket4jRateLimiterModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000) : KAbstractModule MySQLBucketPruner [jvm]class MySQLBucketPruner@JvmOverloadsconstructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000) : Bucket4jPruner"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/","title":"MySQLBucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#mysqlbucketpruner","title":"MySQLBucketPruner","text":"[jvm]\\ class MySQLBucketPruner@JvmOverloadsconstructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000) : Bucket4jPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#constructors","title":"Constructors","text":"MySQLBucketPruner [jvm]@JvmOverloadsconstructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#properties","title":"Properties","text":"Name Summary clockTimeMeter [jvm]open override val clockTimeMeter: ClockTimeMeter"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]open override fun prune()Prunes the rate limit table, returning the number of rows pruned."},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-my-s-q-l-bucket-pruner/","title":"MySQLBucketPruner - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/MySQLBucketPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-my-s-q-l-bucket-pruner/#mysqlbucketpruner","title":"MySQLBucketPruner","text":"[jvm]\\
@JvmOverloads
constructor(clock: Clock, dataSource: DataSource, idColumn: String, meterRegistry: MeterRegistry, stateColumn: String, tableName: String, isMySQL8: Boolean = false, pageSize: Long = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/clock-time-meter/","title":"clockTimeMeter - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/clockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/clock-time-meter/#clocktimemeter","title":"clockTimeMeter","text":"[jvm]\\ open override val clockTimeMeter: ClockTimeMeter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/prune/","title":"prune - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/prune
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/prune/#prune","title":"prune","text":"[jvm]\\ open override fun prune()
Prunes the rate limit table, returning the number of rows pruned.
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-companion/","title":"Companion - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucketPruner/Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket-pruner/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/","title":"MySQLBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/#mysqlbucket4jratelimitermodule","title":"MySQLBucket4jRateLimiterModule","text":"[jvm]\\ class MySQLBucket4jRateLimiterModule@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000) : KAbstractModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/#constructors","title":"Constructors","text":"MySQLBucket4jRateLimiterModule [jvm]@JvmOverloadsconstructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000)"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providedPruner [jvm]@Provides@Singletonfun providedPruner(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimitPruner providedRateLimiter [jvm]@Provides@Singletonfun providedRateLimiter(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimiter"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/-my-s-q-l-bucket4j-rate-limiter-module/","title":"MySQLBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule/MySQLBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/-my-s-q-l-bucket4j-rate-limiter-module/#mysqlbucket4jratelimitermodule","title":"MySQLBucket4jRateLimiterModule","text":"[jvm]\\
@JvmOverloads
constructor(qualifier: KClass<out Annotation>, tableName: String, idColumn: String, stateColumn: String, prunerPageSize: Long = 1000)
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-pruner/","title":"providedPruner - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule/providedPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-pruner/#providedpruner","title":"providedPruner","text":"[jvm]\\
@Provides
@Singleton
fun providedPruner(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimitPruner
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-rate-limiter/","title":"providedRateLimiter - Misk","text":"//misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/MySQLBucket4jRateLimiterModule/providedRateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-mysql/misk-rate-limiting-bucket4j-mysql/misk.ratelimiting.bucket4j.mysql/-my-s-q-l-bucket4j-rate-limiter-module/provided-rate-limiter/#providedratelimiter","title":"providedRateLimiter","text":"[jvm]\\
@Provides
@Singleton
fun providedRateLimiter(clock: Clock, injector: Injector, meterRegistry: MeterRegistry): RateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/","title":"misk-rate-limiting-bucket4j-redis - Misk","text":"//misk-rate-limiting-bucket4j-redis
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/#misk-rate-limiting-bucket4j-redis","title":"misk-rate-limiting-bucket4j-redis","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-redis/#packages","title":"Packages","text":"Name misk.ratelimiting.bucket4j.redis"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/","title":"Package-level declarations - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/#types","title":"Types","text":"Name Summary RedisBucket4jRateLimiterModule [jvm]class RedisBucket4jRateLimiterModule@JvmOverloadsconstructor(additionalTtl: Duration = Duration.ofSeconds(5)) : KAbstractModuleConfigures a RateLimiter that uses Redis as a backend."},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/","title":"RedisBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/RedisBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#redisbucket4jratelimitermodule","title":"RedisBucket4jRateLimiterModule","text":"class RedisBucket4jRateLimiterModule@JvmOverloadsconstructor(additionalTtl: Duration = Duration.ofSeconds(5)) : KAbstractModule
Configures a RateLimiter that uses Redis as a backend.
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#parameters","title":"Parameters","text":"jvm
additionalTtl Additional duration to add to the base TTL of each rate limit bucket, which is the duration of the refill period. This is a performance optimization that enables bucket reuse when a request comes in after the bucket has been refilled, since reuse is cheaper than creating a new bucket"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#constructors","title":"Constructors","text":"RedisBucket4jRateLimiterModule [jvm]@JvmOverloadsconstructor(additionalTtl: Duration = Duration.ofSeconds(5))"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) providedRateLimiter [jvm]@Provides@Singletonfun providedRateLimiter(clock: Clock, metricsRegistry: MeterRegistry, unifiedJedis: UnifiedJedis): RateLimiter"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/-redis-bucket4j-rate-limiter-module/","title":"RedisBucket4jRateLimiterModule - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/RedisBucket4jRateLimiterModule/RedisBucket4jRateLimiterModule
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/-redis-bucket4j-rate-limiter-module/#redisbucket4jratelimitermodule","title":"RedisBucket4jRateLimiterModule","text":"[jvm]\\
@JvmOverloads
constructor(additionalTtl: Duration = Duration.ofSeconds(5))
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/-redis-bucket4j-rate-limiter-module/#parameters","title":"Parameters","text":"jvm
additionalTtl Additional duration to add to the base TTL of each rate limit bucket, which is the duration of the refill period. This is a performance optimization that enables bucket reuse when a request comes in after the bucket has been refilled, since reuse is cheaper than creating a new bucket"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/provided-rate-limiter/","title":"providedRateLimiter - Misk","text":"//misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/RedisBucket4jRateLimiterModule/providedRateLimiter
"},{"location":"0.x/misk-rate-limiting-bucket4j-redis/misk-rate-limiting-bucket4j-redis/misk.ratelimiting.bucket4j.redis/-redis-bucket4j-rate-limiter-module/provided-rate-limiter/#providedratelimiter","title":"providedRateLimiter","text":"[jvm]\\
@Provides
@Singleton
fun providedRateLimiter(clock: Clock, metricsRegistry: MeterRegistry, unifiedJedis: UnifiedJedis): RateLimiter
"},{"location":"0.x/misk-redis/","title":"misk-redis - Misk","text":"//misk-redis
"},{"location":"0.x/misk-redis/#misk-redis","title":"misk-redis","text":""},{"location":"0.x/misk-redis/#packages","title":"Packages","text":"Name misk.redis"},{"location":"0.x/misk-redis/misk-redis/misk.redis/","title":"Package-level declarations - Misk","text":"//misk-redis/misk.redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-redis/misk-redis/misk.redis/#types","title":"Types","text":"Name Summary DeferredRedis [jvm]interface DeferredRedisLike Redis, but returns Suppliers to defer value retrieval. Does not support transactions or pubsub. RealRedis [jvm]class RealRedis(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics) : RedisFor each command, a Jedis instance is retrieved from the pool and returned once the command has been issued. Redis [jvm]interface RedisA Redis client. RedisClientMetrics [jvm]@Singletonclass RedisClientMetrics@Injectconstructor(ticker: Ticker, metrics: Metrics) RedisClusterConfig [jvm]class RedisClusterConfig : LinkedHashMap<String, RedisClusterReplicationGroupConfig> , ConfigTop-level configuration element for all redis clusters RedisClusterModule [jvm]class RedisClusterModule@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModuleConfigures a Redis client that interacts with a Redis cluster. This also installs a ServiceModule for RedisService. RedisClusterReplicationGroupConfig [jvm]data class RedisClusterReplicationGroupConfig@JvmOverloadsconstructor(val configuration_endpoint: RedisNodeConfig, val client_name: String? = null, val max_attempts: Int = DEFAULT_MAX_ATTEMPTS, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)Configuration element for a Redis Cluster RedisConfig [jvm]class RedisConfig : LinkedHashMap<String, RedisReplicationGroupConfig> , Config RedisConnectionException [jvm]class RedisConnectionException(cluster: String, cause: Throwable) : RuntimeException RedisModule [jvm]class RedisModule@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModuleConfigures a Redis client with metrics, this also installs a ServiceModule for RedisService. If other services require a working client connection to Redis before they can be used, specify a dependency like: RedisNodeConfig [jvm]data class RedisNodeConfig(val hostname: String?, val port: Int) RedisReplicationGroupConfig [jvm]data class RedisReplicationGroupConfig@JvmOverloadsconstructor(val writer_endpoint: RedisNodeConfig, val reader_endpoint: RedisNodeConfig, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT) RedisService [jvm]@Singletonclass RedisService : AbstractIdleServiceControls the connection lifecycle for Redis."},{"location":"0.x/misk-redis/misk-redis/misk.redis/#functions","title":"Functions","text":"Name Summary checkHrandFieldCount [jvm]inline fun checkHrandFieldCount(count: Long)Validates count is positive and non-zero. This is to avoid unexpected behaviour due to limitations in Jedis: https://github.com/redis/jedis/issues/3017"},{"location":"0.x/misk-redis/misk-redis/misk.redis/check-hrand-field-count/","title":"checkHrandFieldCount - Misk","text":"//misk-redis/misk.redis/checkHrandFieldCount
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/check-hrand-field-count/#checkhrandfieldcount","title":"checkHrandFieldCount","text":"[jvm]\\ inline fun checkHrandFieldCount(count: Long)
Validates count is positive and non-zero. This is to avoid unexpected behaviour due to limitations in Jedis: https://github.com/redis/jedis/issues/3017
This check can be removed when Jedis v5.x is released with full support for the behaviours for negative counts that are specified by Redis.
https://redis.io/commands/hrandfield/#specification-of-the-behavior-when-count-is-passed
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/","title":"DeferredRedis - Misk","text":"//misk-redis/misk.redis/DeferredRedis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/#deferredredis","title":"DeferredRedis","text":"[jvm]\\ interface DeferredRedis
Like Redis, but returns Suppliers to defer value retrieval. Does not support transactions or pubsub.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/#functions","title":"Functions","text":"Name Summary blmove [jvm]abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): Supplier<ByteString?> brpoplpush [jvm]abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): Supplier<ByteString?> close [jvm]abstract fun close() del [jvm]abstract fun del(vararg keys: String): Supplier<Int>abstract fun del(key: String): Supplier<Boolean> expire [jvm]abstract fun expire(key: String, seconds: Long): Supplier<Boolean> expireAt [jvm]abstract fun expireAt(key: String, timestampSeconds: Long): Supplier<Boolean> get [jvm]abstract operator fun get(key: String): Supplier<ByteString?> getDel [jvm]abstract fun getDel(key: String): Supplier<ByteString?> hdel [jvm]abstract fun hdel(key: String, vararg fields: String): Supplier<Long> hget [jvm]abstract fun hget(key: String, field: String): Supplier<ByteString?> hgetAll [jvm]abstract fun hgetAll(key: String): Supplier<Map<String, ByteString>?> hincrBy [jvm]abstract fun hincrBy(key: String, field: String, increment: Long): Supplier<Long> hlen [jvm]abstract fun hlen(key: String): Supplier<Long> hmget [jvm]abstract fun hmget(key: String, vararg fields: String): Supplier<List<ByteString?>> hrandField [jvm]abstract fun hrandField(key: String, count: Long): Supplier<List<String>> hrandFieldWithValues [jvm]abstract fun hrandFieldWithValues(key: String, count: Long): Supplier<Map<String, ByteString>?> hset [jvm]abstract fun hset(key: String, hash: Map<String, ByteString>): Supplier<Long>abstract fun hset(key: String, field: String, value: ByteString): Supplier<Long> incr [jvm]abstract fun incr(key: String): Supplier<Long> incrBy [jvm]abstract fun incrBy(key: String, increment: Long): Supplier<Long> lmove [jvm]abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): Supplier<ByteString?> lpop [jvm]abstract fun lpop(key: String): Supplier<ByteString?>abstract fun lpop(key: String, count: Int): Supplier<List<ByteString?>> lpush [jvm]abstract fun lpush(key: String, vararg elements: ByteString): Supplier<Long> lrange [jvm]abstract fun lrange(key: String, start: Long, stop: Long): Supplier<List<ByteString?>> lrem [jvm]abstract fun lrem(key: String, count: Long, element: ByteString): Supplier<Long> mget [jvm]abstract fun mget(vararg keys: String): Supplier<List<ByteString?>> mset [jvm]abstract fun mset(vararg keyValues: ByteString): Supplier<Unit> pExpire [jvm]abstract fun pExpire(key: String, milliseconds: Long): Supplier<Boolean> pExpireAt [jvm]abstract fun pExpireAt(key: String, timestampMilliseconds: Long): Supplier<Boolean> rpop [jvm]abstract fun rpop(key: String): Supplier<ByteString?>abstract fun rpop(key: String, count: Int): Supplier<List<ByteString?>> rpoplpush [jvm]abstract fun rpoplpush(sourceKey: String, destinationKey: String): Supplier<ByteString?> rpush [jvm]abstract fun rpush(key: String, vararg elements: ByteString): Supplier<Long> set [jvm]abstract fun set(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Unit> setnx [jvm]abstract fun setnx(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Boolean> zadd [jvm]abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Supplier<Long>abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Supplier<Long> zcard [jvm]abstract fun zcard(key: String): Supplier<Long> zrange [jvm]abstract fun zrange(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<ByteString?>> zrangeWithScores [jvm]abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<Pair<ByteString?, Double>>> zremRangeByRank [jvm]abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Supplier<Long> zscore [jvm]abstract fun zscore(key: String, member: String): Supplier<Double?>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/blmove/","title":"blmove - Misk","text":"//misk-redis/misk.redis/DeferredRedis/blmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/blmove/#blmove","title":"blmove","text":"[jvm]\\ abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/brpoplpush/","title":"brpoplpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/brpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/brpoplpush/#brpoplpush","title":"brpoplpush","text":"[jvm]\\ abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/close/","title":"close - Misk","text":"//misk-redis/misk.redis/DeferredRedis/close
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/close/#close","title":"close","text":"[jvm]\\ abstract fun close()
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/del/","title":"del - Misk","text":"//misk-redis/misk.redis/DeferredRedis/del
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/del/#del","title":"del","text":"[jvm]\\ abstract fun del(key: String): Supplier<Boolean>
abstract fun del(vararg keys: String): Supplier<Int>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire-at/","title":"expireAt - Misk","text":"//misk-redis/misk.redis/DeferredRedis/expireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire-at/#expireat","title":"expireAt","text":"[jvm]\\ abstract fun expireAt(key: String, timestampSeconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire/","title":"expire - Misk","text":"//misk-redis/misk.redis/DeferredRedis/expire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/expire/#expire","title":"expire","text":"[jvm]\\ abstract fun expire(key: String, seconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get-del/","title":"getDel - Misk","text":"//misk-redis/misk.redis/DeferredRedis/getDel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get-del/#getdel","title":"getDel","text":"[jvm]\\ abstract fun getDel(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get/","title":"get - Misk","text":"//misk-redis/misk.redis/DeferredRedis/get
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/get/#get","title":"get","text":"[jvm]\\ abstract operator fun get(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hdel/","title":"hdel - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hdel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hdel/#hdel","title":"hdel","text":"[jvm]\\ abstract fun hdel(key: String, vararg fields: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget-all/","title":"hgetAll - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hgetAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget-all/#hgetall","title":"hgetAll","text":"[jvm]\\ abstract fun hgetAll(key: String): Supplier<Map<String, ByteString>?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget/","title":"hget - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hget/#hget","title":"hget","text":"[jvm]\\ abstract fun hget(key: String, field: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hincr-by/","title":"hincrBy - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hincrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hincr-by/#hincrby","title":"hincrBy","text":"[jvm]\\ abstract fun hincrBy(key: String, field: String, increment: Long): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hlen/","title":"hlen - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hlen
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hlen/#hlen","title":"hlen","text":"[jvm]\\ abstract fun hlen(key: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hmget/","title":"hmget - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hmget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hmget/#hmget","title":"hmget","text":"[jvm]\\ abstract fun hmget(key: String, vararg fields: String): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field-with-values/","title":"hrandFieldWithValues - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hrandFieldWithValues
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field-with-values/#hrandfieldwithvalues","title":"hrandFieldWithValues","text":"[jvm]\\ abstract fun hrandFieldWithValues(key: String, count: Long): Supplier<Map<String, ByteString>?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field/","title":"hrandField - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hrandField
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hrand-field/#hrandfield","title":"hrandField","text":"[jvm]\\ abstract fun hrandField(key: String, count: Long): Supplier<List<String>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hset/","title":"hset - Misk","text":"//misk-redis/misk.redis/DeferredRedis/hset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/hset/#hset","title":"hset","text":"[jvm]\\ abstract fun hset(key: String, field: String, value: ByteString): Supplier<Long>
abstract fun hset(key: String, hash: Map<String, ByteString>): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr-by/","title":"incrBy - Misk","text":"//misk-redis/misk.redis/DeferredRedis/incrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr-by/#incrby","title":"incrBy","text":"[jvm]\\ abstract fun incrBy(key: String, increment: Long): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr/","title":"incr - Misk","text":"//misk-redis/misk.redis/DeferredRedis/incr
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/incr/#incr","title":"incr","text":"[jvm]\\ abstract fun incr(key: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lmove/","title":"lmove - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lmove/#lmove","title":"lmove","text":"[jvm]\\ abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpop/","title":"lpop - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpop/#lpop","title":"lpop","text":"[jvm]\\ abstract fun lpop(key: String, count: Int): Supplier<List<ByteString?>>
abstract fun lpop(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpush/","title":"lpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lpush/#lpush","title":"lpush","text":"[jvm]\\ abstract fun lpush(key: String, vararg elements: ByteString): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrange/","title":"lrange - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrange/#lrange","title":"lrange","text":"[jvm]\\ abstract fun lrange(key: String, start: Long, stop: Long): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrem/","title":"lrem - Misk","text":"//misk-redis/misk.redis/DeferredRedis/lrem
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/lrem/#lrem","title":"lrem","text":"[jvm]\\ abstract fun lrem(key: String, count: Long, element: ByteString): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mget/","title":"mget - Misk","text":"//misk-redis/misk.redis/DeferredRedis/mget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mget/#mget","title":"mget","text":"[jvm]\\ abstract fun mget(vararg keys: String): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mset/","title":"mset - Misk","text":"//misk-redis/misk.redis/DeferredRedis/mset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/mset/#mset","title":"mset","text":"[jvm]\\ abstract fun mset(vararg keyValues: ByteString): Supplier<Unit>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire-at/","title":"pExpireAt - Misk","text":"//misk-redis/misk.redis/DeferredRedis/pExpireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire-at/#pexpireat","title":"pExpireAt","text":"[jvm]\\ abstract fun pExpireAt(key: String, timestampMilliseconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire/","title":"pExpire - Misk","text":"//misk-redis/misk.redis/DeferredRedis/pExpire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/p-expire/#pexpire","title":"pExpire","text":"[jvm]\\ abstract fun pExpire(key: String, milliseconds: Long): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpop/","title":"rpop - Misk","text":"//misk-redis/misk.redis/DeferredRedis/rpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpop/#rpop","title":"rpop","text":"[jvm]\\ abstract fun rpop(key: String, count: Int): Supplier<List<ByteString?>>
abstract fun rpop(key: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpoplpush/","title":"rpoplpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/rpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpoplpush/#rpoplpush","title":"rpoplpush","text":"[jvm]\\ abstract fun rpoplpush(sourceKey: String, destinationKey: String): Supplier<ByteString?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpush/","title":"rpush - Misk","text":"//misk-redis/misk.redis/DeferredRedis/rpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/rpush/#rpush","title":"rpush","text":"[jvm]\\ abstract fun rpush(key: String, vararg elements: ByteString): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/set/","title":"set - Misk","text":"//misk-redis/misk.redis/DeferredRedis/set
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/set/#set","title":"set","text":"[jvm]\\ abstract fun set(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Unit>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/setnx/","title":"setnx - Misk","text":"//misk-redis/misk.redis/DeferredRedis/setnx
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/setnx/#setnx","title":"setnx","text":"[jvm]\\ abstract fun setnx(key: String, value: ByteString, expiryDuration: Duration? = null): Supplier<Boolean>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zadd/","title":"zadd - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zadd
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zadd/#zadd","title":"zadd","text":"[jvm]\\ abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Supplier<Long>
abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zcard/","title":"zcard - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zcard
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zcard/#zcard","title":"zcard","text":"[jvm]\\ abstract fun zcard(key: String): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange-with-scores/","title":"zrangeWithScores - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zrangeWithScores
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange-with-scores/#zrangewithscores","title":"zrangeWithScores","text":"[jvm]\\ abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<Pair<ByteString?, Double>>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange/","title":"zrange - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrange/#zrange","title":"zrange","text":"[jvm]\\ abstract fun zrange(key: String, type: Redis.ZRangeType = Redis.ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): Supplier<List<ByteString?>>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrem-range-by-rank/","title":"zremRangeByRank - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zremRangeByRank
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zrem-range-by-rank/#zremrangebyrank","title":"zremRangeByRank","text":"[jvm]\\ abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Supplier<Long>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zscore/","title":"zscore - Misk","text":"//misk-redis/misk.redis/DeferredRedis/zscore
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-deferred-redis/zscore/#zscore","title":"zscore","text":"[jvm]\\ abstract fun zscore(key: String, member: String): Supplier<Double?>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/","title":"RealRedis - Misk","text":"//misk-redis/misk.redis/RealRedis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#realredis","title":"RealRedis","text":"[jvm]\\ class RealRedis(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics) : Redis
For each command, a Jedis instance is retrieved from the pool and returned once the command has been issued.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#constructors","title":"Constructors","text":"RealRedis [jvm]constructor(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/#functions","title":"Functions","text":"Name Summary blmove [jvm]open override fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely. brpoplpush [jvm]open override fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely. close [jvm]open override fun close()Closes the connection to Redis. del [jvm]open override fun del(vararg keys: String): IntDeletes multiple keys.[jvm]open override fun del(key: String): BooleanDeletes a single key. expire [jvm]open override fun expire(key: String, seconds: Long): BooleanSet a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology. expireAt [jvm]open override fun expireAt(key: String, timestampSeconds: Long): BooleanexpireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately. flushAll [jvm]open override fun flushAll()Flushes all keys from all databases. get [jvm]open operator override fun get(key: String): ByteString?Retrieves the value for the given key as a ByteString. getDel [jvm]open override fun getDel(key: String): ByteString?Retrieves the value for the given key as a ByteString and deletes the key. hdel [jvm]open override fun hdel(key: String, vararg fields: String): LongDelete one or more hash fields stored at key. Specified fields that do not exist are ignored. hget [jvm]open override fun hget(key: String, field: String): ByteString?Retrieves the value for the given key and field as a ByteString. hgetAll [jvm]open override fun hgetAll(key: String): Map<String, ByteString>?Retrieves all the fields and associated values for the given key. Returns null if nothing found. hincrBy [jvm]open override fun hincrBy(key: String, field: String, increment: Long): LongIncrements the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed. hlen [jvm]open override fun hlen(key: String): LongReturns the number of fields contained in the hash stored at key. hmget [jvm]open override fun hmget(key: String, vararg fields: String): List<ByteString?>Retrieve the values associated to the specified fields. hrandField [jvm]open override fun hrandField(key: String, count: Long): List<String>Throws if count is negative. hrandFieldWithValues [jvm]open override fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?Throws if count is negative. hset [jvm]open override fun hset(key: String, hash: Map<String, ByteString>): LongSets the ByteString values for the given key and fields[jvm]open override fun hset(key: String, field: String, value: ByteString): LongSets the ByteString value for the given key and field incr [jvm]open override fun incr(key: String): LongIncrements the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. incrBy [jvm]open override fun incrBy(key: String, increment: Long): LongIncrements the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. lmove [jvm]open override fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination. lpop [jvm]open override fun lpop(key: String): ByteString?Removes and returns the first element of the list stored at key.[jvm]open override fun lpop(key: String, count: Int): List<ByteString?>Removes and returns the first count elements of the list stored at key. lpush [jvm]open override fun lpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. lrange [jvm]open override fun lrange(key: String, start: Long, stop: Long): List<ByteString?>Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on. lrem [jvm]open override fun lrem(key: String, count: Long, element: ByteString): LongRemoves the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list. mget [jvm]open override fun mget(vararg keys: String): List<ByteString?>Retrieves the values for the given list of keys. mset [jvm]open override fun mset(vararg keyValues: ByteString)Sets the key value pairs. multi [jvm]open override fun multi(): TransactionMarks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC. pExpire [jvm]open override fun pExpire(key: String, milliseconds: Long): BooleanThis command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds. pExpireAt [jvm]open override fun pExpireAt(key: String, timestampMilliseconds: Long): BooleanpExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds. pipelining [jvm]open override fun pipelining(block: DeferredRedis.() -> Unit)Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations. publish [jvm]open override fun publish(channel: String, message: String)Publish a message to a channel. rpop [jvm]open override fun rpop(key: String): ByteString?Removes and returns the last element of the list stored at key.[jvm]open override fun rpop(key: String, count: Int): List<ByteString?>Removes and returns the last count elements of the list stored at key. rpoplpush [jvm]open override fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination. rpush [jvm]open override fun rpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. scan [jvm]open override fun scan(cursor: String, matchPattern: String?, count: Int?): Redis.ScanResultPerforms a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through. set [jvm]open operator override fun set(key: String, value: ByteString)Sets the ByteString value for the given key.[jvm]open operator override fun set(key: String, expiryDuration: Duration, value: ByteString)Sets the ByteString value for a key with an expiration date. setnx [jvm]open override fun setnx(key: String, value: ByteString): Booleanopen override fun setnx(key: String, expiryDuration: Duration, value: ByteString): BooleanSets the ByteString value for the given key if it does not already exist. subscribe [jvm]open override fun subscribe(jedisPubSub: JedisPubSub, channel: String)Subscribe to a redis channel via pubsub. This is blocking! unwatch [jvm]open override fun unwatch(vararg keys: String)Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH. watch [jvm]open override fun watch(vararg keys: String)Marks the given keys to be watched for conditional execution of a transaction. zadd [jvm]open override fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): LongAdds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.[jvm]open override fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): LongAdds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering. zcard [jvm]open override fun zcard(key: String): LongReturns the sorted set cardinality (number of elements) of the sorted set stored at key zrange [jvm]open override fun zrange(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<ByteString?>Returns the specified range of elements in the sorted set stored at key. zrangeWithScores [jvm]open override fun zrangeWithScores(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<Pair<ByteString?, Double>>This is similar to zrange but returns the scores along with the members. zremRangeByRank [jvm]open override fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): LongRemoves all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth. zscore [jvm]open override fun zscore(key: String, member: String): Double?Returns the score of member in the sorted set at key."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-real-redis/","title":"RealRedis - Misk","text":"//misk-redis/misk.redis/RealRedis/RealRedis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-real-redis/#realredis","title":"RealRedis","text":"[jvm]\\ constructor(unifiedJedis: UnifiedJedis, clientMetrics: RedisClientMetrics)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/blmove/","title":"blmove - Misk","text":"//misk-redis/misk.redis/RealRedis/blmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/blmove/#blmove","title":"blmove","text":"[jvm]\\ open override fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?
blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely.
This command comes in place of the now deprecated brpoplpush. Doing BLMOVE RIGHT LEFT is equivalent.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See lmove for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/brpoplpush/","title":"brpoplpush - Misk","text":"//misk-redis/misk.redis/RealRedis/brpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/brpoplpush/#brpoplpush","title":"brpoplpush","text":"[jvm]\\ open override fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?
brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See rpoplpush for more information.
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by blmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/close/","title":"close - Misk","text":"//misk-redis/misk.redis/RealRedis/close
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/close/#close","title":"close","text":"[jvm]\\ open override fun close()
Closes the connection to Redis.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/","title":"del - Misk","text":"//misk-redis/misk.redis/RealRedis/del
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#del","title":"del","text":"[jvm]\\ open override fun del(key: String): Boolean
Deletes a single key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#return","title":"Return","text":"false if the key was not deleted, true if the key was deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#parameters","title":"Parameters","text":"jvm
key the key to delete[jvm]\\ open override fun del(vararg keys: String): Int
Deletes multiple keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#return_1","title":"Return","text":"0 if none of the keys were deleted, otherwise a positive integer representing the number of keys that were deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/del/#parameters_1","title":"Parameters","text":"jvm
keys the keys to delete"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire-at/","title":"expireAt - Misk","text":"//misk-redis/misk.redis/RealRedis/expireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire-at/#expireat","title":"expireAt","text":"[jvm]\\ open override fun expireAt(key: String, timestampSeconds: Long): Boolean
expireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately.
Please for the specific semantics of the command refer to the documentation of expire.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire/","title":"expire - Misk","text":"//misk-redis/misk.redis/RealRedis/expire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire/#expire","title":"expire","text":"[jvm]\\ open override fun expire(key: String, seconds: Long): Boolean
Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology.
The timeout will only be cleared by commands that delete or overwrite the contents of the key, including del, set, GETSET and all the *STORE commands. This means that all the operations that conceptually alter the value stored at the key without replacing it with a new one will leave the timeout untouched. For instance, incrementing the value of a key with incr, pushing a new value into a list with LPUSH, or altering the field value of a hash with hset are all operations that will leave the timeout untouched.
The timeout can also be cleared, turning the key back into a persistent key, using the PERSIST command.
If a key is renamed with RENAME, the associated time to live is transferred to the new key name.
If a key is overwritten by RENAME, like in the case of an existing key Key_A that is overwritten by a call like RENAME Key_B Key_A, it does not matter if the original Key_A had a timeout associated or not, the new key Key_A will inherit all the characteristics of Key_B.
Note that calling expire/pExpire with a non-positive timeout or expireAt/pExpireAt with a time in the past will result in the key being deleted rather than expired (accordingly, the emitted key event will be del, not expired).
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/flush-all/","title":"flushAll - Misk","text":"//misk-redis/misk.redis/RealRedis/flushAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/flush-all/#flushall","title":"flushAll","text":"[jvm]\\ open override fun flushAll()
Flushes all keys from all databases.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/","title":"getDel - Misk","text":"//misk-redis/misk.redis/RealRedis/getDel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/#getdel","title":"getDel","text":"[jvm]\\ open override fun getDel(key: String): ByteString?
Retrieves the value for the given key as a ByteString and deletes the key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get-del/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/","title":"get - Misk","text":"//misk-redis/misk.redis/RealRedis/get
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/#get","title":"get","text":"[jvm]\\ open operator override fun get(key: String): ByteString?
Retrieves the value for the given key as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/get/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hdel/","title":"hdel - Misk","text":"//misk-redis/misk.redis/RealRedis/hdel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hdel/#hdel","title":"hdel","text":"[jvm]\\ open override fun hdel(key: String, vararg fields: String): Long
Delete one or more hash fields stored at key. Specified fields that do not exist are ignored.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hdel/#return","title":"Return","text":"The number of fields that were removed from the hash. If the key does not exist, it is treated as an empty hash and 0 is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/","title":"hgetAll - Misk","text":"//misk-redis/misk.redis/RealRedis/hgetAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/#hgetall","title":"hgetAll","text":"[jvm]\\ open override fun hgetAll(key: String): Map<String, ByteString>?
Retrieves all the fields and associated values for the given key. Returns null if nothing found.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/#return","title":"Return","text":"a Map of the fields to their associated values"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget-all/#parameters","title":"Parameters","text":"
jvm
key the key"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/","title":"hget - Misk","text":"//misk-redis/misk.redis/RealRedis/hget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/#hget","title":"hget","text":"[jvm]\\ open override fun hget(key: String, field: String): ByteString?
Retrieves the value for the given key and field as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/#return","title":"Return","text":"a ByteString if the key/field combination was found, null if not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hget/#parameters","title":"Parameters","text":"jvm
key the key field the field"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/","title":"hincrBy - Misk","text":"//misk-redis/misk.redis/RealRedis/hincrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/#hincrby","title":"hincrBy","text":"[jvm]\\ open override fun hincrBy(key: String, field: String, increment: Long): Long
Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/#return","title":"Return","text":"the value at field after the increment operation.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hincr-by/#parameters","title":"Parameters","text":"jvm
key the key. field the field."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hlen/","title":"hlen - Misk","text":"//misk-redis/misk.redis/RealRedis/hlen
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hlen/#hlen","title":"hlen","text":"[jvm]\\ open override fun hlen(key: String): Long
Returns the number of fields contained in the hash stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/","title":"hmget - Misk","text":"//misk-redis/misk.redis/RealRedis/hmget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/#hmget","title":"hmget","text":"[jvm]\\ open override fun hmget(key: String, vararg fields: String): List<ByteString?>
Retrieve the values associated to the specified fields.
If some specified fields do not exist, nil values are returned. Non-existing keys are considered like empty hashes.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/#return","title":"Return","text":"a List of the values for the specific fields requested, in the same order of the request. Null for missing fields"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hmget/#parameters","title":"Parameters","text":"
jvm
key the key fields the specific fields to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field-with-values/","title":"hrandFieldWithValues - Misk","text":"//misk-redis/misk.redis/RealRedis/hrandFieldWithValues
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field-with-values/#hrandfieldwithvalues","title":"hrandFieldWithValues","text":"[jvm]\\ open override fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?
Throws if count is negative.
See misk.redis.Redis.hrandFieldWithValues.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field/","title":"hrandField - Misk","text":"//misk-redis/misk.redis/RealRedis/hrandField
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hrand-field/#hrandfield","title":"hrandField","text":"[jvm]\\ open override fun hrandField(key: String, count: Long): List<String>
Throws if count is negative.
See misk.redis.Redis.hrandField.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/","title":"hset - Misk","text":"//misk-redis/misk.redis/RealRedis/hset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#hset","title":"hset","text":"[jvm]\\ open override fun hset(key: String, field: String, value: ByteString): Long
Sets the ByteString value for the given key and field
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#return","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#parameters","title":"Parameters","text":"jvm
key the key field the field value the value to set[jvm]\\ open override fun hset(key: String, hash: Map<String, ByteString>): Long
Sets the ByteString values for the given key and fields
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#return_1","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/hset/#parameters_1","title":"Parameters","text":"jvm
key the key hash the map of fields to ByteString value"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr-by/","title":"incrBy - Misk","text":"//misk-redis/misk.redis/RealRedis/incrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr-by/#incrby","title":"incrBy","text":"[jvm]\\ open override fun incrBy(key: String, increment: Long): Long
Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
See incr for extra information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr/","title":"incr - Misk","text":"//misk-redis/misk.redis/RealRedis/incr
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/incr/#incr","title":"incr","text":"[jvm]\\ open override fun incr(key: String): Long
Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
Note: this is a string operation because Redis does not have a dedicated integer type. The string stored at the key is interpreted as a base-10 64 bit signed integer to execute the operation.
Redis stores integers in their integer representation, so for string values that actually hold an integer, there is no overhead for storing the string representation of the integer.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lmove/","title":"lmove - Misk","text":"//misk-redis/misk.redis/RealRedis/lmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lmove/#lmove","title":"lmove","text":"[jvm]\\ open override fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?
Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing LMOVE source destination RIGHT LEFT results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the first/last element from the list and pushing it as first/last element of the list, so it can be considered as a list rotation command (or a no-op if from is the same as to).
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
This command comes in place of the now deprecated RPOPLPUSH. Doing LMOVE RIGHT LEFT is equivalent.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpop/","title":"lpop - Misk","text":"//misk-redis/misk.redis/RealRedis/lpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpop/#lpop","title":"lpop","text":"[jvm]\\ open override fun lpop(key: String, count: Int): List<ByteString?>
Removes and returns the first count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ open override fun lpop(key: String): ByteString?
Removes and returns the first element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpush/","title":"lpush - Misk","text":"//misk-redis/misk.redis/RealRedis/lpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lpush/#lpush","title":"lpush","text":"[jvm]\\ open override fun lpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
//misk-redis/misk.redis/RealRedis/lrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lrange/#lrange","title":"lrange","text":"[jvm]\\ open override fun lrange(key: String, start: Long, stop: Long): List<ByteString?>
Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.
These offsets can also be negative numbers indicating offsets starting at the end of the list. For example, -1 is the last element of the list, -2 the penultimate, and so on.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lrem/","title":"lrem - Misk","text":"//misk-redis/misk.redis/RealRedis/lrem
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/lrem/#lrem","title":"lrem","text":"[jvm]\\ open override fun lrem(key: String, count: Long, element: ByteString): Long
Removes the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list.
Note that non-existing keys are treated like empty lists, so when key does not exist, the command will always return 0.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/","title":"mget - Misk","text":"//misk-redis/misk.redis/RealRedis/mget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/#mget","title":"mget","text":"[jvm]\\ open override fun mget(vararg keys: String): List<ByteString?>
Retrieves the values for the given list of keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/#return","title":"Return","text":"a list of String in the same order as the specified list of keys. For each key, a value will be returned if a key was found, otherwise null is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mget/#parameters","title":"Parameters","text":"jvm
keys the keys to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mset/","title":"mset - Misk","text":"//misk-redis/misk.redis/RealRedis/mset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mset/#mset","title":"mset","text":"[jvm]\\ open override fun mset(vararg keyValues: ByteString)
Sets the key value pairs.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/mset/#parameters","title":"Parameters","text":"jvm
keyValues the list of keys and values in alternating order."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/multi/","title":"multi - Misk","text":"//misk-redis/misk.redis/RealRedis/multi
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/multi/#multi","title":"multi","text":"[jvm]\\ open override fun multi(): Transaction
Marks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire-at/","title":"pExpireAt - Misk","text":"//misk-redis/misk.redis/RealRedis/pExpireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire-at/#pexpireat","title":"pExpireAt","text":"[jvm]\\ open override fun pExpireAt(key: String, timestampMilliseconds: Long): Boolean
pExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire/","title":"pExpire - Misk","text":"//misk-redis/misk.redis/RealRedis/pExpire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire/#pexpire","title":"pExpire","text":"[jvm]\\ open override fun pExpire(key: String, milliseconds: Long): Boolean
This command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/p-expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/pipelining/","title":"pipelining - Misk","text":"//misk-redis/misk.redis/RealRedis/pipelining
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/pipelining/#pipelining","title":"pipelining","text":"[jvm]\\ open override fun pipelining(block: DeferredRedis.() -> Unit)
Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations.
See Redis pipelining for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/publish/","title":"publish - Misk","text":"//misk-redis/misk.redis/RealRedis/publish
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/publish/#publish","title":"publish","text":"[jvm]\\ open override fun publish(channel: String, message: String)
Publish a message to a channel.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpop/","title":"rpop - Misk","text":"//misk-redis/misk.redis/RealRedis/rpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpop/#rpop","title":"rpop","text":"[jvm]\\ open override fun rpop(key: String, count: Int): List<ByteString?>
Removes and returns the last count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ open override fun rpop(key: String): ByteString?
Removes and returns the last element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpoplpush/","title":"rpoplpush - Misk","text":"//misk-redis/misk.redis/RealRedis/rpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpoplpush/#rpoplpush","title":"rpoplpush","text":"[jvm]\\ open override fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?
Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing rpoplpush results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the last element from the list and pushing it as first element of the list, so it can be considered as a list rotation command.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by lmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpush/","title":"rpush - Misk","text":"//misk-redis/misk.redis/RealRedis/rpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/rpush/#rpush","title":"rpush","text":"[jvm]\\ open override fun rpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
//misk-redis/misk.redis/RealRedis/scan
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/scan/#scan","title":"scan","text":"[jvm]\\ open override fun scan(cursor: String, matchPattern: String?, count: Int?): Redis.ScanResult
Performs a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/scan/#return","title":"Return","text":"A ScanResult containing the next cursor and the current batch of keys. If the returned cursor is \"0\", then there are no more keys left in the iteration.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/scan/#parameters","title":"Parameters","text":"jvm
cursor The scan cursor. This should first be \"0\". Then subsequent cursor values will be taken from the returned ScanResults. matchPattern A glob-like match pattern to filter keys by. If this is not provided, then all keys will be scanned. count A hinted desired batch size to be returned in each ScanResult. Note that this is just a hint and there are no guarantees on the actual size of each ScanResult."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/","title":"set - Misk","text":"//misk-redis/misk.redis/RealRedis/set
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/#set","title":"set","text":"[jvm]\\ open operator override fun set(key: String, value: ByteString)
Sets the ByteString value for the given key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ open operator override fun set(key: String, expiryDuration: Duration, value: ByteString)
Sets the ByteString value for a key with an expiration date.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/set/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/","title":"setnx - Misk","text":"//misk-redis/misk.redis/RealRedis/setnx
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/#setnx","title":"setnx","text":"[jvm]\\ open override fun setnx(key: String, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ open override fun setnx(key: String, expiryDuration: Duration, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/setnx/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/subscribe/","title":"subscribe - Misk","text":"//misk-redis/misk.redis/RealRedis/subscribe
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ open override fun subscribe(jedisPubSub: JedisPubSub, channel: String)
Subscribe to a redis channel via pubsub. This is blocking!
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/unwatch/","title":"unwatch - Misk","text":"//misk-redis/misk.redis/RealRedis/unwatch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open override fun unwatch(vararg keys: String)
Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/watch/","title":"watch - Misk","text":"//misk-redis/misk.redis/RealRedis/watch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(vararg keys: String)
Marks the given keys to be watched for conditional execution of a transaction.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zadd/","title":"zadd - Misk","text":"//misk-redis/misk.redis/RealRedis/zadd
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zadd/#zadd","title":"zadd","text":"[jvm]\\ open override fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Long
Adds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions.
[jvm]\\ open override fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Long
Adds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zcard/","title":"zcard - Misk","text":"//misk-redis/misk.redis/RealRedis/zcard
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zcard/#zcard","title":"zcard","text":"[jvm]\\ open override fun zcard(key: String): Long
Returns the sorted set cardinality (number of elements) of the sorted set stored at key
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange-with-scores/","title":"zrangeWithScores - Misk","text":"//misk-redis/misk.redis/RealRedis/zrangeWithScores
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange-with-scores/#zrangewithscores","title":"zrangeWithScores","text":"[jvm]\\ open override fun zrangeWithScores(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<Pair<ByteString?, Double>>
This is similar to zrange but returns the scores along with the members.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange/","title":"zrange - Misk","text":"//misk-redis/misk.redis/RealRedis/zrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrange/#zrange","title":"zrange","text":"[jvm]\\ open override fun zrange(key: String, type: Redis.ZRangeType, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean, limit: Redis.ZRangeLimit?): List<ByteString?>
Returns the specified range of elements in the sorted set stored at key.
ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order. Currently only index and score type range queries are supported. See ZRangeType for different types of range queries.
You can specify the start and stop of the range you want to filter by. Depending on the type you will have to use the appropriate type of ZRangeMarker.
The order of elements is from the lowest to the highest score. Elements with the same score are ordered lexicographically.
Setting reverse reverses the ordering, so elements are ordered from highest to lowest score, and score ties are resolved by reverse lexicographical ordering.
The limit argument can be used to obtain a sub-range from the matching elements. See ZRangeLimit for more info.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrem-range-by-rank/","title":"zremRangeByRank - Misk","text":"//misk-redis/misk.redis/RealRedis/zremRangeByRank
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zrem-range-by-rank/#zremrangebyrank","title":"zremRangeByRank","text":"[jvm]\\ open override fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Long
Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zscore/","title":"zscore - Misk","text":"//misk-redis/misk.redis/RealRedis/zscore
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/zscore/#zscore","title":"zscore","text":"[jvm]\\ open override fun zscore(key: String, member: String): Double?
Returns the score of member in the sorted set at key.
If member does not exist in the sorted set, or key does not exist, nil is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/","title":"Companion - Misk","text":"//misk-redis/misk.redis/RealRedis/Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/#properties","title":"Properties","text":"Name Summary charset [jvm]val charset: Charset"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/charset/","title":"charset - Misk","text":"//misk-redis/misk.redis/RealRedis/Companion/charset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-real-redis/-companion/charset/#charset","title":"charset","text":"[jvm]\\ val charset: Charset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/","title":"Redis - Misk","text":"//misk-redis/misk.redis/Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#redis","title":"Redis","text":"interface Redis
A Redis client.
Note: special care must be taken if your Redis is running in cluster mode, as keys must belong to the same slot in a single command operation like lmove. You can control which hash slot a key belongs to a certain degree by making use of {hashtags} in the key name.
See the Redis Cluster Spec for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#inheritors","title":"Inheritors","text":"RealRedis"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#types","title":"Types","text":"Name Summary ScanResult [jvm]data class ScanResult(val cursor: String, val keys: List<String>) ZAddOptions [jvm]enum ZAddOptions : Enum<Redis.ZAddOptions> Options for ZADD. Not all options are compatible with one another. See the ZADD command documentation for more information. ZRangeIndexMarker [jvm]data class ZRangeIndexMarker(val intValue: Int) : Redis.ZRangeMarkerTo be used when ZRangeType is ZRangeType.INDEX. The intValue should be an integer specifying the index (start or stop) ZRangeLimit [jvm]data class ZRangeLimit(val offset: Int, val count: Int)The limit argument in zrange and zrangeWithScores can be used to obtain a sub-range from the matching elements similar to SELECT LIMIT offset, count in SQL. A negative count returns all elements from the offset. Keep in mind that if is large, the sorted set needs to be traversed for elements before getting to the elements to return, which can add up to O(N) time complexity. ZRangeMarker [jvm]abstract class ZRangeMarker(val value: Any, val included: Boolean) ZRangeRankMarker [jvm]data class ZRangeRankMarker(val longValue: Long) : Redis.ZRangeMarker ZRangeScoreMarker [jvm]data class ZRangeScoreMarker@JvmOverloadsconstructor(val doubleValue: Double, val isIncluded: Boolean = true) : Redis.ZRangeMarkerTo be used when ZRangeType is ZRangeType.SCORE. The doubleValue should be a double specifying the score (start or stop) By default the range is included. Set isIncluded to false in order to exclude the start or stop. ZRangeType [jvm]enum ZRangeType : Enum<Redis.ZRangeType> Different types of range queries."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/#functions","title":"Functions","text":"Name Summary blmove [jvm]abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely. brpoplpush [jvm]abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely. close [jvm]abstract fun close()Closes the client, so it may not be used further. del [jvm]abstract fun del(vararg keys: String): IntDeletes multiple keys.[jvm]abstract fun del(key: String): BooleanDeletes a single key. expire [jvm]abstract fun expire(key: String, seconds: Long): BooleanSet a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology. expireAt [jvm]abstract fun expireAt(key: String, timestampSeconds: Long): BooleanexpireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately. flushAll [jvm]abstract fun flushAll()Flushes all keys from all databases. get [jvm]abstract operator fun get(key: String): ByteString?Retrieves the value for the given key as a ByteString. getDel [jvm]abstract fun getDel(key: String): ByteString?Retrieves the value for the given key as a ByteString and deletes the key. hdel [jvm]abstract fun hdel(key: String, vararg fields: String): LongDelete one or more hash fields stored at key. Specified fields that do not exist are ignored. hget [jvm]abstract fun hget(key: String, field: String): ByteString?Retrieves the value for the given key and field as a ByteString. hgetAll [jvm]abstract fun hgetAll(key: String): Map<String, ByteString>?Retrieves all the fields and associated values for the given key. Returns null if nothing found. hincrBy [jvm]abstract fun hincrBy(key: String, field: String, increment: Long): LongIncrements the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed. hlen [jvm]abstract fun hlen(key: String): LongReturns the number of fields contained in the hash stored at key. hmget [jvm]abstract fun hmget(key: String, vararg fields: String): List<ByteString?>Retrieve the values associated to the specified fields. hrandField [jvm]abstract fun hrandField(key: String, count: Long): List<String>Like hrandFieldWithValues but only returns the fields of the hash stored at key. hrandFieldWithValues [jvm]abstract fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?Randomly selects count fields and values from the hash stored at key. hset [jvm]abstract fun hset(key: String, hash: Map<String, ByteString>): LongSets the ByteString values for the given key and fields[jvm]abstract fun hset(key: String, field: String, value: ByteString): LongSets the ByteString value for the given key and field incr [jvm]abstract fun incr(key: String): LongIncrements the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. incrBy [jvm]abstract fun incrBy(key: String, increment: Long): LongIncrements the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer. lmove [jvm]abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination. lpop [jvm]abstract fun lpop(key: String): ByteString?Removes and returns the first element of the list stored at key.[jvm]abstract fun lpop(key: String, count: Int): List<ByteString?>Removes and returns the first count elements of the list stored at key. lpush [jvm]abstract fun lpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. lrange [jvm]abstract fun lrange(key: String, start: Long, stop: Long): List<ByteString?>Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on. lrem [jvm]abstract fun lrem(key: String, count: Long, element: ByteString): LongRemoves the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list. mget [jvm]abstract fun mget(vararg keys: String): List<ByteString?>Retrieves the values for the given list of keys. mset [jvm]abstract fun mset(vararg keyValues: ByteString)Sets the key value pairs. multi [jvm]abstract fun multi(): TransactionMarks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC. pExpire [jvm]abstract fun pExpire(key: String, milliseconds: Long): BooleanThis command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds. pExpireAt [jvm]abstract fun pExpireAt(key: String, timestampMilliseconds: Long): BooleanpExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds. pipelining [jvm]abstract fun pipelining(block: DeferredRedis.() -> Unit)Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations. publish [jvm]abstract fun publish(channel: String, message: String)Publish a message to a channel. rpop [jvm]abstract fun rpop(key: String): ByteString?Removes and returns the last element of the list stored at key.[jvm]abstract fun rpop(key: String, count: Int): List<ByteString?>Removes and returns the last count elements of the list stored at key. rpoplpush [jvm]abstract fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination. rpush [jvm]abstract fun rpush(key: String, vararg elements: ByteString): LongInsert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned. scan [jvm]abstract fun scan(cursor: String, matchPattern: String? = null, count: Int? = null): Redis.ScanResultPerforms a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through. set [jvm]abstract operator fun set(key: String, value: ByteString)Sets the ByteString value for the given key.[jvm]abstract operator fun set(key: String, expiryDuration: Duration, value: ByteString)Sets the ByteString value for a key with an expiration date. setnx [jvm]abstract fun setnx(key: String, value: ByteString): Booleanabstract fun setnx(key: String, expiryDuration: Duration, value: ByteString): BooleanSets the ByteString value for the given key if it does not already exist. subscribe [jvm]abstract fun subscribe(jedisPubSub: JedisPubSub, channel: String)Subscribe to a redis channel via pubsub. This is blocking! unwatch [jvm]abstract fun unwatch(vararg keys: String)Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH. watch [jvm]abstract fun watch(vararg keys: String)Marks the given keys to be watched for conditional execution of a transaction. zadd [jvm]abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): LongAdds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.[jvm]abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): LongAdds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering. zcard [jvm]abstract fun zcard(key: String): LongReturns the sorted set cardinality (number of elements) of the sorted set stored at key zrange [jvm]abstract fun zrange(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<ByteString?>Returns the specified range of elements in the sorted set stored at key. zrangeWithScores [jvm]abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<Pair<ByteString?, Double>>This is similar to zrange but returns the scores along with the members. zremRangeByRank [jvm]abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): LongRemoves all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth. zscore [jvm]abstract fun zscore(key: String, member: String): Double?Returns the score of member in the sorted set at key."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/blmove/","title":"blmove - Misk","text":"//misk-redis/misk.redis/Redis/blmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/blmove/#blmove","title":"blmove","text":"[jvm]\\ abstract fun blmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection, timeoutSeconds: Double): ByteString?
blmove is the blocking variant of lmove. When source contains elements, this command behaves exactly like lmove. When used inside a MULTI/EXEC block, this command behaves exactly like lmove. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely.
This command comes in place of the now deprecated brpoplpush. Doing BLMOVE RIGHT LEFT is equivalent.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See lmove for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/brpoplpush/","title":"brpoplpush - Misk","text":"//misk-redis/misk.redis/Redis/brpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/brpoplpush/#brpoplpush","title":"brpoplpush","text":"[jvm]\\ abstract fun brpoplpush(sourceKey: String, destinationKey: String, timeoutSeconds: Int): ByteString?
brpoplpush is the blocking variant of rpoplpush. When source contains elements, this command behaves exactly like rpoplpush. When used inside a MULTI/EXEC block, this command behaves exactly like rpoplpush. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
See rpoplpush for more information.
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by blmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/close/","title":"close - Misk","text":"//misk-redis/misk.redis/Redis/close
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/close/#close","title":"close","text":"[jvm]\\ abstract fun close()
Closes the client, so it may not be used further.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/","title":"del - Misk","text":"//misk-redis/misk.redis/Redis/del
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#del","title":"del","text":"[jvm]\\ abstract fun del(key: String): Boolean
Deletes a single key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#return","title":"Return","text":"false if the key was not deleted, true if the key was deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#parameters","title":"Parameters","text":"jvm
key the key to delete[jvm]\\ abstract fun del(vararg keys: String): Int
Deletes multiple keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#return_1","title":"Return","text":"0 if none of the keys were deleted, otherwise a positive integer representing the number of keys that were deleted
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/del/#parameters_1","title":"Parameters","text":"jvm
keys the keys to delete"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire-at/","title":"expireAt - Misk","text":"//misk-redis/misk.redis/Redis/expireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire-at/#expireat","title":"expireAt","text":"[jvm]\\ abstract fun expireAt(key: String, timestampSeconds: Long): Boolean
expireAt has the same effect and semantic as expire, but instead of specifying the number of seconds representing the TTL (time to live), it takes an absolute Unix timestamp (seconds since January 1, 1970). A timestamp in the past will delete the key immediately.
Please for the specific semantics of the command refer to the documentation of expire.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire/","title":"expire - Misk","text":"//misk-redis/misk.redis/Redis/expire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire/#expire","title":"expire","text":"[jvm]\\ abstract fun expire(key: String, seconds: Long): Boolean
Set a timeout on key. After the timeout has expired, the key will automatically be deleted. A key with an associated timeout is often said to be volatile in Redis terminology.
The timeout will only be cleared by commands that delete or overwrite the contents of the key, including del, set, GETSET and all the *STORE commands. This means that all the operations that conceptually alter the value stored at the key without replacing it with a new one will leave the timeout untouched. For instance, incrementing the value of a key with incr, pushing a new value into a list with LPUSH, or altering the field value of a hash with hset are all operations that will leave the timeout untouched.
The timeout can also be cleared, turning the key back into a persistent key, using the PERSIST command.
If a key is renamed with RENAME, the associated time to live is transferred to the new key name.
If a key is overwritten by RENAME, like in the case of an existing key Key_A that is overwritten by a call like RENAME Key_B Key_A, it does not matter if the original Key_A had a timeout associated or not, the new key Key_A will inherit all the characteristics of Key_B.
Note that calling expire/pExpire with a non-positive timeout or expireAt/pExpireAt with a time in the past will result in the key being deleted rather than expired (accordingly, the emitted key event will be del, not expired).
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/flush-all/","title":"flushAll - Misk","text":"//misk-redis/misk.redis/Redis/flushAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/flush-all/#flushall","title":"flushAll","text":"[jvm]\\ abstract fun flushAll()
Flushes all keys from all databases.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/","title":"getDel - Misk","text":"//misk-redis/misk.redis/Redis/getDel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/#getdel","title":"getDel","text":"[jvm]\\ abstract fun getDel(key: String): ByteString?
Retrieves the value for the given key as a ByteString and deletes the key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get-del/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/","title":"get - Misk","text":"//misk-redis/misk.redis/Redis/get
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/#get","title":"get","text":"[jvm]\\ abstract operator fun get(key: String): ByteString?
Retrieves the value for the given key as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/#return","title":"Return","text":"a ByteString if the key was found, null if the key was not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/get/#parameters","title":"Parameters","text":"jvm
key the key to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hdel/","title":"hdel - Misk","text":"//misk-redis/misk.redis/Redis/hdel
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hdel/#hdel","title":"hdel","text":"[jvm]\\ abstract fun hdel(key: String, vararg fields: String): Long
Delete one or more hash fields stored at key. Specified fields that do not exist are ignored.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hdel/#return","title":"Return","text":"The number of fields that were removed from the hash. If the key does not exist, it is treated as an empty hash and 0 is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/","title":"hgetAll - Misk","text":"//misk-redis/misk.redis/Redis/hgetAll
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/#hgetall","title":"hgetAll","text":"[jvm]\\ abstract fun hgetAll(key: String): Map<String, ByteString>?
Retrieves all the fields and associated values for the given key. Returns null if nothing found.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/#return","title":"Return","text":"a Map of the fields to their associated values"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget-all/#parameters","title":"Parameters","text":"
jvm
key the key"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/","title":"hget - Misk","text":"//misk-redis/misk.redis/Redis/hget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/#hget","title":"hget","text":"[jvm]\\ abstract fun hget(key: String, field: String): ByteString?
Retrieves the value for the given key and field as a ByteString.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/#return","title":"Return","text":"a ByteString if the key/field combination was found, null if not found
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hget/#parameters","title":"Parameters","text":"jvm
key the key field the field"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/","title":"hincrBy - Misk","text":"//misk-redis/misk.redis/Redis/hincrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/#hincrby","title":"hincrBy","text":"[jvm]\\ abstract fun hincrBy(key: String, field: String, increment: Long): Long
Increments the number stored at field in the hash stored at key by increment. If key does not exist, a new key holding a hash is created. If field does not exist the value is set to 0 before the operation is performed.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/#return","title":"Return","text":"the value at field after the increment operation.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hincr-by/#parameters","title":"Parameters","text":"jvm
key the key. field the field."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hlen/","title":"hlen - Misk","text":"//misk-redis/misk.redis/Redis/hlen
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hlen/#hlen","title":"hlen","text":"[jvm]\\ abstract fun hlen(key: String): Long
Returns the number of fields contained in the hash stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/","title":"hmget - Misk","text":"//misk-redis/misk.redis/Redis/hmget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/#hmget","title":"hmget","text":"[jvm]\\ abstract fun hmget(key: String, vararg fields: String): List<ByteString?>
Retrieve the values associated to the specified fields.
If some specified fields do not exist, nil values are returned. Non-existing keys are considered like empty hashes.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/#return","title":"Return","text":"a List of the values for the specific fields requested, in the same order of the request. Null for missing fields"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hmget/#parameters","title":"Parameters","text":"
jvm
key the key fields the specific fields to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field-with-values/","title":"hrandFieldWithValues - Misk","text":"//misk-redis/misk.redis/Redis/hrandFieldWithValues
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field-with-values/#hrandfieldwithvalues","title":"hrandFieldWithValues","text":"[jvm]\\ abstract fun hrandFieldWithValues(key: String, count: Long): Map<String, ByteString>?
Randomly selects count fields and values from the hash stored at key.
NB: Implementations using Jedis 4 or seeking to emulate Jedis should use checkHrandFieldCount to avoid surprising behaviour like retrieving a result map which is smaller than requested by a completely random factor.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field/","title":"hrandField - Misk","text":"//misk-redis/misk.redis/Redis/hrandField
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hrand-field/#hrandfield","title":"hrandField","text":"[jvm]\\ abstract fun hrandField(key: String, count: Long): List<String>
Like hrandFieldWithValues but only returns the fields of the hash stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/","title":"hset - Misk","text":"//misk-redis/misk.redis/Redis/hset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#hset","title":"hset","text":"[jvm]\\ abstract fun hset(key: String, field: String, value: ByteString): Long
Sets the ByteString value for the given key and field
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#return","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#parameters","title":"Parameters","text":"jvm
key the key field the field value the value to set[jvm]\\ abstract fun hset(key: String, hash: Map<String, ByteString>): Long
Sets the ByteString values for the given key and fields
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#return_1","title":"Return","text":"The number of fields that were added. Returns 0 if all fields had their values overwritten.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/hset/#parameters_1","title":"Parameters","text":"jvm
key the key hash the map of fields to ByteString value"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr-by/","title":"incrBy - Misk","text":"//misk-redis/misk.redis/Redis/incrBy
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr-by/#incrby","title":"incrBy","text":"[jvm]\\ abstract fun incrBy(key: String, increment: Long): Long
Increments the number stored at key by increment. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
See incr for extra information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr/","title":"incr - Misk","text":"//misk-redis/misk.redis/Redis/incr
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/incr/#incr","title":"incr","text":"[jvm]\\ abstract fun incr(key: String): Long
Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.
Note: this is a string operation because Redis does not have a dedicated integer type. The string stored at the key is interpreted as a base-10 64 bit signed integer to execute the operation.
Redis stores integers in their integer representation, so for string values that actually hold an integer, there is no overhead for storing the string representation of the integer.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lmove/","title":"lmove - Misk","text":"//misk-redis/misk.redis/Redis/lmove
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lmove/#lmove","title":"lmove","text":"[jvm]\\ abstract fun lmove(sourceKey: String, destinationKey: String, from: ListDirection, to: ListDirection): ByteString?
Atomically returns and removes the first/last element (head/tail depending on the from argument) of the list stored at source, and pushes the element at the first/last element (head/tail depending on the to argument) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing LMOVE source destination RIGHT LEFT results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the first/last element from the list and pushing it as first/last element of the list, so it can be considered as a list rotation command (or a no-op if from is the same as to).
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
This command comes in place of the now deprecated RPOPLPUSH. Doing LMOVE RIGHT LEFT is equivalent.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpop/","title":"lpop - Misk","text":"//misk-redis/misk.redis/Redis/lpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpop/#lpop","title":"lpop","text":"[jvm]\\ abstract fun lpop(key: String, count: Int): List<ByteString?>
Removes and returns the first count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ abstract fun lpop(key: String): ByteString?
Removes and returns the first element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpush/","title":"lpush - Misk","text":"//misk-redis/misk.redis/Redis/lpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lpush/#lpush","title":"lpush","text":"[jvm]\\ abstract fun lpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
//misk-redis/misk.redis/Redis/lrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lrange/#lrange","title":"lrange","text":"[jvm]\\ abstract fun lrange(key: String, start: Long, stop: Long): List<ByteString?>
Returns the specified elements of the list stored at key. The offsets start and stop are zero-based indexes, with 0 being the first element of the list (the head of the list), 1 being the next element and so on.
These offsets can also be negative numbers indicating offsets starting at the end of the list. For example, -1 is the last element of the list, -2 the penultimate, and so on.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lrem/","title":"lrem - Misk","text":"//misk-redis/misk.redis/Redis/lrem
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/lrem/#lrem","title":"lrem","text":"[jvm]\\ abstract fun lrem(key: String, count: Long, element: ByteString): Long
Removes the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways: count 0: Remove elements equal to element moving from head to tail. count < 0: Remove elements equal to element moving from tail to head. count = 0: Remove all elements equal to element. For example, LREM list -2 \"hello\" will remove the last two occurrences of \"hello\" in the list stored at list.
Note that non-existing keys are treated like empty lists, so when key does not exist, the command will always return 0.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/","title":"mget - Misk","text":"//misk-redis/misk.redis/Redis/mget
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/#mget","title":"mget","text":"[jvm]\\ abstract fun mget(vararg keys: String): List<ByteString?>
Retrieves the values for the given list of keys.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/#return","title":"Return","text":"a list of String in the same order as the specified list of keys. For each key, a value will be returned if a key was found, otherwise null is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mget/#parameters","title":"Parameters","text":"jvm
keys the keys to retrieve"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mset/","title":"mset - Misk","text":"//misk-redis/misk.redis/Redis/mset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mset/#mset","title":"mset","text":"[jvm]\\ abstract fun mset(vararg keyValues: ByteString)
Sets the key value pairs.
On cluster mode, this might trigger multiple calls to Redis
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/mset/#parameters","title":"Parameters","text":"jvm
keyValues the list of keys and values in alternating order."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/multi/","title":"multi - Misk","text":"//misk-redis/misk.redis/Redis/multi
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/multi/#multi","title":"multi","text":"[jvm]\\ abstract fun multi(): Transaction
Marks the start of a transaction block. Subsequent commands will be queued for atomic execution using EXEC.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire-at/","title":"pExpireAt - Misk","text":"//misk-redis/misk.redis/Redis/pExpireAt
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire-at/#pexpireat","title":"pExpireAt","text":"[jvm]\\ abstract fun pExpireAt(key: String, timestampMilliseconds: Long): Boolean
pExpireAt has the same effect and semantic as expireAt, but the Unix time at which the key will expire is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire-at/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire/","title":"pExpire - Misk","text":"//misk-redis/misk.redis/Redis/pExpire
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire/#pexpire","title":"pExpire","text":"[jvm]\\ abstract fun pExpire(key: String, milliseconds: Long): Boolean
This command works exactly like expire but the time to live of the key is specified in milliseconds instead of seconds.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/p-expire/#return","title":"Return","text":"true if the timeout was set. false if the timeout was not set. e.g. key doesn\u2019t exist, or operation skipped due to the provided arguments.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/pipelining/","title":"pipelining - Misk","text":"//misk-redis/misk.redis/Redis/pipelining
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/pipelining/#pipelining","title":"pipelining","text":"[jvm]\\ abstract fun pipelining(block: DeferredRedis.() -> Unit)
Runs a block of Redis commands in a pipeline, for better performance. Pipelined command responses are not returned until the block completes. If you need to use the results of each command immediately, either save the Suppliers and call them later, or use non-pipelined operations.
See Redis pipelining for more information.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/publish/","title":"publish - Misk","text":"//misk-redis/misk.redis/Redis/publish
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/publish/#publish","title":"publish","text":"[jvm]\\ abstract fun publish(channel: String, message: String)
Publish a message to a channel.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpop/","title":"rpop - Misk","text":"//misk-redis/misk.redis/Redis/rpop
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpop/#rpop","title":"rpop","text":"[jvm]\\ abstract fun rpop(key: String, count: Int): List<ByteString?>
Removes and returns the last count elements of the list stored at key.
Only available on Redis 6.2.0 and higher. Throws if Redis is too low of a version.
[jvm]\\ abstract fun rpop(key: String): ByteString?
Removes and returns the last element of the list stored at key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpoplpush/","title":"rpoplpush - Misk","text":"//misk-redis/misk.redis/Redis/rpoplpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpoplpush/#rpoplpush","title":"rpoplpush","text":"[jvm]\\ abstract fun rpoplpush(sourceKey: String, destinationKey: String): ByteString?
Atomically returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at destination.
For example: consider source holding the list a,b,c, and destination holding the list x,y,z. Executing rpoplpush results in source holding a,b and destination holding c,x,y,z.
If source does not exist, the value nil is returned and no operation is performed. If source and destination are the same, the operation is equivalent to removing the last element from the list and pushing it as first element of the list, so it can be considered as a list rotation command.
Throws an error if using Redis Cluster and source and destination are not in the same hash slot
As of Redis version 6.2.0, this command is regarded as deprecated.
It can be replaced by lmove with the RIGHT and LEFT arguments when migrating or writing new code.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpush/","title":"rpush - Misk","text":"//misk-redis/misk.redis/Redis/rpush
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/rpush/#rpush","title":"rpush","text":"[jvm]\\ abstract fun rpush(key: String, vararg elements: ByteString): Long
Insert all the specified elements at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
//misk-redis/misk.redis/Redis/scan
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/scan/#scan","title":"scan","text":"[jvm]\\ abstract fun scan(cursor: String, matchPattern: String? = null, count: Int? = null): Redis.ScanResult
Performs a batched iteration of matching keys. If no pattern is provided, all keys will be scanned through.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/scan/#return","title":"Return","text":"A ScanResult containing the next cursor and the current batch of keys. If the returned cursor is \"0\", then there are no more keys left in the iteration.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/scan/#parameters","title":"Parameters","text":"jvm
cursor The scan cursor. This should first be \"0\". Then subsequent cursor values will be taken from the returned ScanResults. matchPattern A glob-like match pattern to filter keys by. If this is not provided, then all keys will be scanned. count A hinted desired batch size to be returned in each ScanResult. Note that this is just a hint and there are no guarantees on the actual size of each ScanResult."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/","title":"set - Misk","text":"//misk-redis/misk.redis/Redis/set
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/#set","title":"set","text":"[jvm]\\ abstract operator fun set(key: String, value: ByteString)
Sets the ByteString value for the given key.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ abstract operator fun set(key: String, expiryDuration: Duration, value: ByteString)
Sets the ByteString value for a key with an expiration date.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/set/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/","title":"setnx - Misk","text":"//misk-redis/misk.redis/Redis/setnx
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/#setnx","title":"setnx","text":"[jvm]\\ abstract fun setnx(key: String, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/#parameters","title":"Parameters","text":"jvm
key the key to set value the value to set[jvm]\\ abstract fun setnx(key: String, expiryDuration: Duration, value: ByteString): Boolean
Sets the ByteString value for the given key if it does not already exist.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/setnx/#parameters_1","title":"Parameters","text":"jvm
key the key to set expiryDuration the amount of time before the key expires value the value to set"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/subscribe/","title":"subscribe - Misk","text":"//misk-redis/misk.redis/Redis/subscribe
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/subscribe/#subscribe","title":"subscribe","text":"[jvm]\\ abstract fun subscribe(jedisPubSub: JedisPubSub, channel: String)
Subscribe to a redis channel via pubsub. This is blocking!
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/unwatch/","title":"unwatch - Misk","text":"//misk-redis/misk.redis/Redis/unwatch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ abstract fun unwatch(vararg keys: String)
Flushes all the previously watched keys for a transaction. If you call EXEC or DISCARD, there\u2019s no need to manually call UNWATCH.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/watch/","title":"watch - Misk","text":"//misk-redis/misk.redis/Redis/watch
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/watch/#watch","title":"watch","text":"[jvm]\\ abstract fun watch(vararg keys: String)
Marks the given keys to be watched for conditional execution of a transaction.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zadd/","title":"zadd - Misk","text":"//misk-redis/misk.redis/Redis/zadd
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zadd/#zadd","title":"zadd","text":"[jvm]\\ abstract fun zadd(key: String, score: Double, member: String, vararg options: Redis.ZAddOptions): Long
Adds the specified member with the specified score to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions.
[jvm]\\ abstract fun zadd(key: String, scoreMembers: Map<String, Double>, vararg options: Redis.ZAddOptions): Long
Adds all the specified members with the specified scores in scoreMembers to the sorted set at the key. If a specified member is already a member of the sorted set, the score is updated and the element reinserted at the right position to ensure the correct ordering.
If key does not exist, a new sorted set with the specified member as sole member is created, like if the sorted set was empty. If the key exists but does not hold a sorted set, an error is returned.
ZADD supports a list of options, specified after the name of the key and before the first score argument. The complete list of options can be found in ZAddOptions
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zcard/","title":"zcard - Misk","text":"//misk-redis/misk.redis/Redis/zcard
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zcard/#zcard","title":"zcard","text":"[jvm]\\ abstract fun zcard(key: String): Long
Returns the sorted set cardinality (number of elements) of the sorted set stored at key
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange-with-scores/","title":"zrangeWithScores - Misk","text":"//misk-redis/misk.redis/Redis/zrangeWithScores
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange-with-scores/#zrangewithscores","title":"zrangeWithScores","text":"[jvm]\\ abstract fun zrangeWithScores(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<Pair<ByteString?, Double>>
This is similar to zrange but returns the scores along with the members.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange/","title":"zrange - Misk","text":"//misk-redis/misk.redis/Redis/zrange
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrange/#zrange","title":"zrange","text":"[jvm]\\ abstract fun zrange(key: String, type: Redis.ZRangeType = ZRangeType.INDEX, start: Redis.ZRangeMarker, stop: Redis.ZRangeMarker, reverse: Boolean = false, limit: Redis.ZRangeLimit? = null): List<ByteString?>
Returns the specified range of elements in the sorted set stored at key.
ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order. Currently only index and score type range queries are supported. See ZRangeType for different types of range queries.
You can specify the start and stop of the range you want to filter by. Depending on the type you will have to use the appropriate type of ZRangeMarker.
The order of elements is from the lowest to the highest score. Elements with the same score are ordered lexicographically.
Setting reverse reverses the ordering, so elements are ordered from highest to lowest score, and score ties are resolved by reverse lexicographical ordering.
The limit argument can be used to obtain a sub-range from the matching elements. See ZRangeLimit for more info.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrem-range-by-rank/","title":"zremRangeByRank - Misk","text":"//misk-redis/misk.redis/Redis/zremRangeByRank
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zrem-range-by-rank/#zremrangebyrank","title":"zremRangeByRank","text":"[jvm]\\ abstract fun zremRangeByRank(key: String, start: Redis.ZRangeRankMarker, stop: Redis.ZRangeRankMarker): Long
Removes all elements in the sorted set stored at key with rank between start and stop. Both start and stop are 0 -based indexes with 0 being the element with the lowest score. These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. For example: -1 is the element with the highest score, -2 the element with the second-highest score and so forth.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zscore/","title":"zscore - Misk","text":"//misk-redis/misk.redis/Redis/zscore
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/zscore/#zscore","title":"zscore","text":"[jvm]\\ abstract fun zscore(key: String, member: String): Double?
Returns the score of member in the sorted set at key.
If member does not exist in the sorted set, or key does not exist, nil is returned.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/","title":"ScanResult - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/#scanresult","title":"ScanResult","text":"[jvm]\\ data class ScanResult(val cursor: String, val keys: List<String>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/#constructors","title":"Constructors","text":"ScanResult [jvm]constructor(cursor: String, keys: List<String>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/#properties","title":"Properties","text":"Name Summary cursor [jvm]val cursor: String keys [jvm]val keys: List<String>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/-scan-result/","title":"ScanResult - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult/ScanResult
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/-scan-result/#scanresult","title":"ScanResult","text":"[jvm]\\ constructor(cursor: String, keys: List<String>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/cursor/","title":"cursor - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult/cursor
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/cursor/#cursor","title":"cursor","text":"[jvm]\\ val cursor: String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/keys/","title":"keys - Misk","text":"//misk-redis/misk.redis/Redis/ScanResult/keys
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-scan-result/keys/#keys","title":"keys","text":"[jvm]\\ val keys: List<String>
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/","title":"ZAddOptions - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#zaddoptions","title":"ZAddOptions","text":"[jvm]\\ enum ZAddOptions : Enum<Redis.ZAddOptions>
Options for ZADD. Not all options are compatible with one another. See the ZADD command documentation for more information.
Note: misk-redis does not currently support the INCR option.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#entries","title":"Entries","text":"XX [jvm]XXOnly update elements that already exist. Don\u2019t add new elements. NX [jvm]NXOnly add new elements. Don\u2019t update already existing elements. LT [jvm]LTOnly update existing elements if the new score is less than the current score. This flag doesn\u2019t prevent adding new elements. GT [jvm]GTOnly update existing elements if the new score is greater than the current score. This flag doesn\u2019t prevent adding new elements. CH [jvm]CHModify the return value from the number of new elements added, to the total number of elements changed (CH is an abbreviation of changed). Changed elements are new elements added and elements already existing for which the score was updated. So elements specified in the command line having the same score as they had in the past are not counted. Note: normally the return value of ZADD only counts the number of new elements added."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Redis.ZAddOptions>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): Redis.ZAddOptionsReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Redis.ZAddOptions>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/entries/","title":"entries - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/entries
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Redis.ZAddOptions>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/value-of/","title":"valueOf - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/valueOf
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Redis.ZAddOptions
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/values/","title":"values - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/values
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Redis.ZAddOptions>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-c-h/","title":"CH - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/CH
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-c-h/#ch","title":"CH","text":"[jvm]\\ CH
Modify the return value from the number of new elements added, to the total number of elements changed (CH is an abbreviation of changed). Changed elements are new elements added and elements already existing for which the score was updated. So elements specified in the command line having the same score as they had in the past are not counted. Note: normally the return value of ZADD only counts the number of new elements added.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-c-h/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/","title":"Companion - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/#functions","title":"Functions","text":"Name Summary getZAddParams [jvm]fun getZAddParams(options: Array<out Redis.ZAddOptions>): ZAddParams"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/get-z-add-params/","title":"getZAddParams - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/Companion/getZAddParams
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-companion/get-z-add-params/#getzaddparams","title":"getZAddParams","text":"[jvm]\\ fun getZAddParams(options: Array<out Redis.ZAddOptions>): ZAddParams
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-g-t/","title":"GT - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/GT
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-g-t/#gt","title":"GT","text":"[jvm]\\ GT
Only update existing elements if the new score is greater than the current score. This flag doesn\u2019t prevent adding new elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-g-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-l-t/","title":"LT - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/LT
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-l-t/#lt","title":"LT","text":"[jvm]\\ LT
Only update existing elements if the new score is less than the current score. This flag doesn\u2019t prevent adding new elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-l-t/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-n-x/","title":"NX - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/NX
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-n-x/#nx","title":"NX","text":"[jvm]\\ NX
Only add new elements. Don\u2019t update already existing elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-n-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-x-x/","title":"XX - Misk","text":"//misk-redis/misk.redis/Redis/ZAddOptions/XX
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-x-x/#xx","title":"XX","text":"[jvm]\\ XX
Only update elements that already exist. Don\u2019t add new elements.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-add-options/-x-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/","title":"ZRangeIndexMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeIndexMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/#zrangeindexmarker","title":"ZRangeIndexMarker","text":"[jvm]\\ data class ZRangeIndexMarker(val intValue: Int) : Redis.ZRangeMarker
To be used when ZRangeType is ZRangeType.INDEX. The intValue should be an integer specifying the index (start or stop)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/#constructors","title":"Constructors","text":"ZRangeIndexMarker [jvm]constructor(intValue: Int)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/#properties","title":"Properties","text":"Name Summary included [jvm]val included: Boolean intValue [jvm]val intValue: Int value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/-z-range-index-marker/","title":"ZRangeIndexMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeIndexMarker/ZRangeIndexMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/-z-range-index-marker/#zrangeindexmarker","title":"ZRangeIndexMarker","text":"[jvm]\\ constructor(intValue: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/int-value/","title":"intValue - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeIndexMarker/intValue
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-index-marker/int-value/#intvalue","title":"intValue","text":"[jvm]\\ val intValue: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/","title":"ZRangeLimit - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeLimit
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/#zrangelimit","title":"ZRangeLimit","text":"[jvm]\\ data class ZRangeLimit(val offset: Int, val count: Int)
The limit argument in zrange and zrangeWithScores can be used to obtain a sub-range from the matching elements similar to SELECT LIMIT offset, count in SQL. A negative count returns all elements from the offset. Keep in mind that if is large, the sorted set needs to be traversed for elements before getting to the elements to return, which can add up to O(N) time complexity."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/#constructors","title":"Constructors","text":"ZRangeLimit [jvm]constructor(offset: Int, count: Int)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/#properties","title":"Properties","text":"Name Summary count [jvm]val count: Int offset [jvm]val offset: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/-z-range-limit/","title":"ZRangeLimit - Misk","text":"
//misk-redis/misk.redis/Redis/ZRangeLimit/ZRangeLimit
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/-z-range-limit/#zrangelimit","title":"ZRangeLimit","text":"[jvm]\\ constructor(offset: Int, count: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/count/","title":"count - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeLimit/count
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/count/#count","title":"count","text":"[jvm]\\ val count: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/offset/","title":"offset - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeLimit/offset
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-limit/offset/#offset","title":"offset","text":"[jvm]\\ val offset: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/","title":"ZRangeMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#zrangemarker","title":"ZRangeMarker","text":"abstract class ZRangeMarker(val value: Any, val included: Boolean)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#inheritors","title":"Inheritors","text":"ZRangeRankMarker ZRangeIndexMarker ZRangeScoreMarker"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#constructors","title":"Constructors","text":"ZRangeMarker [jvm]constructor(value: Any, included: Boolean)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/#properties","title":"Properties","text":"Name Summary included [jvm]val included: Boolean value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/-z-range-marker/","title":"ZRangeMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker/ZRangeMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/-z-range-marker/#zrangemarker","title":"ZRangeMarker","text":"[jvm]\\ constructor(value: Any, included: Boolean)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/included/","title":"included - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker/included
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/included/#included","title":"included","text":"[jvm]\\ val included: Boolean
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/value/","title":"value - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeMarker/value
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-marker/value/#value","title":"value","text":"[jvm]\\ val value: Any
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/","title":"ZRangeRankMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeRankMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/#zrangerankmarker","title":"ZRangeRankMarker","text":"[jvm]\\ data class ZRangeRankMarker(val longValue: Long) : Redis.ZRangeMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/#constructors","title":"Constructors","text":"ZRangeRankMarker [jvm]constructor(longValue: Long)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/#properties","title":"Properties","text":"Name Summary included [jvm]val included: Boolean longValue [jvm]val longValue: Long value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/-z-range-rank-marker/","title":"ZRangeRankMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeRankMarker/ZRangeRankMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/-z-range-rank-marker/#zrangerankmarker","title":"ZRangeRankMarker","text":"[jvm]\\ constructor(longValue: Long)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/long-value/","title":"longValue - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeRankMarker/longValue
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-rank-marker/long-value/#longvalue","title":"longValue","text":"[jvm]\\ val longValue: Long
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/","title":"ZRangeScoreMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#zrangescoremarker","title":"ZRangeScoreMarker","text":"[jvm]\\ data class ZRangeScoreMarker@JvmOverloadsconstructor(val doubleValue: Double, val isIncluded: Boolean = true) : Redis.ZRangeMarker
To be used when ZRangeType is ZRangeType.SCORE. The doubleValue should be a double specifying the score (start or stop) By default the range is included. Set isIncluded to false in order to exclude the start or stop.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#constructors","title":"Constructors","text":"ZRangeScoreMarker [jvm]@JvmOverloadsconstructor(doubleValue: Double, isIncluded: Boolean = true)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#properties","title":"Properties","text":"Name Summary doubleValue [jvm]val doubleValue: Double included [jvm]val included: Boolean isIncluded [jvm]val isIncluded: Boolean = true value [jvm]val value: Any"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/#functions","title":"Functions","text":"Name Summary toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/-z-range-score-marker/","title":"ZRangeScoreMarker - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/ZRangeScoreMarker
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/-z-range-score-marker/#zrangescoremarker","title":"ZRangeScoreMarker","text":"[jvm]\\
@JvmOverloads
constructor(doubleValue: Double, isIncluded: Boolean = true)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/double-value/","title":"doubleValue - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/doubleValue
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/double-value/#doublevalue","title":"doubleValue","text":"[jvm]\\ val doubleValue: Double
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/is-included/","title":"isIncluded - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/isIncluded
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/is-included/#isincluded","title":"isIncluded","text":"[jvm]\\ val isIncluded: Boolean = true
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/to-string/","title":"toString - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeScoreMarker/toString
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-score-marker/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/","title":"ZRangeType - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#zrangetype","title":"ZRangeType","text":"[jvm]\\ enum ZRangeType : Enum<Redis.ZRangeType>
Different types of range queries.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#entries","title":"Entries","text":"INDEX [jvm]INDEXThe and arguments represent zero-based indexes. These arguments specify an inclusive range. SCORE [jvm]SCOREreturns the range of elements from the sorted set having scores equal or between and"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Redis.ZRangeType>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): Redis.ZRangeTypeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Redis.ZRangeType>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/entries/","title":"entries - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/entries
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Redis.ZRangeType>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/value-of/","title":"valueOf - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/valueOf
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Redis.ZRangeType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/values/","title":"values - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/values
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Redis.ZRangeType>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-i-n-d-e-x/","title":"INDEX - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/INDEX
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-i-n-d-e-x/#index","title":"INDEX","text":"[jvm]\\ INDEX
The and arguments represent zero-based indexes. These arguments specify an inclusive range.
The indexes can also be negative numbers indicating offsets from the end of the sorted set, with -1 being the last element of the sorted set and so on.
Out of range indexes do not produce an error. If is greater than either the end index of the sorted set or , an empty list is returned. If is greater than the end index of the sorted set, Redis will use the last element of the sorted set.
Use ZRangeIndexMarker to specify the start and stop for this type.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-i-n-d-e-x/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-s-c-o-r-e/","title":"SCORE - Misk","text":"//misk-redis/misk.redis/Redis/ZRangeType/SCORE
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-s-c-o-r-e/#score","title":"SCORE","text":"[jvm]\\ SCORE
returns the range of elements from the sorted set having scores equal or between and
and can be -inf and +inf, denoting the negative and positive infinities, respectively. This means that you are not required to know the highest or lowest score in the sorted set to get all elements from or up to a certain score.
By default, the score intervals specified by and are closed (inclusive). It is possible to specify an open interval.
Use ZRangeScoreMarker to specify the start and stop for this type.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis/-z-range-type/-s-c-o-r-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/","title":"RedisClientMetrics - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#redisclientmetrics","title":"RedisClientMetrics","text":"[jvm]\\ @Singleton
class RedisClientMetrics@Injectconstructor(ticker: Ticker, metrics: Metrics)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#constructors","title":"Constructors","text":"RedisClientMetrics [jvm]@Injectconstructor(ticker: Ticker, metrics: Metrics)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/#functions","title":"Functions","text":"Name Summary timed [jvm]fun <T> timed(commandName: String, block: () -> T): T"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-redis-client-metrics/","title":"RedisClientMetrics - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics/RedisClientMetrics
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-redis-client-metrics/#redisclientmetrics","title":"RedisClientMetrics","text":"[jvm]\\
@Inject
constructor(ticker: Ticker, metrics: Metrics)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/timed/","title":"timed - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics/timed
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/timed/#timed","title":"timed","text":"[jvm]\\ fun <T> timed(commandName: String, block: () -> T): T
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-companion/","title":"Companion - Misk","text":"//misk-redis/misk.redis/RedisClientMetrics/Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-client-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/","title":"RedisClusterConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#redisclusterconfig","title":"RedisClusterConfig","text":"[jvm]\\ class RedisClusterConfig : LinkedHashMap<String, RedisClusterReplicationGroupConfig> , Config
Top-level configuration element for all redis clusters
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#constructors","title":"Constructors","text":"RedisClusterConfig [jvm]constructor()constructor(m: Map<String, RedisClusterReplicationGroupConfig>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#properties","title":"Properties","text":"Name Summary entries [jvm]open override val entries: MutableSet<MutableMap.MutableEntry<String, RedisClusterReplicationGroupConfig>> keys [jvm]open override val keys: MutableSet<String> size [jvm]open override val size: Int values [jvm]open override val values: MutableCollection<RedisClusterReplicationGroupConfig>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() clone [jvm]open override fun clone(): Any compute [jvm]open override fun compute(p0: String, p1: BiFunction<in String, in RedisClusterReplicationGroupConfig?, out RedisClusterReplicationGroupConfig?>): RedisClusterReplicationGroupConfig? computeIfAbsent [jvm]open override fun computeIfAbsent(p0: String, p1: Function<in String, out RedisClusterReplicationGroupConfig>): RedisClusterReplicationGroupConfig computeIfPresent [jvm]open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in RedisClusterReplicationGroupConfig, out RedisClusterReplicationGroupConfig?>): RedisClusterReplicationGroupConfig? containsKey [jvm]open override fun containsKey(key: String): Boolean containsValue [jvm]open override fun containsValue(value: RedisClusterReplicationGroupConfig): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean forEach [jvm]open override fun forEach(p0: BiConsumer<in String, in RedisClusterReplicationGroupConfig>) get [jvm]open operator override fun get(key: String): RedisClusterReplicationGroupConfig? getOrDefault [jvm]open override fun getOrDefault(key: String, defaultValue: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig hashCode [jvm]open override fun hashCode(): Int isEmpty [jvm]open override fun isEmpty(): Boolean merge [jvm]open override fun merge(p0: String, p1: RedisClusterReplicationGroupConfig, p2: BiFunction<in RedisClusterReplicationGroupConfig, in RedisClusterReplicationGroupConfig, out RedisClusterReplicationGroupConfig?>): RedisClusterReplicationGroupConfig? put [jvm]open override fun put(key: String, value: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig? putAll [jvm]open override fun putAll(from: Map<out String, RedisClusterReplicationGroupConfig>) putIfAbsent [jvm]open override fun putIfAbsent(p0: String, p1: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig? remove [jvm]open override fun remove(key: String): RedisClusterReplicationGroupConfig?open override fun remove(key: String, value: RedisClusterReplicationGroupConfig): Boolean replace [jvm]open override fun replace(p0: String, p1: RedisClusterReplicationGroupConfig): RedisClusterReplicationGroupConfig?open override fun replace(p0: String, p1: RedisClusterReplicationGroupConfig, p2: RedisClusterReplicationGroupConfig): Boolean replaceAll [jvm]open override fun replaceAll(p0: BiFunction<in String, in RedisClusterReplicationGroupConfig, out RedisClusterReplicationGroupConfig>) toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/-redis-cluster-config/","title":"RedisClusterConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterConfig/RedisClusterConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-config/-redis-cluster-config/#redisclusterconfig","title":"RedisClusterConfig","text":"[jvm]\\ constructor()
constructor(m: Map<String, RedisClusterReplicationGroupConfig>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/","title":"RedisClusterModule - Misk","text":"//misk-redis/misk.redis/RedisClusterModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/#redisclustermodule","title":"RedisClusterModule","text":"[jvm]\\ class RedisClusterModule@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModule
Configures a Redis client that interacts with a Redis cluster. This also installs a ServiceModule for RedisService.
To use this, install a RedisClusterModule and add a corresponding RedisClusterConfig to your application\u2019s config YAML.
If other services require a working client connection to Redis before they can be used, specify a dependency like:
install(ServiceModule<MyService>()\n .dependsOn(keyOf<RedisService>())\n)\nredisClusterConfig: Only one replication group config is supported; this module will use the first configuration it finds. An empty RedisReplicationGroupConfig.redis_auth_password is only permitted in fake environments. See Deployment.
This initiates a JedisCluster which automatically discovers the topology of the Redis cluster, and routes commands to the appropriate node based on the hash slot of the key.
Note: This has some limitations regarding multi-key operations that involve keys belonging to different slots. Some unsupported functions in JedisCluster were addressed in this custom wrapper (e.g. mset, mget and del) but not the atomic operations such as rpoplpush, lmove, brpoplpush etc. as it is not recommended. For more information, refer to the following links:
https://redis.io/docs/reference/cluster-spec/ https://redis.com/blog/redis-clustering-best-practices-with-keys/
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/#constructors","title":"Constructors","text":"RedisClusterModule [jvm]@JvmOverloadsconstructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/-redis-cluster-module/","title":"RedisClusterModule - Misk","text":"//misk-redis/misk.redis/RedisClusterModule/RedisClusterModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-module/-redis-cluster-module/#redisclustermodule","title":"RedisClusterModule","text":"[jvm]\\
@JvmOverloads
constructor(redisClusterConfig: RedisClusterConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/","title":"RedisClusterReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/#redisclusterreplicationgroupconfig","title":"RedisClusterReplicationGroupConfig","text":"[jvm]\\ data class RedisClusterReplicationGroupConfig@JvmOverloadsconstructor(val configuration_endpoint: RedisNodeConfig, val client_name: String? = null, val max_attempts: Int = DEFAULT_MAX_ATTEMPTS, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
Configuration element for a Redis Cluster
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/#constructors","title":"Constructors","text":"RedisClusterReplicationGroupConfig [jvm]@JvmOverloadsconstructor(configuration_endpoint: RedisNodeConfig, client_name: String? = null, max_attempts: Int = DEFAULT_MAX_ATTEMPTS, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/#properties","title":"Properties","text":"Name Summary client_name [jvm]val client_name: String? = nullAn optional parameter to identify the client application. configuration_endpoint [jvm]val configuration_endpoint: RedisNodeConfigThe endpoint of a node in the cluster that can be used to discover the rest of the cluster. max_attempts [jvm]val max_attempts: IntThe maximum number of attempts in case of failure. redis_auth_password [jvm]val redis_auth_password: StringThe password to use for the connection to the cluster. timeout_ms [jvm]val timeout_ms: IntThe connection and socket timeout in milliseconds."},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/-redis-cluster-replication-group-config/","title":"RedisClusterReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/RedisClusterReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/-redis-cluster-replication-group-config/#redisclusterreplicationgroupconfig","title":"RedisClusterReplicationGroupConfig","text":"[jvm]\\
@JvmOverloads
constructor(configuration_endpoint: RedisNodeConfig, client_name: String? = null, max_attempts: Int = DEFAULT_MAX_ATTEMPTS, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/client_name/","title":"client_name - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/client_name
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/client_name/#client_name","title":"client_name","text":"[jvm]\\ val client_name: String? = null
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/configuration_endpoint/","title":"configuration_endpoint - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/configuration_endpoint
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/configuration_endpoint/#configuration_endpoint","title":"configuration_endpoint","text":"[jvm]\\ val configuration_endpoint: RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/max_attempts/","title":"max_attempts - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/max_attempts
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/max_attempts/#max_attempts","title":"max_attempts","text":"[jvm]\\ val max_attempts: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/redis_auth_password/","title":"redis_auth_password - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/redis_auth_password
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/redis_auth_password/#redis_auth_password","title":"redis_auth_password","text":"[jvm]\\ val redis_auth_password: String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/timeout_ms/","title":"timeout_ms - Misk","text":"//misk-redis/misk.redis/RedisClusterReplicationGroupConfig/timeout_ms
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-cluster-replication-group-config/timeout_ms/#timeout_ms","title":"timeout_ms","text":"[jvm]\\ val timeout_ms: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/","title":"RedisConfig - Misk","text":"//misk-redis/misk.redis/RedisConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#redisconfig","title":"RedisConfig","text":"[jvm]\\ class RedisConfig : LinkedHashMap<String, RedisReplicationGroupConfig> , Config
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#constructors","title":"Constructors","text":"RedisConfig [jvm]constructor()constructor(m: Map<String, RedisReplicationGroupConfig>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#properties","title":"Properties","text":"Name Summary entries [jvm]open override val entries: MutableSet<MutableMap.MutableEntry<String, RedisReplicationGroupConfig>> keys [jvm]open override val keys: MutableSet<String> size [jvm]open override val size: Int values [jvm]open override val values: MutableCollection<RedisReplicationGroupConfig>"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/#functions","title":"Functions","text":"Name Summary clear [jvm]open override fun clear() clone [jvm]open override fun clone(): Any compute [jvm]open override fun compute(p0: String, p1: BiFunction<in String, in RedisReplicationGroupConfig?, out RedisReplicationGroupConfig?>): RedisReplicationGroupConfig? computeIfAbsent [jvm]open override fun computeIfAbsent(p0: String, p1: Function<in String, out RedisReplicationGroupConfig>): RedisReplicationGroupConfig computeIfPresent [jvm]open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in RedisReplicationGroupConfig, out RedisReplicationGroupConfig?>): RedisReplicationGroupConfig? containsKey [jvm]open override fun containsKey(key: String): Boolean containsValue [jvm]open override fun containsValue(value: RedisReplicationGroupConfig): Boolean equals [jvm]open operator override fun equals(other: Any?): Boolean forEach [jvm]open override fun forEach(p0: BiConsumer<in String, in RedisReplicationGroupConfig>) get [jvm]open operator override fun get(key: String): RedisReplicationGroupConfig? getOrDefault [jvm]open override fun getOrDefault(key: String, defaultValue: RedisReplicationGroupConfig): RedisReplicationGroupConfig hashCode [jvm]open override fun hashCode(): Int isEmpty [jvm]open override fun isEmpty(): Boolean merge [jvm]open override fun merge(p0: String, p1: RedisReplicationGroupConfig, p2: BiFunction<in RedisReplicationGroupConfig, in RedisReplicationGroupConfig, out RedisReplicationGroupConfig?>): RedisReplicationGroupConfig? put [jvm]open override fun put(key: String, value: RedisReplicationGroupConfig): RedisReplicationGroupConfig? putAll [jvm]open override fun putAll(from: Map<out String, RedisReplicationGroupConfig>) putIfAbsent [jvm]open override fun putIfAbsent(p0: String, p1: RedisReplicationGroupConfig): RedisReplicationGroupConfig? remove [jvm]open override fun remove(key: String): RedisReplicationGroupConfig?open override fun remove(key: String, value: RedisReplicationGroupConfig): Boolean replace [jvm]open override fun replace(p0: String, p1: RedisReplicationGroupConfig): RedisReplicationGroupConfig?open override fun replace(p0: String, p1: RedisReplicationGroupConfig, p2: RedisReplicationGroupConfig): Boolean replaceAll [jvm]open override fun replaceAll(p0: BiFunction<in String, in RedisReplicationGroupConfig, out RedisReplicationGroupConfig>) toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/-redis-config/","title":"RedisConfig - Misk","text":"//misk-redis/misk.redis/RedisConfig/RedisConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-config/-redis-config/#redisconfig","title":"RedisConfig","text":"[jvm]\\ constructor()
constructor(m: Map<String, RedisReplicationGroupConfig>)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/","title":"RedisConnectionException - Misk","text":"//misk-redis/misk.redis/RedisConnectionException
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#redisconnectionexception","title":"RedisConnectionException","text":"[jvm]\\ class RedisConnectionException(cluster: String, cause: Throwable) : RuntimeException
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#constructors","title":"Constructors","text":"RedisConnectionException [jvm]constructor(cluster: String, cause: Throwable)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/-redis-connection-exception/","title":"RedisConnectionException - Misk","text":"//misk-redis/misk.redis/RedisConnectionException/RedisConnectionException
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-connection-exception/-redis-connection-exception/#redisconnectionexception","title":"RedisConnectionException","text":"[jvm]\\ constructor(cluster: String, cause: Throwable)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/","title":"RedisModule - Misk","text":"//misk-redis/misk.redis/RedisModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/#redismodule","title":"RedisModule","text":"[jvm]\\ class RedisModule@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true) : KAbstractModule
Configures a Redis client with metrics, this also installs a ServiceModule for RedisService. If other services require a working client connection to Redis before they can be used, specify a dependency like:
install(ServiceModule<MyService>()\n .dependsOn(keyOf<RedisService>())\n)\nYou must pass in configuration for your Redis client.
redisConfig: Only one replication group config is supported; this module will use the first configuration it finds. An empty RedisReplicationGroupConfig.redis_auth_password is only permitted in fake environments. See Deployment.
connectionPoolConfig: Misk-redis is backed by a JedisPooled, you may not want to use the ConnectionPoolConfig defaults! Be sure to understand them!
See: https://github.com/xetorthio/jedis/wiki/Getting-started#using-jedis-in-a-multithreaded-environment
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/#constructors","title":"Constructors","text":"RedisModule [jvm]@JvmOverloadsconstructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/-redis-module/","title":"RedisModule - Misk","text":"//misk-redis/misk.redis/RedisModule/RedisModule
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-module/-redis-module/#redismodule","title":"RedisModule","text":"[jvm]\\
@JvmOverloads
constructor(redisConfig: RedisConfig, connectionPoolConfig: ConnectionPoolConfig, useSsl: Boolean = true)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/","title":"RedisNodeConfig - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/#redisnodeconfig","title":"RedisNodeConfig","text":"[jvm]\\ data class RedisNodeConfig(val hostname: String?, val port: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/#constructors","title":"Constructors","text":"RedisNodeConfig [jvm]constructor(hostname: String?, port: Int)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/#properties","title":"Properties","text":"Name Summary hostname [jvm]val hostname: String? port [jvm]val port: Int"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/-redis-node-config/","title":"RedisNodeConfig - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig/RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/-redis-node-config/#redisnodeconfig","title":"RedisNodeConfig","text":"[jvm]\\ constructor(hostname: String?, port: Int)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/hostname/","title":"hostname - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig/hostname
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/hostname/#hostname","title":"hostname","text":"[jvm]\\ val hostname: String?
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/port/","title":"port - Misk","text":"//misk-redis/misk.redis/RedisNodeConfig/port
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-node-config/port/#port","title":"port","text":"[jvm]\\ val port: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/","title":"RedisReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/#redisreplicationgroupconfig","title":"RedisReplicationGroupConfig","text":"[jvm]\\ data class RedisReplicationGroupConfig@JvmOverloadsconstructor(val writer_endpoint: RedisNodeConfig, val reader_endpoint: RedisNodeConfig, val redis_auth_password: String, val timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/#constructors","title":"Constructors","text":"RedisReplicationGroupConfig [jvm]@JvmOverloadsconstructor(writer_endpoint: RedisNodeConfig, reader_endpoint: RedisNodeConfig, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/#properties","title":"Properties","text":"Name Summary reader_endpoint [jvm]val reader_endpoint: RedisNodeConfig redis_auth_password [jvm]val redis_auth_password: String timeout_ms [jvm]val timeout_ms: Int writer_endpoint [jvm]val writer_endpoint: RedisNodeConfig"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/-redis-replication-group-config/","title":"RedisReplicationGroupConfig - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/RedisReplicationGroupConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/-redis-replication-group-config/#redisreplicationgroupconfig","title":"RedisReplicationGroupConfig","text":"[jvm]\\
@JvmOverloads
constructor(writer_endpoint: RedisNodeConfig, reader_endpoint: RedisNodeConfig, redis_auth_password: String, timeout_ms: Int = Protocol.DEFAULT_TIMEOUT)
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/reader_endpoint/","title":"reader_endpoint - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/reader_endpoint
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/reader_endpoint/#reader_endpoint","title":"reader_endpoint","text":"[jvm]\\ val reader_endpoint: RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/redis_auth_password/","title":"redis_auth_password - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/redis_auth_password
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/redis_auth_password/#redis_auth_password","title":"redis_auth_password","text":"[jvm]\\ val redis_auth_password: String
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/timeout_ms/","title":"timeout_ms - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/timeout_ms
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/timeout_ms/#timeout_ms","title":"timeout_ms","text":"[jvm]\\ val timeout_ms: Int
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/writer_endpoint/","title":"writer_endpoint - Misk","text":"//misk-redis/misk.redis/RedisReplicationGroupConfig/writer_endpoint
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-replication-group-config/writer_endpoint/#writer_endpoint","title":"writer_endpoint","text":"[jvm]\\ val writer_endpoint: RedisNodeConfig
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-service/","title":"RedisService - Misk","text":"//misk-redis/misk.redis/RedisService
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-service/#redisservice","title":"RedisService","text":"[jvm]\\ @Singleton
class RedisService : AbstractIdleService
Controls the connection lifecycle for Redis.
"},{"location":"0.x/misk-redis/misk-redis/misk.redis/-redis-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-schema-migrator-gradle-plugin/","title":"misk-schema-migrator-gradle-plugin - Misk","text":"//misk-schema-migrator-gradle-plugin
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/#misk-schema-migrator-gradle-plugin","title":"misk-schema-migrator-gradle-plugin","text":""},{"location":"0.x/misk-schema-migrator-gradle-plugin/#packages","title":"Packages","text":"Name misk.gradle.schemamigrator"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/","title":"Package-level declarations - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/#types","title":"Types","text":"Name Summary SchemaMigratorDatabase [jvm]@Qualifier@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])annotation class SchemaMigratorDatabase SchemaMigratorExtension [jvm]abstract class SchemaMigratorExtension@Injectconstructor(objects: ObjectFactory) SchemaMigratorModule [jvm]class SchemaMigratorModule(database: String, dbType: String, username: String, password: String, schemaDir: File) : KAbstractModule SchemaMigratorPlugin [jvm]class SchemaMigratorPlugin : Plugin<Project> SchemaMigratorTask [jvm]abstract class SchemaMigratorTask : DefaultTask"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-database/","title":"SchemaMigratorDatabase - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorDatabase
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-database/#schemamigratordatabase","title":"SchemaMigratorDatabase","text":"[jvm]\\ @Qualifier
@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])
annotation class SchemaMigratorDatabase
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/","title":"SchemaMigratorExtension - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/#schemamigratorextension","title":"SchemaMigratorExtension","text":"[jvm]\\ abstract class SchemaMigratorExtension@Injectconstructor(objects: ObjectFactory)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/#constructors","title":"Constructors","text":"SchemaMigratorExtension [jvm]@Injectconstructor(objects: ObjectFactory)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/#properties","title":"Properties","text":"Name Summary database [jvm]@get:Inputabstract val database: Property<String> databaseType [jvm]@get:Inputval databaseType: Property<String> migrationsDir [jvm]@get:InputDirectoryabstract val migrationsDir: DirectoryProperty password [jvm]@get:Inputabstract val password: Property<String> username [jvm]@get:Inputabstract val username: Property<String>"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/-schema-migrator-extension/","title":"SchemaMigratorExtension - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/SchemaMigratorExtension
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/-schema-migrator-extension/#schemamigratorextension","title":"SchemaMigratorExtension","text":"[jvm]\\
@Inject
constructor(objects: ObjectFactory)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database-type/","title":"databaseType - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/databaseType
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database-type/#databasetype","title":"databaseType","text":"[jvm]\\
@get:Input
val databaseType: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database/","title":"database - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/database
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/database/#database","title":"database","text":"[jvm]\\
@get:Input
abstract val database: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/migrations-dir/","title":"migrationsDir - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/migrationsDir
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/migrations-dir/#migrationsdir","title":"migrationsDir","text":"[jvm]\\
@get:InputDirectory
abstract val migrationsDir: DirectoryProperty
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/password/","title":"password - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/password
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/password/#password","title":"password","text":"[jvm]\\
@get:Input
abstract val password: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/username/","title":"username - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorExtension/username
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-extension/username/#username","title":"username","text":"[jvm]\\
@get:Input
abstract val username: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/","title":"SchemaMigratorModule - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorModule
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/#schemamigratormodule","title":"SchemaMigratorModule","text":"[jvm]\\ class SchemaMigratorModule(database: String, dbType: String, username: String, password: String, schemaDir: File) : KAbstractModule
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/#constructors","title":"Constructors","text":"SchemaMigratorModule [jvm]constructor(database: String, dbType: String, username: String, password: String, schemaDir: File)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/-schema-migrator-module/","title":"SchemaMigratorModule - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorModule/SchemaMigratorModule
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-module/-schema-migrator-module/#schemamigratormodule","title":"SchemaMigratorModule","text":"[jvm]\\ constructor(database: String, dbType: String, username: String, password: String, schemaDir: File)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/","title":"SchemaMigratorPlugin - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorPlugin
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/#schemamigratorplugin","title":"SchemaMigratorPlugin","text":"[jvm]\\ class SchemaMigratorPlugin : Plugin<Project>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/#constructors","title":"Constructors","text":"SchemaMigratorPlugin [jvm]constructor()"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/#functions","title":"Functions","text":"Name Summary apply [jvm]open override fun apply(project: Project)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/-schema-migrator-plugin/","title":"SchemaMigratorPlugin - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorPlugin/SchemaMigratorPlugin
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/-schema-migrator-plugin/#schemamigratorplugin","title":"SchemaMigratorPlugin","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/apply/","title":"apply - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorPlugin/apply
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-plugin/apply/#apply","title":"apply","text":"[jvm]\\ open override fun apply(project: Project)
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/","title":"SchemaMigratorTask - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#schemamigratortask","title":"SchemaMigratorTask","text":"[jvm]\\ abstract class SchemaMigratorTask : DefaultTask
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#constructors","title":"Constructors","text":"SchemaMigratorTask [jvm]constructor()"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#properties","title":"Properties","text":"Name Summary database [jvm]@get:Inputabstract val database: Property<String> databaseType [jvm]@get:Inputabstract val databaseType: Property<String> enabled [jvm]@get:Internalvar enabled: Boolean hasCustomActions [jvm]val hasCustomActions: Boolean impliesSubProjects [jvm]var impliesSubProjects: Boolean migrationsDir [jvm]@get:PathSensitive(value = PathSensitivity.RELATIVE)@get:InputDirectoryabstract val migrationsDir: DirectoryProperty password [jvm]@get:Inputabstract val password: Property<String> state [jvm]val state: TaskStateInternal timeout [jvm]val timeout: Property<Duration> username [jvm]@get:Inputabstract val username: Property<String>"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/#functions","title":"Functions","text":"Name Summary acceptServiceReferences [jvm]open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>) appendParallelSafeAction [jvm]open override fun appendParallelSafeAction(action: Action<in Task>) compareTo [jvm]open operator override fun compareTo(other: Task): Int configure [jvm]open override fun configure(closure: Closure<Any>): Task dependsOn [jvm]open override fun dependsOn(vararg paths: Any): Task doFirst [jvm]open override fun doFirst(action: Closure<Any>): Taskopen override fun doFirst(action: Action<in Task>): Taskopen override fun doFirst(actionName: String, action: Action<in Task>): Task doLast [jvm]open override fun doLast(action: Closure<Any>): Taskopen override fun doLast(action: Action<in Task>): Taskopen override fun doLast(actionName: String, action: Action<in Task>): Task doNotTrackState [jvm]open override fun doNotTrackState(reasonNotToTrackState: String) finalizedBy [jvm]open override fun finalizedBy(vararg paths: Any): Task getActions [jvm]open override fun getActions(): MutableList<Action<in Task>> getAnt [jvm]open override fun getAnt(): AntBuilder getAsDynamicObject [jvm]@Internalopen override fun getAsDynamicObject(): DynamicObject getDependsOn [jvm]open override fun getDependsOn(): MutableSet<Any> getDescription [jvm]open override fun getDescription(): String? getDestroyables [jvm]open override fun getDestroyables(): TaskDestroyables getDidWork [jvm]open override fun getDidWork(): Boolean getExtensions [jvm]open override fun getExtensions(): ExtensionContainer getFinalizedBy [jvm]open override fun getFinalizedBy(): TaskDependency getGroup [jvm]open override fun getGroup(): String? getIdentityPath [jvm]open override fun getIdentityPath(): Path getInputs [jvm]open override fun getInputs(): TaskInputsInternal getLifecycleDependencies [jvm]@Internalopen override fun getLifecycleDependencies(): TaskDependencyInternal getLocalState [jvm]open override fun getLocalState(): TaskLocalState getLogger [jvm]open override fun getLogger(): Logger getLogging [jvm]open override fun getLogging(): LoggingManager getMustRunAfter [jvm]open override fun getMustRunAfter(): TaskDependency getName [jvm]open override fun getName(): String getOnlyIf [jvm]open override fun getOnlyIf(): Spec<in TaskInternal> getOutputs [jvm]open override fun getOutputs(): TaskOutputsInternal getPath [jvm]open override fun getPath(): String getProject [jvm]open override fun getProject(): Project getReasonNotToTrackState [jvm]open override fun getReasonNotToTrackState(): Optional<String> getReasonTaskIsIncompatibleWithConfigurationCache [jvm]open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String> getRequiredServices [jvm]open override fun getRequiredServices(): TaskRequiredServices getSharedResources [jvm]open override fun getSharedResources(): MutableList<ResourceLock> getShouldRunAfter [jvm]open override fun getShouldRunAfter(): TaskDependency getStandardOutputCapture [jvm]open override fun getStandardOutputCapture(): StandardOutputCapture getTaskActions [jvm]open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction> getTaskDependencies [jvm]open override fun getTaskDependencies(): TaskDependencyInternal getTaskIdentity [jvm]open override fun getTaskIdentity(): TaskIdentity<*> getTemporaryDir [jvm]open override fun getTemporaryDir(): File getTemporaryDirFactory [jvm]open override fun getTemporaryDirFactory(): Factory<File> hasProperty [jvm]open override fun hasProperty(propertyName: String): Boolean hasTaskActions [jvm]open override fun hasTaskActions(): Boolean isCompatibleWithConfigurationCache [jvm]open override fun isCompatibleWithConfigurationCache(): Boolean migrateSchemas [jvm]fun migrateSchemas() mustRunAfter [jvm]open override fun mustRunAfter(vararg paths: Any): Task notCompatibleWithConfigurationCache [jvm]open override fun notCompatibleWithConfigurationCache(reason: String) onlyIf [jvm]open override fun onlyIf(onlyIfClosure: Closure<Any>)open override fun onlyIf(spec: Spec<in Task>)open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>) prependParallelSafeAction [jvm]open override fun prependParallelSafeAction(action: Action<in Task>) property [jvm]open override fun property(propertyName: String): Any? setActions [jvm]open override fun setActions(replacements: MutableList<Action<in Task>>) setDependsOn [jvm]open override fun setDependsOn(dependsOn: MutableIterable<*>) setDescription [jvm]open override fun setDescription(description: String?) setDidWork [jvm]open override fun setDidWork(didWork: Boolean) setFinalizedBy [jvm]open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>) setGroup [jvm]open override fun setGroup(group: String?) setMustRunAfter [jvm]open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>) setOnlyIf [jvm]open override fun setOnlyIf(onlyIfClosure: Closure<Any>)open override fun setOnlyIf(spec: Spec<in Task>)open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>) setProperty [jvm]open override fun setProperty(name: String, value: Any) setShouldRunAfter [jvm]open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>) shouldRunAfter [jvm]open override fun shouldRunAfter(vararg paths: Any): TaskDependency usesService [jvm]open override fun usesService(service: Provider<out BuildService<*>>)"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/-schema-migrator-task/","title":"SchemaMigratorTask - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/SchemaMigratorTask
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/-schema-migrator-task/#schemamigratortask","title":"SchemaMigratorTask","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database-type/","title":"databaseType - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/databaseType
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database-type/#databasetype","title":"databaseType","text":"[jvm]\\
@get:Input
abstract val databaseType: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database/","title":"database - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/database
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/database/#database","title":"database","text":"[jvm]\\
@get:Input
abstract val database: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrate-schemas/","title":"migrateSchemas - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/migrateSchemas
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrate-schemas/#migrateschemas","title":"migrateSchemas","text":"[jvm]\\ fun migrateSchemas()
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrations-dir/","title":"migrationsDir - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/migrationsDir
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/migrations-dir/#migrationsdir","title":"migrationsDir","text":"[jvm]\\
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:InputDirectory
abstract val migrationsDir: DirectoryProperty
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/password/","title":"password - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/password
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/password/#password","title":"password","text":"[jvm]\\
@get:Input
abstract val password: Property<String>
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/username/","title":"username - Misk","text":"//misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/SchemaMigratorTask/username
"},{"location":"0.x/misk-schema-migrator-gradle-plugin/misk-schema-migrator-gradle-plugin/misk.gradle.schemamigrator/-schema-migrator-task/username/#username","title":"username","text":"[jvm]\\
@get:Input
abstract val username: Property<String>
"},{"location":"0.x/misk-service/","title":"misk-service - Misk","text":"//misk-service
"},{"location":"0.x/misk-service/#misk-service","title":"misk-service","text":""},{"location":"0.x/misk-service/#packages","title":"Packages","text":"Name misk"},{"location":"0.x/misk-service/misk-service/misk/","title":"Package-level declarations - Misk","text":"//misk-service/misk
"},{"location":"0.x/misk-service/misk-service/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-service/misk-service/misk/#types","title":"Types","text":"Name Summary DelegatingService [jvm]interface DelegatingService : ServiceInterface to retrieve the underlying Service of a wrapper Service ReadyService [jvm]@Singletonclass ReadyService@Injectconstructor : AbstractIdleServiceThis is a symbolic service that\u2019s useful to define the relationship, generally, between services which process traffic (Jetty, SQS, Kinesis, Cron, Tasks, etc.) and services which are required to do work (Database, Redis, GCP, Feature Flags). ServiceManagerConfig [jvm]data class ServiceManagerConfig@JvmOverloadsconstructor(val debug_service_graph: Boolean = false) : Config ServiceManagerModule [jvm]class ServiceManagerModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule ServiceModule [jvm]class ServiceModule(val key: Key<out Service>, val dependsOn: List<Key<out Service>> = listOf(), val enhancedBy: List<Key<out Service>> = listOf()) : KAbstractModuleServices in Misk can depend on other services."},{"location":"0.x/misk-service/misk-service/misk/#functions","title":"Functions","text":"Name Summary ServiceModule [jvm]inline fun <T : Service> ServiceModule(qualifier: KClass<out Annotation>? = null): ServiceModuleReturns a ServiceModule and hooks up service dependencies and enhancements."},{"location":"0.x/misk-service/misk-service/misk/-service-module/","title":"ServiceModule - Misk","text":"//misk-service/misk/ServiceModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#servicemodule","title":"ServiceModule","text":"[jvm]\\ inline fun <T : Service> ServiceModule(qualifier: KClass<out Annotation>? = null): ServiceModule
Returns a ServiceModule and hooks up service dependencies and enhancements.
Here\u2019s how:
Guice.createInjector(object : KAbstractModule() {\n override fun configure() {\n install(ServiceModule<MyService>()\n .dependsOn<MyServiceDependency>())\n install(ServiceModule<MyServiceDependency>())\n }\n}\nDependencies and services may be optionally annotated:
Guice.createInjector(object : KAbstractModule() {\n override fun configure() {\n install(ServiceModule<MyService>(MyAnnotation::class)\n .dependsOn<MyServiceDependency>(AnotherAnnotation::class))\n install(ServiceModule<MyServiceDependency>(AnotherAnnotation::class))\n }\n}\n//misk-service/misk/DelegatingService
"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/#delegatingservice","title":"DelegatingService","text":"[jvm]\\ interface DelegatingService : Service
Interface to retrieve the underlying Service of a wrapper Service
"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/#properties","title":"Properties","text":"Name Summary service [jvm]abstract val service: Service"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/service/","title":"service - Misk","text":"//misk-service/misk/DelegatingService/service
"},{"location":"0.x/misk-service/misk-service/misk/-delegating-service/service/#service","title":"service","text":"[jvm]\\ abstract val service: Service
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/","title":"ReadyService - Misk","text":"//misk-service/misk/ReadyService
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/#readyservice","title":"ReadyService","text":"[jvm]\\ @Singleton
class ReadyService@Injectconstructor : AbstractIdleService
This is a symbolic service that\u2019s useful to define the relationship, generally, between services which process traffic (Jetty, SQS, Kinesis, Cron, Tasks, etc.) and services which are required to do work (Database, Redis, GCP, Feature Flags).
By having the former depend on ReadyService and the latter enhanced by ReadyService we can force, for example, JettyService to stop before our feature flag service without having to intertwine our dependency graph.
Example
install(\n ServiceModule<TransacterService>(qualifier)\n .enhancedBy<SchemaMigratorService>(qualifier)\n // ReadyService won't run until TransacterService is complete\n .enhancedBy<ReadyService>()\n .dependsOn<DataSourceService>(qualifier)\n)\n//misk-service/misk/ReadyService/ReadyService
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/-ready-service/#readyservice","title":"ReadyService","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/-companion/","title":"Companion - Misk","text":"//misk-service/misk/ReadyService/Companion
"},{"location":"0.x/misk-service/misk-service/misk/-ready-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/","title":"ServiceManagerConfig - Misk","text":"//misk-service/misk/ServiceManagerConfig
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/#servicemanagerconfig","title":"ServiceManagerConfig","text":"[jvm]\\ data class ServiceManagerConfig@JvmOverloadsconstructor(val debug_service_graph: Boolean = false) : Config
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/#constructors","title":"Constructors","text":"ServiceManagerConfig [jvm]@JvmOverloadsconstructor(debug_service_graph: Boolean = false)"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/#properties","title":"Properties","text":"Name Summary debug_service_graph [jvm]val debug_service_graph: Boolean = falseIf true, writes the full graph of ServiceModule services and their dependencies to info-level logs."},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/-service-manager-config/","title":"ServiceManagerConfig - Misk","text":"//misk-service/misk/ServiceManagerConfig/ServiceManagerConfig
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/-service-manager-config/#servicemanagerconfig","title":"ServiceManagerConfig","text":"[jvm]\\
@JvmOverloads
constructor(debug_service_graph: Boolean = false)
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/debug_service_graph/","title":"debug_service_graph - Misk","text":"//misk-service/misk/ServiceManagerConfig/debug_service_graph
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-config/debug_service_graph/#debug_service_graph","title":"debug_service_graph","text":"[jvm]\\ val debug_service_graph: Boolean = false
If true, writes the full graph of ServiceModule services and their dependencies to info-level logs.
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/","title":"ServiceManagerModule - Misk","text":"//misk-service/misk/ServiceManagerModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#servicemanagermodule","title":"ServiceManagerModule","text":"[jvm]\\ class ServiceManagerModule@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig()) : KAbstractModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#constructors","title":"Constructors","text":"ServiceManagerModule [jvm]@JvmOverloadsconstructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-service-manager-module/","title":"ServiceManagerModule - Misk","text":"//misk-service/misk/ServiceManagerModule/ServiceManagerModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-service-manager-module/#servicemanagermodule","title":"ServiceManagerModule","text":"[jvm]\\
@JvmOverloads
constructor(serviceManagerConfig: ServiceManagerConfig = ServiceManagerConfig())
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-companion/","title":"Companion - Misk","text":"//misk-service/misk/ServiceManagerModule/Companion
"},{"location":"0.x/misk-service/misk-service/misk/-service-manager-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/","title":"ServiceModule - Misk","text":"//misk-service/misk/ServiceModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#servicemodule","title":"ServiceModule","text":"[jvm]\\ class ServiceModule(val key: Key<out Service>, val dependsOn: List<Key<out Service>> = listOf(), val enhancedBy: List<Key<out Service>> = listOf()) : KAbstractModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#misk-services","title":"Misk Services","text":"Services in Misk can depend on other services.
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#dependencies","title":"Dependencies","text":"Suppose we have a DatabaseService and a MovieService, with the MovieService depending on the DatabaseService.
DatabaseService\n depended on by MovieService\nWhen you install a service via this module, start-up and shut-down of its dependencies are handled automatically, so that a service can only run when the services it depends on are running. In the example above, the MovieService doesn\u2019t enter the STARTING state until the DatabaseService has entered the RUNNING state. Conversely, the MovieService must enter the TERMINATED state before the DatabaseService enters the STOPPING state.
Dependencies can have their own dependencies, so there\u2019s an entire graph to manage of what starts and stops when.
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/#enhancements","title":"Enhancements","text":"Some services exist to enhance the behavior of another service.
For example, a DatabaseService may manage a generic connection to a MySQL database, and the SchemaMigrationService may create tables specific to the application.
We treat such enhancements as implementation details of the enhanced service: they depend on the service, but downstream dependencies like the MovieService don\u2019t need to know that they exist.
DatabaseService\n enhanced by SchemaMigrationService\n depended on by MovieService\nIn the above service graph we start the DatabaseService first, the SchemaMigrationService second, and finally the MovieService. The MovieService doesn\u2019t need to express a dependency on the SchemaMigrationService, that happens automatically for enhancements.
Instead of using the regular service multi-bindings you might be used to, in the configure block of a Guice KAbstractModule, you would set up the above relationship as follows:
override fun configure() {\n install(ServiceModule<SchemaMigrationService())\n install(ServiceModule<DatabaseService>()\n .enhancedBy<SchemaMigrationService>())\n install(ServiceModule<MoviesService>()\n .dependsOn<DatabaseService>())\n}\nBindings are hooked up for a ServiceManager provider, which decorates the service with its dependencies and enhancements to defer its start up and shut down until its dependent services are ready.
This service will stall in the STARTING state until all upstream services are RUNNING. Symmetrically it stalls in the STOPPING state until all dependent services are TERMINATED.
//misk-service/misk/ServiceModule/ServiceModule
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/-service-module/#servicemodule","title":"ServiceModule","text":"[jvm]\\ constructor(key: Key<out Service>, dependsOn: List<Key<out Service>> = listOf(), enhancedBy: List<Key<out Service>> = listOf())
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/depends-on/","title":"dependsOn - Misk","text":"//misk-service/misk/ServiceModule/dependsOn
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/depends-on/#dependson","title":"dependsOn","text":"[jvm]\\ fun dependsOn(upstream: Key<out Service>): ServiceModule
@JvmOverloads
inline fun <T : Service> dependsOn(qualifier: KClass<out Annotation>? = null): ServiceModule
val dependsOn: List<Key<out Service>>
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/enhanced-by/","title":"enhancedBy - Misk","text":"//misk-service/misk/ServiceModule/enhancedBy
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/enhanced-by/#enhancedby","title":"enhancedBy","text":"[jvm]\\ fun enhancedBy(enhancement: Key<out Service>): ServiceModule
@JvmOverloads
inline fun <T : Service> enhancedBy(qualifier: KClass<out Annotation>? = null): ServiceModule
val enhancedBy: List<Key<out Service>>
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/key/","title":"key - Misk","text":"//misk-service/misk/ServiceModule/key
"},{"location":"0.x/misk-service/misk-service/misk/-service-module/key/#key","title":"key","text":"[jvm]\\ val key: Key<out Service>
"},{"location":"0.x/misk-slack/","title":"misk-slack - Misk","text":"//misk-slack
"},{"location":"0.x/misk-slack/#misk-slack","title":"misk-slack","text":""},{"location":"0.x/misk-slack/#packages","title":"Packages","text":"Name misk.slack misk.slack.webapi misk.slack.webapi.helpers misk.slack.webapi.interceptors misk.slack.webapi.slashcommands"},{"location":"0.x/misk-slack/misk-slack/misk.slack/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack/#types","title":"Types","text":"Name Summary RealSlackClient [jvm]class RealSlackClient@Injectconstructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig) : SlackClient SlackClient [jvm]open class SlackClient@InjectconstructorDummy client that does nothing if SlackModule is not installed . SlackConfig [jvm]data class SlackConfig@JvmOverloadsconstructor(val baseUrl: String = \"https://hooks.slack.com/", val webhook_path: Secret<String>, val default_channel: String?) SlackModule [jvm]class SlackModule(config: SlackConfig) : KAbstractModuleInstalls the Slack webhook client. This should be installed once per service and enables imported libraries to post to Slack using the service level config. SlackWebhookApi [jvm]interface SlackWebhookApi SlackWebhookRequest [jvm]@JsonClass(generateAdapter = true)data class SlackWebhookRequest(val channel: String, val username: String, val text: String, val icon_emoji: String) SlackWebhookResponse [jvm]@JsonClass(generateAdapter = true)enum SlackWebhookResponse : Enum<SlackWebhookResponse>"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\ class RealSlackClient@Injectconstructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig) : SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#constructors","title":"Constructors","text":"RealSlackClient [jvm]@Injectconstructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/#functions","title":"Functions","text":"Name Summary postMessage [jvm]open override fun postMessage(username: String, iconEmoji: String, message: String, channel: String?): SlackWebhookResponse?Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. Does not throw on IO exceptions."},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack/RealSlackClient/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\
@Inject
constructor(slackWebHookApi: SlackWebhookApi, config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack/RealSlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\ open override fun postMessage(username: String, iconEmoji: String, message: String, channel: String?): SlackWebhookResponse?
Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. Does not throw on IO exceptions.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/","title":"Companion - Misk","text":"//misk-slack/misk.slack/RealSlackClient/Companion
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/logger/","title":"logger - Misk","text":"//misk-slack/misk.slack/RealSlackClient/Companion/logger
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-real-slack-client/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/","title":"SlackClient - Misk","text":"//misk-slack/misk.slack/SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#slackclient","title":"SlackClient","text":"open class SlackClient@Injectconstructor
Dummy client that does nothing if SlackModule is not installed .
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#inheritors","title":"Inheritors","text":"RealSlackClient"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#constructors","title":"Constructors","text":"SlackClient [jvm]@Injectconstructor()"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/#functions","title":"Functions","text":"Name Summary postMessage [jvm]@JvmOverloadsopen fun postMessage(username: String, iconEmoji: String, message: String, channel: String? = null): SlackWebhookResponse?Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. If the service has not configured a slack module, this method is a no-op. Does not throw on IO exceptions."},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/-slack-client/","title":"SlackClient - Misk","text":"//misk-slack/misk.slack/SlackClient/SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/-slack-client/#slackclient","title":"SlackClient","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack/SlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\
@JvmOverloads
open fun postMessage(username: String, iconEmoji: String, message: String, channel: String? = null): SlackWebhookResponse?
Post a message as the specified bot username and icon emoji in the channel. If no channel is provided, the default channel configured by the service is used. If the service has not configured a slack module, this method is a no-op. Does not throw on IO exceptions.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\ data class SlackConfig@JvmOverloadsconstructor(val baseUrl: String = \"https://hooks.slack.com/", val webhook_path: Secret<String>, val default_channel: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/#constructors","title":"Constructors","text":"SlackConfig [jvm]@JvmOverloadsconstructor(baseUrl: String = \"https://hooks.slack.com/", webhook_path: Secret<String>, default_channel: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/#properties","title":"Properties","text":"Name Summary baseUrl [jvm]val baseUrl: String default_channel [jvm]val default_channel: String?The channel to post to if the caller doesn\u2019t specify one. A service that always posts to one channel should specify this, but a service that operates on other services can instead specify a channel for each message. webhook_path [jvm]val webhook_path: Secret<String>The full webhook path, i.e. /services/\u2026"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack/SlackConfig/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\
@JvmOverloads
constructor(baseUrl: String = \"https://hooks.slack.com/", webhook_path: Secret<String>, default_channel: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/base-url/","title":"baseUrl - Misk","text":"//misk-slack/misk.slack/SlackConfig/baseUrl
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/base-url/#baseurl","title":"baseUrl","text":"[jvm]\\ val baseUrl: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/default_channel/","title":"default_channel - Misk","text":"//misk-slack/misk.slack/SlackConfig/default_channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/default_channel/#default_channel","title":"default_channel","text":"[jvm]\\ val default_channel: String?
The channel to post to if the caller doesn\u2019t specify one. A service that always posts to one channel should specify this, but a service that operates on other services can instead specify a channel for each message.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/webhook_path/","title":"webhook_path - Misk","text":"//misk-slack/misk.slack/SlackConfig/webhook_path
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-config/webhook_path/#webhook_path","title":"webhook_path","text":"[jvm]\\ val webhook_path: Secret<String>
The full webhook path, i.e. /services/\u2026
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/","title":"SlackModule - Misk","text":"//misk-slack/misk.slack/SlackModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/#slackmodule","title":"SlackModule","text":"[jvm]\\ class SlackModule(config: SlackConfig) : KAbstractModule
Installs the Slack webhook client. This should be installed once per service and enables imported libraries to post to Slack using the service level config.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/#constructors","title":"Constructors","text":"SlackModule [jvm]constructor(config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideMoshi [jvm]@Provides@Singleton@Named(value = \"misk-slack\")fun provideMoshi(): Moshi provideSlackWebhookApi [jvm]@Provides@Singletonfun provideSlackWebhookApi(httpClientFactory: HttpClientFactory, @Named(value = \"misk-slack\")moshi: Moshi): SlackWebhookApi"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/-slack-module/","title":"SlackModule - Misk","text":"//misk-slack/misk.slack/SlackModule/SlackModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/-slack-module/#slackmodule","title":"SlackModule","text":"[jvm]\\ constructor(config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-moshi/","title":"provideMoshi - Misk","text":"//misk-slack/misk.slack/SlackModule/provideMoshi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-moshi/#providemoshi","title":"provideMoshi","text":"[jvm]\\
@Provides
@Singleton
@Named(value = \"misk-slack\")
fun provideMoshi(): Moshi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-slack-webhook-api/","title":"provideSlackWebhookApi - Misk","text":"//misk-slack/misk.slack/SlackModule/provideSlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-module/provide-slack-webhook-api/#provideslackwebhookapi","title":"provideSlackWebhookApi","text":"[jvm]\\
@Provides
@Singleton
fun provideSlackWebhookApi(httpClientFactory: HttpClientFactory, @Named(value = \"misk-slack\")moshi: Moshi): SlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/","title":"SlackWebhookApi - Misk","text":"//misk-slack/misk.slack/SlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/#slackwebhookapi","title":"SlackWebhookApi","text":"[jvm]\\ interface SlackWebhookApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/#functions","title":"Functions","text":"Name Summary post [jvm]@POSTabstract fun post(@Urlurl: String, @Bodyrequest: SlackWebhookRequest): Call<Void>"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/post/","title":"post - Misk","text":"//misk-slack/misk.slack/SlackWebhookApi/post
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-api/post/#post","title":"post","text":"[jvm]\\
@POST
abstract fun post(@Urlurl: String, @Bodyrequest: SlackWebhookRequest): Call<Void>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/","title":"SlackWebhookRequest - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/#slackwebhookrequest","title":"SlackWebhookRequest","text":"[jvm]\\ @JsonClass(generateAdapter = true)
data class SlackWebhookRequest(val channel: String, val username: String, val text: String, val icon_emoji: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/#constructors","title":"Constructors","text":"SlackWebhookRequest [jvm]constructor(channel: String, username: String, text: String, icon_emoji: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/#properties","title":"Properties","text":"Name Summary channel [jvm]val channel: String icon_emoji [jvm]val icon_emoji: String text [jvm]val text: String username [jvm]val username: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/-slack-webhook-request/","title":"SlackWebhookRequest - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/SlackWebhookRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/-slack-webhook-request/#slackwebhookrequest","title":"SlackWebhookRequest","text":"[jvm]\\ constructor(channel: String, username: String, text: String, icon_emoji: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/channel/#channel","title":"channel","text":"[jvm]\\ val channel: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/icon_emoji/","title":"icon_emoji - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/icon_emoji
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/icon_emoji/#icon_emoji","title":"icon_emoji","text":"[jvm]\\ val icon_emoji: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/text/","title":"text - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/username/","title":"username - Misk","text":"//misk-slack/misk.slack/SlackWebhookRequest/username
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-request/username/#username","title":"username","text":"[jvm]\\ val username: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/","title":"SlackWebhookResponse - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#slackwebhookresponse","title":"SlackWebhookResponse","text":"[jvm]\\ @JsonClass(generateAdapter = true)
enum SlackWebhookResponse : Enum<SlackWebhookResponse>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#entries","title":"Entries","text":"ok [jvm]ok invalid_payload [jvm]invalid_payload user_not_found [jvm]user_not_found channel_not_found [jvm]channel_not_found channel_is_archived [jvm]channel_is_archived action_prohibited [jvm]action_prohibited missing_text_or_fallback_or_attachments [jvm]missing_text_or_fallback_or_attachments"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<SlackWebhookResponse>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): SlackWebhookResponseReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<SlackWebhookResponse>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/entries/","title":"entries - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/entries
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<SlackWebhookResponse>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/value-of/","title":"valueOf - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/valueOf
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): SlackWebhookResponse
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/values/","title":"values - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<SlackWebhookResponse>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/action_prohibited/","title":"action_prohibited - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/action_prohibited
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/action_prohibited/#action_prohibited","title":"action_prohibited","text":"[jvm]\\ action_prohibited
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/action_prohibited/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_is_archived/","title":"channel_is_archived - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/channel_is_archived
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_is_archived/#channel_is_archived","title":"channel_is_archived","text":"[jvm]\\ channel_is_archived
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_is_archived/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_not_found/","title":"channel_not_found - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/channel_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_not_found/#channel_not_found","title":"channel_not_found","text":"[jvm]\\ channel_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/channel_not_found/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/invalid_payload/","title":"invalid_payload - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/invalid_payload
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/invalid_payload/#invalid_payload","title":"invalid_payload","text":"[jvm]\\ invalid_payload
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/invalid_payload/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/missing_text_or_fallback_or_attachments/","title":"missing_text_or_fallback_or_attachments - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/missing_text_or_fallback_or_attachments
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/missing_text_or_fallback_or_attachments/#missing_text_or_fallback_or_attachments","title":"missing_text_or_fallback_or_attachments","text":"[jvm]\\ missing_text_or_fallback_or_attachments
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/missing_text_or_fallback_or_attachments/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/ok/","title":"ok - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/ok/#ok","title":"ok","text":"[jvm]\\ ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/ok/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/user_not_found/","title":"user_not_found - Misk","text":"//misk-slack/misk.slack/SlackWebhookResponse/user_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/user_not_found/#user_not_found","title":"user_not_found","text":"[jvm]\\ user_not_found
"},{"location":"0.x/misk-slack/misk-slack/misk.slack/-slack-webhook-response/user_not_found/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack.webapi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/#types","title":"Types","text":"Name Summary RealSlackClient [jvm]class RealSlackClient@Injectconstructor(slackApi: SlackApi) : SlackClient RealSlackClientModule [jvm]class RealSlackClientModule(config: SlackConfig) : KAbstractModule SlackApi [jvm]interface SlackApi SlackClient [jvm]interface SlackClient SlackConfig [jvm]data class SlackConfig@JvmOverloadsconstructor(val url: String = \"https://hooks.slack.com/", val bearer_token: Secret<String>, val signing_secret: Secret<String>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/#functions","title":"Functions","text":"Name Summary checkSuccessful [jvm]fun Response<PostMessageResponse>.checkSuccessful()"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/check-successful/","title":"checkSuccessful - Misk","text":"//misk-slack/misk.slack.webapi/checkSuccessful
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/check-successful/#checksuccessful","title":"checkSuccessful","text":"[jvm]\\ fun Response<PostMessageResponse>.checkSuccessful()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\ class RealSlackClient@Injectconstructor(slackApi: SlackApi) : SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/#constructors","title":"Constructors","text":"RealSlackClient [jvm]@Injectconstructor(slackApi: SlackApi)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/#functions","title":"Functions","text":"Name Summary getUserByEmail [jvm]open override fun getUserByEmail(email: String): GetUserResponse postConfirmation [jvm]open override fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse postMessage [jvm]open override fun postMessage(request: PostMessageRequest): PostMessageResponse"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/-real-slack-client/","title":"RealSlackClient - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/RealSlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/-real-slack-client/#realslackclient","title":"RealSlackClient","text":"[jvm]\\
@Inject
constructor(slackApi: SlackApi)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/get-user-by-email/","title":"getUserByEmail - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/getUserByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/get-user-by-email/#getuserbyemail","title":"getUserByEmail","text":"[jvm]\\ open override fun getUserByEmail(email: String): GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-confirmation/","title":"postConfirmation - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/postConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-confirmation/#postconfirmation","title":"postConfirmation","text":"[jvm]\\ open override fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\ open override fun postMessage(request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/","title":"RealSlackClientModule - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClientModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/#realslackclientmodule","title":"RealSlackClientModule","text":"[jvm]\\ class RealSlackClientModule(config: SlackConfig) : KAbstractModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/#constructors","title":"Constructors","text":"RealSlackClientModule [jvm]constructor(config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/-real-slack-client-module/","title":"RealSlackClientModule - Misk","text":"//misk-slack/misk.slack.webapi/RealSlackClientModule/RealSlackClientModule
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-real-slack-client-module/-real-slack-client-module/#realslackclientmodule","title":"RealSlackClientModule","text":"[jvm]\\ constructor(config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/","title":"SlackApi - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/#slackapi","title":"SlackApi","text":"[jvm]\\ interface SlackApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/#functions","title":"Functions","text":"Name Summary getUserByEmail [jvm]@GET(value = \"/api/users.lookupByEmail\")@Headers(value = [\"accept: application/json\"])abstract fun getUserByEmail(@Query(value = \"email\")email: String): Call<GetUserResponse>Calls Slack to fetch user for given email. postConfirmation [jvm]@POST@Headers(value = [\"accept: application/json\"])abstract fun postConfirmation(@Urlurl: String, @BodyconfirmationMessageJson: PostMessageRequest): Call<PostMessageResponse>Calls Slack and asks it to post a confirmation message to the dynamic URL sent from Slack. https://api.slack.com/interactivity/handling#message_responses postMessage [jvm]@POST(value = \"/api/chat.postMessage\")@Headers(value = [\"accept: application/json\"])abstract fun postMessage(@BodypostMessageJson: PostMessageRequest): Call<PostMessageResponse>Calls Slack and asks it to post message. https://api.slack.com/methods/chat.postMessage"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/get-user-by-email/","title":"getUserByEmail - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi/getUserByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/get-user-by-email/#getuserbyemail","title":"getUserByEmail","text":"[jvm]\\
@GET(value = \"/api/users.lookupByEmail\")
@Headers(value = [\"accept: application/json\"])
abstract fun getUserByEmail(@Query(value = \"email\")email: String): Call<GetUserResponse>
Calls Slack to fetch user for given email.
https://api.slack.com/methods/users.lookupByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-confirmation/","title":"postConfirmation - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi/postConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-confirmation/#postconfirmation","title":"postConfirmation","text":"[jvm]\\
@POST
@Headers(value = [\"accept: application/json\"])
abstract fun postConfirmation(@Urlurl: String, @BodyconfirmationMessageJson: PostMessageRequest): Call<PostMessageResponse>
Calls Slack and asks it to post a confirmation message to the dynamic URL sent from Slack. https://api.slack.com/interactivity/handling#message_responses
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack.webapi/SlackApi/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-api/post-message/#postmessage","title":"postMessage","text":"[jvm]\\
@POST(value = \"/api/chat.postMessage\")
@Headers(value = [\"accept: application/json\"])
abstract fun postMessage(@BodypostMessageJson: PostMessageRequest): Call<PostMessageResponse>
Calls Slack and asks it to post message. https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/","title":"SlackClient - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/#slackclient","title":"SlackClient","text":"interface SlackClient
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/#inheritors","title":"Inheritors","text":"RealSlackClient"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/#functions","title":"Functions","text":"Name Summary getUserByEmail [jvm]abstract fun getUserByEmail(mail: String): GetUserResponse postConfirmation [jvm]abstract fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse postMessage [jvm]abstract fun postMessage(request: PostMessageRequest): PostMessageResponse"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/get-user-by-email/","title":"getUserByEmail - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient/getUserByEmail
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/get-user-by-email/#getuserbyemail","title":"getUserByEmail","text":"[jvm]\\ abstract fun getUserByEmail(mail: String): GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-confirmation/","title":"postConfirmation - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient/postConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-confirmation/#postconfirmation","title":"postConfirmation","text":"[jvm]\\ abstract fun postConfirmation(url: String, request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-message/","title":"postMessage - Misk","text":"//misk-slack/misk.slack.webapi/SlackClient/postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-client/post-message/#postmessage","title":"postMessage","text":"[jvm]\\ abstract fun postMessage(request: PostMessageRequest): PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\ data class SlackConfig@JvmOverloadsconstructor(val url: String = \"https://hooks.slack.com/", val bearer_token: Secret<String>, val signing_secret: Secret<String>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/#constructors","title":"Constructors","text":"SlackConfig [jvm]@JvmOverloadsconstructor(url: String = \"https://hooks.slack.com/", bearer_token: Secret<String>, signing_secret: Secret<String>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/#properties","title":"Properties","text":"Name Summary bearer_token [jvm]val bearer_token: Secret<String> signing_secret [jvm]val signing_secret: Secret<String> url [jvm]val url: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/-slack-config/","title":"SlackConfig - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/-slack-config/#slackconfig","title":"SlackConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String = \"https://hooks.slack.com/", bearer_token: Secret<String>, signing_secret: Secret<String>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/bearer_token/","title":"bearer_token - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/bearer_token
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/bearer_token/#bearer_token","title":"bearer_token","text":"[jvm]\\ val bearer_token: Secret<String>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/signing_secret/","title":"signing_secret - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/signing_secret
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/signing_secret/#signing_secret","title":"signing_secret","text":"[jvm]\\ val signing_secret: Secret<String>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/url/","title":"url - Misk","text":"//misk-slack/misk.slack.webapi/SlackConfig/url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi/-slack-config/url/#url","title":"url","text":"[jvm]\\ val url: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/","title":"Index","text":"//misk-slack/misk.slack.webapi.helpers
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#types","title":"Types","text":"Name Summary Actions [jvm]data class Actions(val type: String, val block_id: String, val action_id: String, val text: Text, val value: String, val action_ts: String) Block [jvm]data class Block@JvmOverloadsconstructor(val type: String, val replace_original: Boolean? = null, val block_id: String? = null, val text: Text? = null, val accessory: ButtonLinkAndValue? = null, val elements: List<ButtonLinkAndValue>? = null)An envelope that contains text or elements. ButtonLinkAndValue [jvm]data class ButtonLinkAndValue@JvmOverloadsconstructor(val type: String, val text: Text, val value: String? = null, val url: String? = null, val action_id: String? = null)https://api.slack.com/reference/block-kit/block-elements#button ButtonPress [jvm]data class ButtonPress(val type: String, val user: User, val api_app_id: String, val token: String, val container: Container, val trigger_id: String, val team: Team, val enterprise: Id, val is_enterprise_install: Boolean, val channel: Id, val message: Message, val state: Values, val response_url: String, val actions: List<Actions>)Message received from Slack upon button press. Container [jvm]data class Container(val type: String, val message_ts: String, val channel_id: String, val is_ephemeral: Boolean) EnterpriseUser [jvm]data class EnterpriseUser@JvmOverloadsconstructor(val enterprise_id: String? = null, val enterprise_name: String? = null, val id: String? = null, val is_admin: Boolean? = null, val is_owner: Boolean? = null, val teams: Array<String>? = null)An object containing info related to an Enterprise Grid user. GetUserResponse [jvm]data class GetUserResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val user: UserData? = null)Message received from slack after posting a message Id [jvm]data class Id(val id: String, val name: String) Message [jvm]data class Message(val bot_id: String, val type: String, val text: String, val user: String, val ts: String, val app_id: String, val blocks: List<Block>, val team: String) MrkdwnBuilder [jvm]class MrkdwnBuilderMrkdwn is Slack\u2019s weird thing that isn\u2019t Markdown. This class attempts to implement proper escaping and formatting. PostMessageRequest [jvm]data class PostMessageRequest@JvmOverloadsconstructor(val channel: String, val response_type: String? = \"in_channel\", val blocks: List<Any>)Message posted to /api/chat.postMessage PostMessageResponse [jvm]data class PostMessageResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val channel: String? = null, val ts: String? = null, val message: Message? = null)Message received from slack after posting a message SlashCommand [jvm]data class SlashCommand(val command: String, val text: String, val response_url: String, val trigger_id: String, val user_id: String, val user_name: String, val channel_id: String, val api_app_id: String)Payload received from Slack when user invokes slash command SlashInteractionResponse [jvm]data class SlashInteractionResponse@JvmOverloadsconstructor(val response_type: String? = \"in_channel\", val text: String)Response sent back to Slack while slash commands are being handled. Team [jvm]data class Team(val id: String, val domain: String, val enterprise_id: String, val enterprise_name: String) Text [jvm]data class Text@JvmOverloadsconstructor(val type: String, val text: String? = null, val emoji: Boolean? = null)https://api.slack.com/reference/block-kit/composition-objects#text User [jvm]data class User(val id: String, val username: String, val name: String, val team_id: String) UserData [jvm]data class UserData@JvmOverloadsconstructor(val always_active: Boolean? = null, val color: String? = null, val deleted: Boolean? = null, val enterprise_user: EnterpriseUser? = null, val has_2fa: Boolean? = null, val id: String? = null, val is_admin: Boolean? = null, val is_app_user: Boolean? = null, val is_bot: Boolean? = null, val is_email_confirmed: Boolean? = null, val is_invited_user: Boolean? = null, val is_owner: Boolean? = null, val is_primary_owner: Boolean? = null, val is_restricted: Boolean? = null, val is_stranger: Boolean? = null, val is_ultra_restricted: Boolean? = null, val locale: String? = null, val name: String? = null, val profile: UserProfile? = null, val real_name: String? = null, val team_id: String? = null, val two_factor_type: String? = null, val tz: String? = null, val tz_label: String? = null, val tz_offset: Int? = null, val updated: Int? = null)A user object contains information about a Slack workspace user. The composition of user objects can vary greatly depending on the API being used, or the context of each Slack workspace. Data that has not been supplied may not be present at all, may be null, or may contain an empty string. UserProfile [jvm]data class UserProfile@JvmOverloadsconstructor(val avatar_hash: String? = null, val display_name: String? = null, val display_name_normalized: String? = null, val email: String? = null, val fields: UserProfileFields? = null, val first_name: String? = null, val image_24: String? = null, val image_32: String? = null, val image_48: String? = null, val image_72: String? = null, val image_192: String? = null, val image_512: String? = null, val last_name: String? = null, val phone: String? = null, val pronouns: String? = null, val real_name: String? = null, val real_name_normalized: String? = null, val skype: String? = null, val start_date: String? = null, val status_emoji: String? = null, val status_expiration: Int? = null, val status_text: String? = null, val team: String? = null, val title: String? = null)A user object contains information about a Slack workspace user. UserProfileFields [jvm]data class UserProfileFields@JvmOverloadsconstructor(val display_name: String?, val email: String?, val first_name: String?, val last_name: String?, val phone: String?, val pronouns: String?, val real_name: String?, val start_date: String?, val title: String?)The following fields are the default fields of a user\u2019s workspace profile. Values [jvm]data class Values(val text: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#properties","title":"Properties","text":"Name Summary zwsp [jvm]val zwsp: StringInserting a zero-width space is enough to prevent Slack from attempting to link a string like :smile: as an emoji."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/#functions","title":"Functions","text":"Name Summary buildMrkdwn [jvm]fun buildMrkdwn(builderAction: MrkdwnBuilder.() -> Unit): String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/build-mrkdwn/","title":"buildMrkdwn - Misk","text":"//misk-slack/misk.slack.webapi.helpers/buildMrkdwn
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/build-mrkdwn/#buildmrkdwn","title":"buildMrkdwn","text":"[jvm]\\ fun buildMrkdwn(builderAction: MrkdwnBuilder.() -> Unit): String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/zwsp/","title":"zwsp - Misk","text":"//misk-slack/misk.slack.webapi.helpers/zwsp
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/zwsp/#zwsp","title":"zwsp","text":"[jvm]\\ val zwsp: String
Inserting a zero-width space is enough to prevent Slack from attempting to link a string like :smile: as an emoji.
https://en.wikipedia.org/wiki/Zero-width_space
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/","title":"Actions - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/#actions","title":"Actions","text":"[jvm]\\ data class Actions(val type: String, val block_id: String, val action_id: String, val text: Text, val value: String, val action_ts: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/#constructors","title":"Constructors","text":"Actions [jvm]constructor(type: String, block_id: String, action_id: String, text: Text, value: String, action_ts: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/#properties","title":"Properties","text":"Name Summary action_id [jvm]val action_id: String action_ts [jvm]val action_ts: String block_id [jvm]val block_id: String text [jvm]val text: Text type [jvm]val type: String value [jvm]val value: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/-actions/","title":"Actions - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/Actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/-actions/#actions","title":"Actions","text":"[jvm]\\ constructor(type: String, block_id: String, action_id: String, text: Text, value: String, action_ts: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_id/","title":"action_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/action_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_id/#action_id","title":"action_id","text":"[jvm]\\ val action_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_ts/","title":"action_ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/action_ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/action_ts/#action_ts","title":"action_ts","text":"[jvm]\\ val action_ts: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/block_id/","title":"block_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/block_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/block_id/#block_id","title":"block_id","text":"[jvm]\\ val block_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/text/#text","title":"text","text":"[jvm]\\ val text: Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/value/","title":"value - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Actions/value
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-actions/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/","title":"Block - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/#block","title":"Block","text":"[jvm]\\ data class Block@JvmOverloadsconstructor(val type: String, val replace_original: Boolean? = null, val block_id: String? = null, val text: Text? = null, val accessory: ButtonLinkAndValue? = null, val elements: List<ButtonLinkAndValue>? = null)
An envelope that contains text or elements.
https://api.slack.com/reference/block-kit/blocks
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/#constructors","title":"Constructors","text":"Block [jvm]@JvmOverloadsconstructor(type: String, replace_original: Boolean? = null, block_id: String? = null, text: Text? = null, accessory: ButtonLinkAndValue? = null, elements: List<ButtonLinkAndValue>? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/#properties","title":"Properties","text":"Name Summary accessory [jvm]val accessory: ButtonLinkAndValue? = null block_id [jvm]val block_id: String? = null elements [jvm]val elements: List<ButtonLinkAndValue>? = null replace_original [jvm]val replace_original: Boolean? = null text [jvm]val text: Text? = null type [jvm]val type: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/-block/","title":"Block - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/Block
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/-block/#block","title":"Block","text":"[jvm]\\
@JvmOverloads
constructor(type: String, replace_original: Boolean? = null, block_id: String? = null, text: Text? = null, accessory: ButtonLinkAndValue? = null, elements: List<ButtonLinkAndValue>? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/accessory/","title":"accessory - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/accessory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/accessory/#accessory","title":"accessory","text":"[jvm]\\ val accessory: ButtonLinkAndValue? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/block_id/","title":"block_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/block_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/block_id/#block_id","title":"block_id","text":"[jvm]\\ val block_id: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/elements/","title":"elements - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/elements
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/elements/#elements","title":"elements","text":"[jvm]\\ val elements: List<ButtonLinkAndValue>? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/replace_original/","title":"replace_original - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/replace_original
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/replace_original/#replace_original","title":"replace_original","text":"[jvm]\\ val replace_original: Boolean? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/text/#text","title":"text","text":"[jvm]\\ val text: Text? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Block/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-block/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/","title":"ButtonLinkAndValue - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/#buttonlinkandvalue","title":"ButtonLinkAndValue","text":"[jvm]\\ data class ButtonLinkAndValue@JvmOverloadsconstructor(val type: String, val text: Text, val value: String? = null, val url: String? = null, val action_id: String? = null)
https://api.slack.com/reference/block-kit/block-elements#button
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/#constructors","title":"Constructors","text":"ButtonLinkAndValue [jvm]@JvmOverloadsconstructor(type: String, text: Text, value: String? = null, url: String? = null, action_id: String? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/#properties","title":"Properties","text":"Name Summary action_id [jvm]val action_id: String? = null text [jvm]val text: Text type [jvm]val type: String url [jvm]val url: String? = null value [jvm]val value: String? = null"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/-button-link-and-value/","title":"ButtonLinkAndValue - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/ButtonLinkAndValue
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/-button-link-and-value/#buttonlinkandvalue","title":"ButtonLinkAndValue","text":"[jvm]\\
@JvmOverloads
constructor(type: String, text: Text, value: String? = null, url: String? = null, action_id: String? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/action_id/","title":"action_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/action_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/action_id/#action_id","title":"action_id","text":"[jvm]\\ val action_id: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/text/#text","title":"text","text":"[jvm]\\ val text: Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/url/","title":"url - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/value/","title":"value - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonLinkAndValue/value
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-link-and-value/value/#value","title":"value","text":"[jvm]\\ val value: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/","title":"ButtonPress - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/#buttonpress","title":"ButtonPress","text":"[jvm]\\ data class ButtonPress(val type: String, val user: User, val api_app_id: String, val token: String, val container: Container, val trigger_id: String, val team: Team, val enterprise: Id, val is_enterprise_install: Boolean, val channel: Id, val message: Message, val state: Values, val response_url: String, val actions: List<Actions>)
Message received from Slack upon button press.
https://api.slack.com/reference/interaction-payloads/block-actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/#constructors","title":"Constructors","text":"ButtonPress [jvm]constructor(type: String, user: User, api_app_id: String, token: String, container: Container, trigger_id: String, team: Team, enterprise: Id, is_enterprise_install: Boolean, channel: Id, message: Message, state: Values, response_url: String, actions: List<Actions>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/#properties","title":"Properties","text":"Name Summary actions [jvm]val actions: List<Actions> api_app_id [jvm]val api_app_id: String channel [jvm]val channel: Id container [jvm]val container: Container enterprise [jvm]val enterprise: Id is_enterprise_install [jvm]val is_enterprise_install: Boolean message [jvm]val message: Message response_url [jvm]val response_url: String state [jvm]val state: Values team [jvm]val team: Team token [jvm]val token: String trigger_id [jvm]val trigger_id: String type [jvm]val type: String user [jvm]val user: User"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/-button-press/","title":"ButtonPress - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/ButtonPress
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/-button-press/#buttonpress","title":"ButtonPress","text":"[jvm]\\ constructor(type: String, user: User, api_app_id: String, token: String, container: Container, trigger_id: String, team: Team, enterprise: Id, is_enterprise_install: Boolean, channel: Id, message: Message, state: Values, response_url: String, actions: List<Actions>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/actions/","title":"actions - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/actions
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/actions/#actions","title":"actions","text":"[jvm]\\ val actions: List<Actions>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/api_app_id/","title":"api_app_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/api_app_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/api_app_id/#api_app_id","title":"api_app_id","text":"[jvm]\\ val api_app_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/channel/#channel","title":"channel","text":"[jvm]\\ val channel: Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/container/","title":"container - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/container/#container","title":"container","text":"[jvm]\\ val container: Container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/enterprise/","title":"enterprise - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/enterprise
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/enterprise/#enterprise","title":"enterprise","text":"[jvm]\\ val enterprise: Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/is_enterprise_install/","title":"is_enterprise_install - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/is_enterprise_install
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/is_enterprise_install/#is_enterprise_install","title":"is_enterprise_install","text":"[jvm]\\ val is_enterprise_install: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/message/","title":"message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/message/#message","title":"message","text":"[jvm]\\ val message: Message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/response_url/","title":"response_url - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/response_url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/response_url/#response_url","title":"response_url","text":"[jvm]\\ val response_url: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/state/","title":"state - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/state
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/state/#state","title":"state","text":"[jvm]\\ val state: Values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/team/","title":"team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/team/#team","title":"team","text":"[jvm]\\ val team: Team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/token/","title":"token - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/token
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/token/#token","title":"token","text":"[jvm]\\ val token: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/trigger_id/","title":"trigger_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/trigger_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/trigger_id/#trigger_id","title":"trigger_id","text":"[jvm]\\ val trigger_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/user/","title":"user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/ButtonPress/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-button-press/user/#user","title":"user","text":"[jvm]\\ val user: User
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/","title":"Container - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/#container","title":"Container","text":"[jvm]\\ data class Container(val type: String, val message_ts: String, val channel_id: String, val is_ephemeral: Boolean)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/#constructors","title":"Constructors","text":"Container [jvm]constructor(type: String, message_ts: String, channel_id: String, is_ephemeral: Boolean)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/#properties","title":"Properties","text":"Name Summary channel_id [jvm]val channel_id: String is_ephemeral [jvm]val is_ephemeral: Boolean message_ts [jvm]val message_ts: String type [jvm]val type: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/-container/","title":"Container - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/Container
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/-container/#container","title":"Container","text":"[jvm]\\ constructor(type: String, message_ts: String, channel_id: String, is_ephemeral: Boolean)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/channel_id/","title":"channel_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/channel_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/channel_id/#channel_id","title":"channel_id","text":"[jvm]\\ val channel_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/is_ephemeral/","title":"is_ephemeral - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/is_ephemeral
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/is_ephemeral/#is_ephemeral","title":"is_ephemeral","text":"[jvm]\\ val is_ephemeral: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/message_ts/","title":"message_ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/message_ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/message_ts/#message_ts","title":"message_ts","text":"[jvm]\\ val message_ts: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Container/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-container/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/","title":"EnterpriseUser - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/#enterpriseuser","title":"EnterpriseUser","text":"[jvm]\\ data class EnterpriseUser@JvmOverloadsconstructor(val enterprise_id: String? = null, val enterprise_name: String? = null, val id: String? = null, val is_admin: Boolean? = null, val is_owner: Boolean? = null, val teams: Array<String>? = null)
An object containing info related to an Enterprise Grid user.
https://api.slack.com/enterprise/grid
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/#constructors","title":"Constructors","text":"EnterpriseUser [jvm]@JvmOverloadsconstructor(enterprise_id: String? = null, enterprise_name: String? = null, id: String? = null, is_admin: Boolean? = null, is_owner: Boolean? = null, teams: Array<String>? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/#properties","title":"Properties","text":"Name Summary enterprise_id [jvm]val enterprise_id: String? = nullA unique ID for the Enterprise Grid organization this user belongs to. enterprise_name [jvm]val enterprise_name: String? = nullA display name for the Enterprise Grid organization. id [jvm]val id: String? = nullThis user\u2019s ID - some Grid users have a kind of dual identity \u2014 a local, workspace-centric user ID as well as a Grid-wise user ID, called the Enterprise user ID. In most cases these IDs can be used interchangeably, but when it is provided, we strongly recommend using this Enterprise user id over the root level user id field. is_admin [jvm]val is_admin: Boolean? = nullIndicates whether the user is an Admin of the Enterprise Grid organization. is_owner [jvm]val is_owner: Boolean? = nullIndicates whether the user is an Owner of the Enterprise Grid organization. teams [jvm]val teams: Array<String>? = nullAn array of workspace IDs that are in the Enterprise Grid organization."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/-enterprise-user/","title":"EnterpriseUser - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/EnterpriseUser
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/-enterprise-user/#enterpriseuser","title":"EnterpriseUser","text":"[jvm]\\
@JvmOverloads
constructor(enterprise_id: String? = null, enterprise_name: String? = null, id: String? = null, is_admin: Boolean? = null, is_owner: Boolean? = null, teams: Array<String>? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_id/","title":"enterprise_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/enterprise_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_id/#enterprise_id","title":"enterprise_id","text":"[jvm]\\ val enterprise_id: String? = null
A unique ID for the Enterprise Grid organization this user belongs to.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_name/","title":"enterprise_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/enterprise_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/enterprise_name/#enterprise_name","title":"enterprise_name","text":"[jvm]\\ val enterprise_name: String? = null
A display name for the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/id/#id","title":"id","text":"[jvm]\\ val id: String? = null
This user\u2019s ID - some Grid users have a kind of dual identity \u2014 a local, workspace-centric user ID as well as a Grid-wise user ID, called the Enterprise user ID. In most cases these IDs can be used interchangeably, but when it is provided, we strongly recommend using this Enterprise user id over the root level user id field.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_admin/","title":"is_admin - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/is_admin
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_admin/#is_admin","title":"is_admin","text":"[jvm]\\ val is_admin: Boolean? = null
Indicates whether the user is an Admin of the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_owner/","title":"is_owner - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/is_owner
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/is_owner/#is_owner","title":"is_owner","text":"[jvm]\\ val is_owner: Boolean? = null
Indicates whether the user is an Owner of the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/teams/","title":"teams - Misk","text":"//misk-slack/misk.slack.webapi.helpers/EnterpriseUser/teams
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-enterprise-user/teams/#teams","title":"teams","text":"[jvm]\\ val teams: Array<String>? = null
An array of workspace IDs that are in the Enterprise Grid organization.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/","title":"GetUserResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/#getuserresponse","title":"GetUserResponse","text":"[jvm]\\ data class GetUserResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val user: UserData? = null)
Message received from slack after posting a message
https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/#constructors","title":"Constructors","text":"GetUserResponse [jvm]@JvmOverloadsconstructor(ok: Boolean, error: String? = null, user: UserData? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/#properties","title":"Properties","text":"Name Summary error [jvm]val error: String? = null ok [jvm]val ok: Boolean user [jvm]val user: UserData? = null"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/-get-user-response/","title":"GetUserResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/GetUserResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/-get-user-response/#getuserresponse","title":"GetUserResponse","text":"[jvm]\\
@JvmOverloads
constructor(ok: Boolean, error: String? = null, user: UserData? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/error/","title":"error - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/error
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/error/#error","title":"error","text":"[jvm]\\ val error: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/ok/","title":"ok - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/ok/#ok","title":"ok","text":"[jvm]\\ val ok: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/user/","title":"user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/GetUserResponse/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-get-user-response/user/#user","title":"user","text":"[jvm]\\ val user: UserData? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/","title":"Id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/#id","title":"Id","text":"[jvm]\\ data class Id(val id: String, val name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/#constructors","title":"Constructors","text":"Id [jvm]constructor(id: String, name: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/#properties","title":"Properties","text":"Name Summary id [jvm]val id: String name [jvm]val name: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/-id/","title":"Id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id/Id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/-id/#id","title":"Id","text":"[jvm]\\ constructor(id: String, name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/name/","title":"name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Id/name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-id/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/","title":"Message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/#message","title":"Message","text":"[jvm]\\ data class Message(val bot_id: String, val type: String, val text: String, val user: String, val ts: String, val app_id: String, val blocks: List<Block>, val team: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/#constructors","title":"Constructors","text":"Message [jvm]constructor(bot_id: String, type: String, text: String, user: String, ts: String, app_id: String, blocks: List<Block>, team: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/#properties","title":"Properties","text":"Name Summary app_id [jvm]val app_id: String blocks [jvm]val blocks: List<Block> bot_id [jvm]val bot_id: String team [jvm]val team: String text [jvm]val text: String ts [jvm]val ts: String type [jvm]val type: String user [jvm]val user: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/-message/","title":"Message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/Message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/-message/#message","title":"Message","text":"[jvm]\\ constructor(bot_id: String, type: String, text: String, user: String, ts: String, app_id: String, blocks: List<Block>, team: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/app_id/","title":"app_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/app_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/app_id/#app_id","title":"app_id","text":"[jvm]\\ val app_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/blocks/","title":"blocks - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/blocks
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/blocks/#blocks","title":"blocks","text":"[jvm]\\ val blocks: List<Block>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/bot_id/","title":"bot_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/bot_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/bot_id/#bot_id","title":"bot_id","text":"[jvm]\\ val bot_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/team/","title":"team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/team/#team","title":"team","text":"[jvm]\\ val team: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/ts/","title":"ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/ts/#ts","title":"ts","text":"[jvm]\\ val ts: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/user/","title":"user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Message/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-message/user/#user","title":"user","text":"[jvm]\\ val user: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/","title":"MrkdwnBuilder - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/#mrkdwnbuilder","title":"MrkdwnBuilder","text":"[jvm]\\ class MrkdwnBuilder
Mrkdwn is Slack\u2019s weird thing that isn\u2019t Markdown. This class attempts to implement proper escaping and formatting.
SlackApi.postMessage and SlackApi.postConfirmation can both post JSON with markdown formatting. SlackJson.TextJson allows you to set the type as plain text or markdown.
Note that the Mrkdwn docs aren\u2019t particularly helpful here.
Note that this implementation is more conservative about encoding than strictly necessary. For example, it escapes things like the colon at the end of Notice:, even though colons only really need to be escaped when they signal an emoji (:smile:).
https://api.slack.com/reference/surfaces/formatting#basics
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/#constructors","title":"Constructors","text":"MrkdwnBuilder [jvm]constructor()"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/#functions","title":"Functions","text":"Name Summary append [jvm]fun append(s: String) appendBlockquotePrefix [jvm]fun appendBlockquotePrefix() appendLink [jvm]fun appendLink(url: String, label: String) build [jvm]fun build(): String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/-mrkdwn-builder/","title":"MrkdwnBuilder - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/MrkdwnBuilder
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/-mrkdwn-builder/#mrkdwnbuilder","title":"MrkdwnBuilder","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-blockquote-prefix/","title":"appendBlockquotePrefix - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/appendBlockquotePrefix
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-blockquote-prefix/#appendblockquoteprefix","title":"appendBlockquotePrefix","text":"[jvm]\\ fun appendBlockquotePrefix()
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-link/","title":"appendLink - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/appendLink
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append-link/#appendlink","title":"appendLink","text":"[jvm]\\ fun appendLink(url: String, label: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append/","title":"append - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/append
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/append/#append","title":"append","text":"[jvm]\\ fun append(s: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/build/","title":"build - Misk","text":"//misk-slack/misk.slack.webapi.helpers/MrkdwnBuilder/build
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-mrkdwn-builder/build/#build","title":"build","text":"[jvm]\\ fun build(): String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/","title":"PostMessageRequest - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/#postmessagerequest","title":"PostMessageRequest","text":"[jvm]\\ data class PostMessageRequest@JvmOverloadsconstructor(val channel: String, val response_type: String? = \"in_channel\", val blocks: List<Any>)
Message posted to /api/chat.postMessage
https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/#constructors","title":"Constructors","text":"PostMessageRequest [jvm]@JvmOverloadsconstructor(channel: String, response_type: String? = \"in_channel\", blocks: List<Any>)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/#properties","title":"Properties","text":"Name Summary blocks [jvm]val blocks: List<Any> channel [jvm]val channel: String response_type [jvm]val response_type: String?"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/-post-message-request/","title":"PostMessageRequest - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/PostMessageRequest
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/-post-message-request/#postmessagerequest","title":"PostMessageRequest","text":"[jvm]\\
@JvmOverloads
constructor(channel: String, response_type: String? = \"in_channel\", blocks: List<Any>)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/blocks/","title":"blocks - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/blocks
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/blocks/#blocks","title":"blocks","text":"[jvm]\\ val blocks: List<Any>
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/channel/#channel","title":"channel","text":"[jvm]\\ val channel: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/response_type/","title":"response_type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageRequest/response_type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-request/response_type/#response_type","title":"response_type","text":"[jvm]\\ val response_type: String?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/","title":"PostMessageResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/#postmessageresponse","title":"PostMessageResponse","text":"[jvm]\\ data class PostMessageResponse@JvmOverloadsconstructor(val ok: Boolean, val error: String? = null, val channel: String? = null, val ts: String? = null, val message: Message? = null)
Message received from slack after posting a message
https://api.slack.com/methods/chat.postMessage
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/#constructors","title":"Constructors","text":"PostMessageResponse [jvm]@JvmOverloadsconstructor(ok: Boolean, error: String? = null, channel: String? = null, ts: String? = null, message: Message? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/#properties","title":"Properties","text":"Name Summary channel [jvm]val channel: String? = null error [jvm]val error: String? = null message [jvm]val message: Message? = null ok [jvm]val ok: Boolean ts [jvm]val ts: String? = null"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/-post-message-response/","title":"PostMessageResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/PostMessageResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/-post-message-response/#postmessageresponse","title":"PostMessageResponse","text":"[jvm]\\
@JvmOverloads
constructor(ok: Boolean, error: String? = null, channel: String? = null, ts: String? = null, message: Message? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/channel/","title":"channel - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/channel
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/channel/#channel","title":"channel","text":"[jvm]\\ val channel: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/error/","title":"error - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/error
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/error/#error","title":"error","text":"[jvm]\\ val error: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/message/","title":"message - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/message
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/message/#message","title":"message","text":"[jvm]\\ val message: Message? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ok/","title":"ok - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/ok
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ok/#ok","title":"ok","text":"[jvm]\\ val ok: Boolean
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ts/","title":"ts - Misk","text":"//misk-slack/misk.slack.webapi.helpers/PostMessageResponse/ts
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-post-message-response/ts/#ts","title":"ts","text":"[jvm]\\ val ts: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/","title":"SlashCommand - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/#slashcommand","title":"SlashCommand","text":"[jvm]\\ data class SlashCommand(val command: String, val text: String, val response_url: String, val trigger_id: String, val user_id: String, val user_name: String, val channel_id: String, val api_app_id: String)
Payload received from Slack when user invokes slash command
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/#constructors","title":"Constructors","text":"SlashCommand [jvm]constructor(command: String, text: String, response_url: String, trigger_id: String, user_id: String, user_name: String, channel_id: String, api_app_id: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/#properties","title":"Properties","text":"Name Summary api_app_id [jvm]val api_app_id: String channel_id [jvm]val channel_id: String command [jvm]val command: String response_url [jvm]val response_url: String text [jvm]val text: String trigger_id [jvm]val trigger_id: String user_id [jvm]val user_id: String user_name [jvm]val user_name: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/-slash-command/","title":"SlashCommand - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/SlashCommand
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/-slash-command/#slashcommand","title":"SlashCommand","text":"[jvm]\\ constructor(command: String, text: String, response_url: String, trigger_id: String, user_id: String, user_name: String, channel_id: String, api_app_id: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/api_app_id/","title":"api_app_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/api_app_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/api_app_id/#api_app_id","title":"api_app_id","text":"[jvm]\\ val api_app_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/channel_id/","title":"channel_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/channel_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/channel_id/#channel_id","title":"channel_id","text":"[jvm]\\ val channel_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/command/","title":"command - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/command
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/command/#command","title":"command","text":"[jvm]\\ val command: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/response_url/","title":"response_url - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/response_url
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/response_url/#response_url","title":"response_url","text":"[jvm]\\ val response_url: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/trigger_id/","title":"trigger_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/trigger_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/trigger_id/#trigger_id","title":"trigger_id","text":"[jvm]\\ val trigger_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_id/","title":"user_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/user_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_id/#user_id","title":"user_id","text":"[jvm]\\ val user_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_name/","title":"user_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashCommand/user_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-command/user_name/#user_name","title":"user_name","text":"[jvm]\\ val user_name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/","title":"SlashInteractionResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/#slashinteractionresponse","title":"SlashInteractionResponse","text":"[jvm]\\ data class SlashInteractionResponse@JvmOverloadsconstructor(val response_type: String? = \"in_channel\", val text: String)
Response sent back to Slack while slash commands are being handled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/#constructors","title":"Constructors","text":"SlashInteractionResponse [jvm]@JvmOverloadsconstructor(response_type: String? = \"in_channel\", text: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/#properties","title":"Properties","text":"Name Summary response_type [jvm]val response_type: String? text [jvm]val text: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/-slash-interaction-response/","title":"SlashInteractionResponse - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse/SlashInteractionResponse
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/-slash-interaction-response/#slashinteractionresponse","title":"SlashInteractionResponse","text":"[jvm]\\
@JvmOverloads
constructor(response_type: String? = \"in_channel\", text: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/response_type/","title":"response_type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse/response_type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/response_type/#response_type","title":"response_type","text":"[jvm]\\ val response_type: String?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/SlashInteractionResponse/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-slash-interaction-response/text/#text","title":"text","text":"[jvm]\\ val text: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/","title":"Team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/#team","title":"Team","text":"[jvm]\\ data class Team(val id: String, val domain: String, val enterprise_id: String, val enterprise_name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/#constructors","title":"Constructors","text":"Team [jvm]constructor(id: String, domain: String, enterprise_id: String, enterprise_name: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/#properties","title":"Properties","text":"Name Summary domain [jvm]val domain: String enterprise_id [jvm]val enterprise_id: String enterprise_name [jvm]val enterprise_name: String id [jvm]val id: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/-team/","title":"Team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/Team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/-team/#team","title":"Team","text":"[jvm]\\ constructor(id: String, domain: String, enterprise_id: String, enterprise_name: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/domain/","title":"domain - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/domain
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/domain/#domain","title":"domain","text":"[jvm]\\ val domain: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_id/","title":"enterprise_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/enterprise_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_id/#enterprise_id","title":"enterprise_id","text":"[jvm]\\ val enterprise_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_name/","title":"enterprise_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/enterprise_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/enterprise_name/#enterprise_name","title":"enterprise_name","text":"[jvm]\\ val enterprise_name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Team/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-team/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/","title":"Text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/#text","title":"Text","text":"[jvm]\\ data class Text@JvmOverloadsconstructor(val type: String, val text: String? = null, val emoji: Boolean? = null)
https://api.slack.com/reference/block-kit/composition-objects#text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/#constructors","title":"Constructors","text":"Text [jvm]@JvmOverloadsconstructor(type: String, text: String? = null, emoji: Boolean? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/#properties","title":"Properties","text":"Name Summary emoji [jvm]val emoji: Boolean? = nullThis must be null if type is \"mrkdwn\". text [jvm]val text: String? = null type [jvm]val type: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/-text/","title":"Text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/Text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/-text/#text","title":"Text","text":"[jvm]\\
@JvmOverloads
constructor(type: String, text: String? = null, emoji: Boolean? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/emoji/","title":"emoji - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/emoji
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/emoji/#emoji","title":"emoji","text":"[jvm]\\ val emoji: Boolean? = null
This must be null if type is \"mrkdwn\".
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/text/#text","title":"text","text":"[jvm]\\ val text: String? = null
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/type/","title":"type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Text/type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-text/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/","title":"User - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/#user","title":"User","text":"[jvm]\\ data class User(val id: String, val username: String, val name: String, val team_id: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/#constructors","title":"Constructors","text":"User [jvm]constructor(id: String, username: String, name: String, team_id: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/#properties","title":"Properties","text":"Name Summary id [jvm]val id: String name [jvm]val name: String team_id [jvm]val team_id: String username [jvm]val username: String"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/-user/","title":"User - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/User
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/-user/#user","title":"User","text":"[jvm]\\ constructor(id: String, username: String, name: String, team_id: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/name/","title":"name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/team_id/","title":"team_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/team_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/team_id/#team_id","title":"team_id","text":"[jvm]\\ val team_id: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/username/","title":"username - Misk","text":"//misk-slack/misk.slack.webapi.helpers/User/username
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user/username/#username","title":"username","text":"[jvm]\\ val username: String
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/","title":"UserData - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/#userdata","title":"UserData","text":"[jvm]\\ data class UserData@JvmOverloadsconstructor(val always_active: Boolean? = null, val color: String? = null, val deleted: Boolean? = null, val enterprise_user: EnterpriseUser? = null, val has_2fa: Boolean? = null, val id: String? = null, val is_admin: Boolean? = null, val is_app_user: Boolean? = null, val is_bot: Boolean? = null, val is_email_confirmed: Boolean? = null, val is_invited_user: Boolean? = null, val is_owner: Boolean? = null, val is_primary_owner: Boolean? = null, val is_restricted: Boolean? = null, val is_stranger: Boolean? = null, val is_ultra_restricted: Boolean? = null, val locale: String? = null, val name: String? = null, val profile: UserProfile? = null, val real_name: String? = null, val team_id: String? = null, val two_factor_type: String? = null, val tz: String? = null, val tz_label: String? = null, val tz_offset: Int? = null, val updated: Int? = null)
A user object contains information about a Slack workspace user. The composition of user objects can vary greatly depending on the API being used, or the context of each Slack workspace. Data that has not been supplied may not be present at all, may be null, or may contain an empty string.
https://api.slack.com/types/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/#constructors","title":"Constructors","text":"UserData [jvm]@JvmOverloadsconstructor(always_active: Boolean? = null, color: String? = null, deleted: Boolean? = null, enterprise_user: EnterpriseUser? = null, has_2fa: Boolean? = null, id: String? = null, is_admin: Boolean? = null, is_app_user: Boolean? = null, is_bot: Boolean? = null, is_email_confirmed: Boolean? = null, is_invited_user: Boolean? = null, is_owner: Boolean? = null, is_primary_owner: Boolean? = null, is_restricted: Boolean? = null, is_stranger: Boolean? = null, is_ultra_restricted: Boolean? = null, locale: String? = null, name: String? = null, profile: UserProfile? = null, real_name: String? = null, team_id: String? = null, two_factor_type: String? = null, tz: String? = null, tz_label: String? = null, tz_offset: Int? = null, updated: Int? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/#properties","title":"Properties","text":"Name Summary always_active [jvm]val always_active: Boolean? = nullIndicates that a bot user is set to be constantly active in presence status. color [jvm]val color: String? = nullUsed in some clients to display a special username color. deleted [jvm]val deleted: Boolean? = nullThis user has been deactivated when the value of this field is true. Otherwise, the value is false, or the field may not appear at all. enterprise_user [jvm]val enterprise_user: EnterpriseUser? = nullAn object containing info related to an Enterprise Grid user. has_2fa [jvm]val has_2fa: Boolean? = nullDescribes whether two-factor authentication is enabled for this user. Only visible if the user executing the call is an admin. id [jvm]val id: String? = nullIdentifier for this workspace user. It is unique to the workspace containing the user. Use this field together with team_id as a unique key when storing related data or when specifying the user in API requests. We recommend considering the format of the string to be an opaque value, and not to rely on a particular structure. is_admin [jvm]val is_admin: Boolean? = nullIndicates whether the user is an Admin of the current workspace. is_app_user [jvm]val is_app_user: Boolean? = nullIndicates whether the user is an authorized user of the calling app. is_bot [jvm]val is_bot: Boolean? = nullIndicates whether the user is actually a bot user. Bleep bloop. Note that Slackbot is special, so is_bot will be false for it. is_email_confirmed [jvm]val is_email_confirmed: Boolean? = nullIndicates whether the user email has been confirmed. is_invited_user [jvm]val is_invited_user: Boolean? = nullOnly present (and always true) when a user has been invited but has not yet signed in. Once the user signs in, this field is no longer present. is_owner [jvm]val is_owner: Boolean? = nullIndicates whether the user is an Owner of the current workspace. is_primary_owner [jvm]val is_primary_owner: Boolean? = nullIndicates whether the user is the Primary Owner of the current workspace. is_restricted [jvm]val is_restricted: Boolean? = nullIndicates whether the user is a guest user. Use in combination with the is_ultra_restricted field to check if the user is a single-channel guest user. is_stranger [jvm]val is_stranger: Boolean? = nullIf true, this user belongs to a different workspace than the one associated with your app\u2019s token, and isn\u2019t in any shared channels visible to your app. If false (or this field is not present), the user is either from the same workspace as associated with your app\u2019s token, or they are from a different workspace, but are in a shared channel that your app has access to. Read our shared channels docs for more detail. is_ultra_restricted [jvm]val is_ultra_restricted: Boolean? = nullIndicates whether the user is a single-channel guest. locale [jvm]val locale: String? = nullContains an IETF language code that represents this user\u2019s chosen display language for Slack clients. Useful for localizing your apps. name [jvm]val name: String? = nullDon\u2019t use this. It once indicated the preferred username for a user, but that behavior has fundamentally changed since. profile [jvm]val profile: UserProfile? = nullThe profile object contains the default fields of a user\u2019s workspace profile. A user\u2019s custom profile fields may be discovered using users.profile.get. real_name [jvm]val real_name: String? = nullThe user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared. team_id [jvm]val team_id: String? = nullThe ID of the team the user is on. two_factor_type [jvm]val two_factor_type: String? = nullIndicates the type of two-factor authentication in use. Only present if has_2fa is true. The value will be either app or sms. tz [jvm]val tz: String? = nullA human-readable string for the geographic timezone-related region this user has specified in their account. tz_label [jvm]val tz_label: String? = nullDescribes the commonly used name of the tz timezone. tz_offset [jvm]val tz_offset: Int? = nullIndicates the number of seconds to offset UTC time by for this user\u2019s tz. Changes silently if changed due to daylight savings. updated [jvm]val updated: Int? = nullA Unix timestamp indicating when the user object was last updated."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/-user-data/","title":"UserData - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/UserData
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/-user-data/#userdata","title":"UserData","text":"[jvm]\\
@JvmOverloads
constructor(always_active: Boolean? = null, color: String? = null, deleted: Boolean? = null, enterprise_user: EnterpriseUser? = null, has_2fa: Boolean? = null, id: String? = null, is_admin: Boolean? = null, is_app_user: Boolean? = null, is_bot: Boolean? = null, is_email_confirmed: Boolean? = null, is_invited_user: Boolean? = null, is_owner: Boolean? = null, is_primary_owner: Boolean? = null, is_restricted: Boolean? = null, is_stranger: Boolean? = null, is_ultra_restricted: Boolean? = null, locale: String? = null, name: String? = null, profile: UserProfile? = null, real_name: String? = null, team_id: String? = null, two_factor_type: String? = null, tz: String? = null, tz_label: String? = null, tz_offset: Int? = null, updated: Int? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/always_active/","title":"always_active - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/always_active
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/always_active/#always_active","title":"always_active","text":"[jvm]\\ val always_active: Boolean? = null
Indicates that a bot user is set to be constantly active in presence status.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/color/","title":"color - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/color
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/color/#color","title":"color","text":"[jvm]\\ val color: String? = null
Used in some clients to display a special username color.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/deleted/","title":"deleted - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/deleted
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/deleted/#deleted","title":"deleted","text":"[jvm]\\ val deleted: Boolean? = null
This user has been deactivated when the value of this field is true. Otherwise, the value is false, or the field may not appear at all.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/enterprise_user/","title":"enterprise_user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/enterprise_user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/enterprise_user/#enterprise_user","title":"enterprise_user","text":"[jvm]\\ val enterprise_user: EnterpriseUser? = null
An object containing info related to an Enterprise Grid user.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/has_2fa/","title":"has_2fa - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/has_2fa
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/has_2fa/#has_2fa","title":"has_2fa","text":"[jvm]\\ val has_2fa: Boolean? = null
Describes whether two-factor authentication is enabled for this user. Only visible if the user executing the call is an admin.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/id/","title":"id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/id/#id","title":"id","text":"[jvm]\\ val id: String? = null
Identifier for this workspace user. It is unique to the workspace containing the user. Use this field together with team_id as a unique key when storing related data or when specifying the user in API requests. We recommend considering the format of the string to be an opaque value, and not to rely on a particular structure.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_admin/","title":"is_admin - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_admin
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_admin/#is_admin","title":"is_admin","text":"[jvm]\\ val is_admin: Boolean? = null
Indicates whether the user is an Admin of the current workspace.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_app_user/","title":"is_app_user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_app_user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_app_user/#is_app_user","title":"is_app_user","text":"[jvm]\\ val is_app_user: Boolean? = null
Indicates whether the user is an authorized user of the calling app.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_bot/","title":"is_bot - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_bot
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_bot/#is_bot","title":"is_bot","text":"[jvm]\\ val is_bot: Boolean? = null
Indicates whether the user is actually a bot user. Bleep bloop. Note that Slackbot is special, so is_bot will be false for it.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_email_confirmed/","title":"is_email_confirmed - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_email_confirmed
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_email_confirmed/#is_email_confirmed","title":"is_email_confirmed","text":"[jvm]\\ val is_email_confirmed: Boolean? = null
Indicates whether the user email has been confirmed.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_invited_user/","title":"is_invited_user - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_invited_user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_invited_user/#is_invited_user","title":"is_invited_user","text":"[jvm]\\ val is_invited_user: Boolean? = null
Only present (and always true) when a user has been invited but has not yet signed in. Once the user signs in, this field is no longer present.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_owner/","title":"is_owner - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_owner
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_owner/#is_owner","title":"is_owner","text":"[jvm]\\ val is_owner: Boolean? = null
Indicates whether the user is an Owner of the current workspace.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_primary_owner/","title":"is_primary_owner - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_primary_owner
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_primary_owner/#is_primary_owner","title":"is_primary_owner","text":"[jvm]\\ val is_primary_owner: Boolean? = null
Indicates whether the user is the Primary Owner of the current workspace.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_restricted/","title":"is_restricted - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_restricted
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_restricted/#is_restricted","title":"is_restricted","text":"[jvm]\\ val is_restricted: Boolean? = null
Indicates whether the user is a guest user. Use in combination with the is_ultra_restricted field to check if the user is a single-channel guest user.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_stranger/","title":"is_stranger - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_stranger
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_stranger/#is_stranger","title":"is_stranger","text":"[jvm]\\ val is_stranger: Boolean? = null
If true, this user belongs to a different workspace than the one associated with your app\u2019s token, and isn\u2019t in any shared channels visible to your app. If false (or this field is not present), the user is either from the same workspace as associated with your app\u2019s token, or they are from a different workspace, but are in a shared channel that your app has access to. Read our shared channels docs for more detail.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_ultra_restricted/","title":"is_ultra_restricted - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/is_ultra_restricted
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/is_ultra_restricted/#is_ultra_restricted","title":"is_ultra_restricted","text":"[jvm]\\ val is_ultra_restricted: Boolean? = null
Indicates whether the user is a single-channel guest.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/locale/","title":"locale - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/locale
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/locale/#locale","title":"locale","text":"[jvm]\\ val locale: String? = null
Contains an IETF language code that represents this user\u2019s chosen display language for Slack clients. Useful for localizing your apps.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/name/","title":"name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/name/#name","title":"name","text":"[jvm]\\ val name: String? = null
Don\u2019t use this. It once indicated the preferred username for a user, but that behavior has fundamentally changed since.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/profile/","title":"profile - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/profile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/profile/#profile","title":"profile","text":"[jvm]\\ val profile: UserProfile? = null
The profile object contains the default fields of a user\u2019s workspace profile. A user\u2019s custom profile fields may be discovered using users.profile.get.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/real_name/","title":"real_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/real_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/real_name/#real_name","title":"real_name","text":"[jvm]\\ val real_name: String? = null
The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/team_id/","title":"team_id - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/team_id
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/team_id/#team_id","title":"team_id","text":"[jvm]\\ val team_id: String? = null
The ID of the team the user is on.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/two_factor_type/","title":"two_factor_type - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/two_factor_type
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/two_factor_type/#two_factor_type","title":"two_factor_type","text":"[jvm]\\ val two_factor_type: String? = null
Indicates the type of two-factor authentication in use. Only present if has_2fa is true. The value will be either app or sms.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz/","title":"tz - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/tz
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz/#tz","title":"tz","text":"[jvm]\\ val tz: String? = null
A human-readable string for the geographic timezone-related region this user has specified in their account.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_label/","title":"tz_label - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/tz_label
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_label/#tz_label","title":"tz_label","text":"[jvm]\\ val tz_label: String? = null
Describes the commonly used name of the tz timezone.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_offset/","title":"tz_offset - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/tz_offset
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/tz_offset/#tz_offset","title":"tz_offset","text":"[jvm]\\ val tz_offset: Int? = null
Indicates the number of seconds to offset UTC time by for this user\u2019s tz. Changes silently if changed due to daylight savings.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/updated/","title":"updated - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserData/updated
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-data/updated/#updated","title":"updated","text":"[jvm]\\ val updated: Int? = null
A Unix timestamp indicating when the user object was last updated.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/","title":"Index","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/#userprofile","title":"UserProfile","text":"[jvm]\\ data class UserProfile@JvmOverloadsconstructor(val avatar_hash: String? = null, val display_name: String? = null, val display_name_normalized: String? = null, val email: String? = null, val fields: UserProfileFields? = null, val first_name: String? = null, val image_24: String? = null, val image_32: String? = null, val image_48: String? = null, val image_72: String? = null, val image_192: String? = null, val image_512: String? = null, val last_name: String? = null, val phone: String? = null, val pronouns: String? = null, val real_name: String? = null, val real_name_normalized: String? = null, val skype: String? = null, val start_date: String? = null, val status_emoji: String? = null, val status_expiration: Int? = null, val status_text: String? = null, val team: String? = null, val title: String? = null)
A user object contains information about a Slack workspace user.
https://api.slack.com/types/user
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/#constructors","title":"Constructors","text":"UserProfile [jvm]@JvmOverloadsconstructor(avatar_hash: String? = null, display_name: String? = null, display_name_normalized: String? = null, email: String? = null, fields: UserProfileFields? = null, first_name: String? = null, image_24: String? = null, image_32: String? = null, image_48: String? = null, image_72: String? = null, image_192: String? = null, image_512: String? = null, last_name: String? = null, phone: String? = null, pronouns: String? = null, real_name: String? = null, real_name_normalized: String? = null, skype: String? = null, start_date: String? = null, status_emoji: String? = null, status_expiration: Int? = null, status_text: String? = null, team: String? = null, title: String? = null)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/#properties","title":"Properties","text":"Name Summary avatar_hash [jvm]val avatar_hash: String? = nullThe hash identifier for the user\u2019s avatar image. display_name [jvm]val display_name: String? = nullThe display name the user has chosen to identify themselves by in their workspace profile. Do not use this field as a unique identifier for a user, as it may change at any time. Instead, use id and team_id in concert. display_name_normalized [jvm]val display_name_normalized: String? = nullThe display_name field, but with any non-Latin characters filtered out. email [jvm]val email: String? = nullA valid email address for the user. It cannot have spaces and must have an @ and a domain. It cannot be in use by another member of the same team. Changing a user\u2019s email address will send an email to both the old and new addresses and post a slackbot to the user informing them of the change. This field can only be changed by admins for users on paid teams. fields [jvm]val fields: UserProfileFields? = nullAll the custom profile fields for the user. first_name [jvm]val first_name: String? = nullThe user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name. image_192 [jvm]val image_192: String? = nullURL pointing to a 192x192 pixel image representing the user\u2019s profile picture. image_24 [jvm]val image_24: String? = nullURL pointing to a 24x24 pixel image representing the user\u2019s profile picture. image_32 [jvm]val image_32: String? = nullURL pointing to a 32x32 pixel image representing the user\u2019s profile picture. image_48 [jvm]val image_48: String? = nullURL pointing to a 48x48 pixel image representing the user\u2019s profile picture. image_512 [jvm]val image_512: String? = nullURL pointing to a 512x512 pixel image representing the user\u2019s profile picture. image_72 [jvm]val image_72: String? = nullURL pointing to a 72x72 pixel image representing the user\u2019s profile picture. last_name [jvm]val last_name: String? = nullThe user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name. phone [jvm]val phone: String? = nullThe user\u2019s phone number, in any format. pronouns [jvm]val pronouns: String? = nullThe pronouns the user prefers to be addressed by. real_name [jvm]val real_name: String? = nullThe user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared. real_name_normalized [jvm]val real_name_normalized: String? = nullThe real_name field, but with any non-Latin characters filtered out. skype [jvm]val skype: String? = nullA shadow from a bygone era. It will always be an empty string and cannot be set otherwise. start_date [jvm]val start_date: String? = nullThe date the person joined the organization. Only available if Slack Atlas is enabled. status_emoji [jvm]val status_emoji: String? = nullThe displayed emoji that is enabled for the Slack team, such as \":train:\". status_expiration [jvm]val status_expiration: Int? = nullThe Unix timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire. status_text [jvm]val status_text: String? = nullThe displayed text of up to 100 characters. We strongly encourage brevity. team [jvm]val team: String? = nullThe ID of the team the user is on. title [jvm]val title: String? = nullThe user\u2019s title."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/-user-profile/","title":"user profile","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/UserProfile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/-user-profile/#userprofile","title":"UserProfile","text":"[jvm]\\
@JvmOverloads
constructor(avatar_hash: String? = null, display_name: String? = null, display_name_normalized: String? = null, email: String? = null, fields: UserProfileFields? = null, first_name: String? = null, image_24: String? = null, image_32: String? = null, image_48: String? = null, image_72: String? = null, image_192: String? = null, image_512: String? = null, last_name: String? = null, phone: String? = null, pronouns: String? = null, real_name: String? = null, real_name_normalized: String? = null, skype: String? = null, start_date: String? = null, status_emoji: String? = null, status_expiration: Int? = null, status_text: String? = null, team: String? = null, title: String? = null)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/avatar_hash/","title":"avatar_hash - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/avatar_hash
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/avatar_hash/#avatar_hash","title":"avatar_hash","text":"[jvm]\\ val avatar_hash: String? = null
The hash identifier for the user\u2019s avatar image.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name/","title":"display_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/display_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name/#display_name","title":"display_name","text":"[jvm]\\ val display_name: String? = null
The display name the user has chosen to identify themselves by in their workspace profile. Do not use this field as a unique identifier for a user, as it may change at any time. Instead, use id and team_id in concert.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name_normalized/","title":"display_name_normalized - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/display_name_normalized
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/display_name_normalized/#display_name_normalized","title":"display_name_normalized","text":"[jvm]\\ val display_name_normalized: String? = null
The display_name field, but with any non-Latin characters filtered out.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/email/","title":"email - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/email
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/email/#email","title":"email","text":"[jvm]\\ val email: String? = null
A valid email address for the user. It cannot have spaces and must have an @ and a domain. It cannot be in use by another member of the same team. Changing a user\u2019s email address will send an email to both the old and new addresses and post a slackbot to the user informing them of the change. This field can only be changed by admins for users on paid teams.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/fields/","title":"fields - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/fields
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/fields/#fields","title":"fields","text":"[jvm]\\ val fields: UserProfileFields? = null
All the custom profile fields for the user.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/first_name/","title":"first_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/first_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/first_name/#first_name","title":"first_name","text":"[jvm]\\ val first_name: String? = null
The user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_192/","title":"image_192 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_192
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_192/#image_192","title":"image_192","text":"[jvm]\\ val image_192: String? = null
URL pointing to a 192x192 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_24/","title":"image_24 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_24
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_24/#image_24","title":"image_24","text":"[jvm]\\ val image_24: String? = null
URL pointing to a 24x24 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_32/","title":"image_32 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_32
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_32/#image_32","title":"image_32","text":"[jvm]\\ val image_32: String? = null
URL pointing to a 32x32 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_48/","title":"image_48 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_48
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_48/#image_48","title":"image_48","text":"[jvm]\\ val image_48: String? = null
URL pointing to a 48x48 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_512/","title":"image_512 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_512
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_512/#image_512","title":"image_512","text":"[jvm]\\ val image_512: String? = null
URL pointing to a 512x512 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_72/","title":"image_72 - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/image_72
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/image_72/#image_72","title":"image_72","text":"[jvm]\\ val image_72: String? = null
URL pointing to a 72x72 pixel image representing the user\u2019s profile picture.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/last_name/","title":"last_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/last_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/last_name/#last_name","title":"last_name","text":"[jvm]\\ val last_name: String? = null
The user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/phone/","title":"phone - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/phone
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/phone/#phone","title":"phone","text":"[jvm]\\ val phone: String? = null
The user\u2019s phone number, in any format.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/pronouns/","title":"pronouns - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/pronouns
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/pronouns/#pronouns","title":"pronouns","text":"[jvm]\\ val pronouns: String? = null
The pronouns the user prefers to be addressed by.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name/","title":"real_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/real_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name/#real_name","title":"real_name","text":"[jvm]\\ val real_name: String? = null
The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name_normalized/","title":"real_name_normalized - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/real_name_normalized
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/real_name_normalized/#real_name_normalized","title":"real_name_normalized","text":"[jvm]\\ val real_name_normalized: String? = null
The real_name field, but with any non-Latin characters filtered out.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/skype/","title":"skype - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/skype
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/skype/#skype","title":"skype","text":"[jvm]\\ val skype: String? = null
A shadow from a bygone era. It will always be an empty string and cannot be set otherwise.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/start_date/","title":"start_date - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/start_date
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/start_date/#start_date","title":"start_date","text":"[jvm]\\ val start_date: String? = null
The date the person joined the organization. Only available if Slack Atlas is enabled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_emoji/","title":"status_emoji - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/status_emoji
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_emoji/#status_emoji","title":"status_emoji","text":"[jvm]\\ val status_emoji: String? = null
The displayed emoji that is enabled for the Slack team, such as \":train:\".
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_expiration/","title":"status_expiration - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/status_expiration
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_expiration/#status_expiration","title":"status_expiration","text":"[jvm]\\ val status_expiration: Int? = null
The Unix timestamp of when the status will expire. Providing 0 or omitting this field results in a custom status that will not expire.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_text/","title":"status_text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/status_text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/status_text/#status_text","title":"status_text","text":"[jvm]\\ val status_text: String? = null
The displayed text of up to 100 characters. We strongly encourage brevity.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/team/","title":"team - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/team
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/team/#team","title":"team","text":"[jvm]\\ val team: String? = null
The ID of the team the user is on.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/title/","title":"title - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfile/title
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile/title/#title","title":"title","text":"[jvm]\\ val title: String? = null
The user\u2019s title.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/","title":"Index","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/#userprofilefields","title":"UserProfileFields","text":"[jvm]\\ data class UserProfileFields@JvmOverloadsconstructor(val display_name: String?, val email: String?, val first_name: String?, val last_name: String?, val phone: String?, val pronouns: String?, val real_name: String?, val start_date: String?, val title: String?)
The following fields are the default fields of a user\u2019s workspace profile.
https://api.slack.com/types/user#profile
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/#constructors","title":"Constructors","text":"UserProfileFields [jvm]@JvmOverloadsconstructor(display_name: String?, email: String?, first_name: String?, last_name: String?, phone: String?, pronouns: String?, real_name: String?, start_date: String?, title: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/#properties","title":"Properties","text":"Name Summary display_name [jvm]val display_name: String?The display name the user has chosen to identify themselves by in their workspace profile. email [jvm]val email: String?A valid email address. It cannot have spaces, or be in use by another member of the same team. It must have an @ and a domain. Changing a user\u2019s email address will send an email to both the old and new addresses, and also post a slackbot message to the user informing them of the change. You cannot update your own email using this method. This field can only be changed by admins for users on paid teams. first_name [jvm]val first_name: String?The user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name. last_name [jvm]val last_name: String?The user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name. phone [jvm]val phone: String?The user\u2019s phone number, in any format. pronouns [jvm]val pronouns: String?The user\u2019s pronouns. real_name [jvm]val real_name: String?The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared. start_date [jvm]val start_date: String?The date the person joined the organization. Only available if Slack Atlas is enabled. title [jvm]val title: String?The user\u2019s title."},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/-user-profile-fields/","title":"user profile fields","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/UserProfileFields
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/-user-profile-fields/#userprofilefields","title":"UserProfileFields","text":"[jvm]\\
@JvmOverloads
constructor(display_name: String?, email: String?, first_name: String?, last_name: String?, phone: String?, pronouns: String?, real_name: String?, start_date: String?, title: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/display_name/","title":"display_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/display_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/display_name/#display_name","title":"display_name","text":"[jvm]\\ val display_name: String?
The display name the user has chosen to identify themselves by in their workspace profile.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/email/","title":"email - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/email
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/email/#email","title":"email","text":"[jvm]\\ val email: String?
A valid email address. It cannot have spaces, or be in use by another member of the same team. It must have an @ and a domain. Changing a user\u2019s email address will send an email to both the old and new addresses, and also post a slackbot message to the user informing them of the change. You cannot update your own email using this method. This field can only be changed by admins for users on paid teams.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/first_name/","title":"first_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/first_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/first_name/#first_name","title":"first_name","text":"[jvm]\\ val first_name: String?
The user\u2019s first name. The name \"slackbot\" cannot be used. Updating first_name will update the first name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/last_name/","title":"last_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/last_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/last_name/#last_name","title":"last_name","text":"[jvm]\\ val last_name: String?
The user\u2019s last name. The name \"slackbot\" cannot be used. Updating last_name will update the second name within real_name.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/phone/","title":"phone - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/phone
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/phone/#phone","title":"phone","text":"[jvm]\\ val phone: String?
The user\u2019s phone number, in any format.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/pronouns/","title":"pronouns - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/pronouns
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/pronouns/#pronouns","title":"pronouns","text":"[jvm]\\ val pronouns: String?
The user\u2019s pronouns.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/real_name/","title":"real_name - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/real_name
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/real_name/#real_name","title":"real_name","text":"[jvm]\\ val real_name: String?
The user\u2019s first and last name. Updating this field will update first_name and last_name. If only one name is provided, the value of last_name will be cleared.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/start_date/","title":"start_date - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/start_date
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/start_date/#start_date","title":"start_date","text":"[jvm]\\ val start_date: String?
The date the person joined the organization. Only available if Slack Atlas is enabled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/title/","title":"title - Misk","text":"//misk-slack/misk.slack.webapi.helpers/UserProfileFields/title
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-user-profile-fields/title/#title","title":"title","text":"[jvm]\\ val title: String?
The user\u2019s title.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/","title":"Values - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/#values","title":"Values","text":"[jvm]\\ data class Values(val text: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/#constructors","title":"Constructors","text":"Values [jvm]constructor(text: String?)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/#properties","title":"Properties","text":"Name Summary text [jvm]val text: String?"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/-values/","title":"Values - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Values/Values
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/-values/#values","title":"Values","text":"[jvm]\\ constructor(text: String?)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/text/","title":"text - Misk","text":"//misk-slack/misk.slack.webapi.helpers/Values/text
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.helpers/-values/text/#text","title":"text","text":"[jvm]\\ val text: String?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack.webapi.interceptors
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/#types","title":"Types","text":"Name Summary SlackClientInterceptor [jvm]@Singletonclass SlackClientInterceptor@Injectconstructor(val config: SlackConfig) : Interceptor SlackSignedRequestsInterceptor [jvm]@Singletonclass SlackSignedRequestsInterceptor@Injectconstructor(clock: Clock, slackConfig: SlackConfig) : NetworkInterceptor SlackSignedRequestsOnly [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])annotation class SlackSignedRequestsOnly"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/","title":"SlackClientInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#slackclientinterceptor","title":"SlackClientInterceptor","text":"[jvm]\\ @Singleton
class SlackClientInterceptor@Injectconstructor(val config: SlackConfig) : Interceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#constructors","title":"Constructors","text":"SlackClientInterceptor [jvm]@Injectconstructor(config: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#properties","title":"Properties","text":"Name Summary config [jvm]val config: SlackConfig"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: Interceptor.Chain): ResponseThe SlackClientInterceptor intercepts outgoing requests to Slack and chains the bearer token to the request. This token is provided by the Slack API when a Slack app is originally created. https://api.slack.com/web#url-encoded-bodies"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/-slack-client-interceptor/","title":"SlackClientInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor/SlackClientInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/-slack-client-interceptor/#slackclientinterceptor","title":"SlackClientInterceptor","text":"[jvm]\\
@Inject
constructor(config: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/config/","title":"config - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor/config
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/config/#config","title":"config","text":"[jvm]\\ val config: SlackConfig
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/intercept/","title":"intercept - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackClientInterceptor/intercept
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-client-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: Interceptor.Chain): Response
The SlackClientInterceptor intercepts outgoing requests to Slack and chains the bearer token to the request. This token is provided by the Slack API when a Slack app is originally created. https://api.slack.com/web#url-encoded-bodies
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/","title":"SlackSignedRequestsInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#slacksignedrequestsinterceptor","title":"SlackSignedRequestsInterceptor","text":"[jvm]\\ @Singleton
class SlackSignedRequestsInterceptor@Injectconstructor(clock: Clock, slackConfig: SlackConfig) : NetworkInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#constructors","title":"Constructors","text":"SlackSignedRequestsInterceptor [jvm]@Injectconstructor(clock: Clock, slackConfig: SlackConfig)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#types","title":"Types","text":"Name Summary Factory [jvm]@Singletonclass Factory@Injectconstructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor) : NetworkInterceptor.Factory"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/#functions","title":"Functions","text":"Name Summary intercept [jvm]open override fun intercept(chain: NetworkChain)The SlackSignedRequestsInterceptor verifies that the incoming request is authorized by using the signing secret provided from Slack and cross-checking it against slack\u2019s incoming header with a signature https://api.slack.com/authentication/verifying-requests-from-slack"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-slack-signed-requests-interceptor/","title":"SlackSignedRequestsInterceptor - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/SlackSignedRequestsInterceptor
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-slack-signed-requests-interceptor/#slacksignedrequestsinterceptor","title":"SlackSignedRequestsInterceptor","text":"[jvm]\\
@Inject
constructor(clock: Clock, slackConfig: SlackConfig)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/intercept/","title":"intercept - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/intercept
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/intercept/#intercept","title":"intercept","text":"[jvm]\\ open override fun intercept(chain: NetworkChain)
The SlackSignedRequestsInterceptor verifies that the incoming request is authorized by using the signing secret provided from Slack and cross-checking it against slack\u2019s incoming header with a signature https://api.slack.com/authentication/verifying-requests-from-slack
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/","title":"Factory - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/Factory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/#factory","title":"Factory","text":"[jvm]\\ @Singleton
class Factory@Injectconstructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor) : NetworkInterceptor.Factory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/#constructors","title":"Constructors","text":"Factory [jvm]@Injectconstructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/#functions","title":"Functions","text":"Name Summary create [jvm]open override fun create(action: Action): NetworkInterceptor?"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/-factory/","title":"Factory - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/Factory/Factory
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/-factory/#factory","title":"Factory","text":"[jvm]\\
@Inject
constructor(slackSignedRequestsInterceptor: SlackSignedRequestsInterceptor)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/create/","title":"create - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsInterceptor/Factory/create
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-interceptor/-factory/create/#create","title":"create","text":"[jvm]\\ open override fun create(action: Action): NetworkInterceptor?
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-only/","title":"SlackSignedRequestsOnly - Misk","text":"//misk-slack/misk.slack.webapi.interceptors/SlackSignedRequestsOnly
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.interceptors/-slack-signed-requests-only/#slacksignedrequestsonly","title":"SlackSignedRequestsOnly","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.CLASS])
annotation class SlackSignedRequestsOnly
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/","title":"Package-level declarations - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/#types","title":"Types","text":"Name Summary SlashCommandHandler [jvm]abstract class SlashCommandHandler(val slackApi: SlackApi)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/","title":"SlashCommandHandler - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#slashcommandhandler","title":"SlashCommandHandler","text":"[jvm]\\ abstract class SlashCommandHandler(val slackApi: SlackApi)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#constructors","title":"Constructors","text":"SlashCommandHandler [jvm]constructor(slackApi: SlackApi)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#properties","title":"Properties","text":"Name Summary slackApi [jvm]open val slackApi: SlackApi"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/#functions","title":"Functions","text":"Name Summary handle [jvm]abstract fun handle(slashCommandJson: SlashCommand): BooleanBusiness logic to handle the slash command sent from the user https://api.slack.com/interactivity/slash-commands Returns true if slashCommandJson was handled. sendSlackConfirmation [jvm]open fun sendSlackConfirmation(channelId: String, text: String, responseUrl: String)"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/-slash-command-handler/","title":"SlashCommandHandler - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/SlashCommandHandler
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/-slash-command-handler/#slashcommandhandler","title":"SlashCommandHandler","text":"[jvm]\\ constructor(slackApi: SlackApi)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/handle/","title":"handle - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/handle
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/handle/#handle","title":"handle","text":"[jvm]\\ abstract fun handle(slashCommandJson: SlashCommand): Boolean
Business logic to handle the slash command sent from the user https://api.slack.com/interactivity/slash-commands Returns true if slashCommandJson was handled.
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/send-slack-confirmation/","title":"sendSlackConfirmation - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/sendSlackConfirmation
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/send-slack-confirmation/#sendslackconfirmation","title":"sendSlackConfirmation","text":"[jvm]\\ open fun sendSlackConfirmation(channelId: String, text: String, responseUrl: String)
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/slack-api/","title":"slackApi - Misk","text":"//misk-slack/misk.slack.webapi.slashcommands/SlashCommandHandler/slackApi
"},{"location":"0.x/misk-slack/misk-slack/misk.slack.webapi.slashcommands/-slash-command-handler/slack-api/#slackapi","title":"slackApi","text":"[jvm]\\ open val slackApi: SlackApi
"},{"location":"0.x/misk-sqldelight/","title":"misk-sqldelight - Misk","text":"//misk-sqldelight
"},{"location":"0.x/misk-sqldelight/#misk-sqldelight","title":"misk-sqldelight","text":""},{"location":"0.x/misk-sqldelight/#packages","title":"Packages","text":"Name misk.sqldelight"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/","title":"Package-level declarations - Misk","text":"//misk-sqldelight/misk.sqldelight
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/#types","title":"Types","text":"Name Summary RetryingTransacter [jvm]abstract class RetryingTransacter@JvmOverloadsconstructor(delegate: Transacter, val options: TransacterOptions = TransacterOptions()) : Transacter TransacterOptions [jvm]data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val minRetryDelayMillis: Long = 100, val maxRetryDelayMillis: Long = 500, val retryJitterMillis: Long = 400)"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/","title":"RetryingTransacter - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#retryingtransacter","title":"RetryingTransacter","text":"[jvm]\\ abstract class RetryingTransacter@JvmOverloadsconstructor(delegate: Transacter, val options: TransacterOptions = TransacterOptions()) : Transacter
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#constructors","title":"Constructors","text":"RetryingTransacter [jvm]@JvmOverloadsconstructor(delegate: Transacter, options: TransacterOptions = TransacterOptions())"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#properties","title":"Properties","text":"Name Summary options [jvm]val options: TransacterOptions"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/#functions","title":"Functions","text":"Name Summary transaction [jvm]open override fun transaction(noEnclosing: Boolean, body: TransactionWithoutReturn.() -> Unit) transactionWithResult [jvm]open override fun <R> transactionWithResult(noEnclosing: Boolean, bodyWithReturn: TransactionWithReturn<R>.() -> R): R"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/-retrying-transacter/","title":"RetryingTransacter - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/RetryingTransacter
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/-retrying-transacter/#retryingtransacter","title":"RetryingTransacter","text":"[jvm]\\
@JvmOverloads
constructor(delegate: Transacter, options: TransacterOptions = TransacterOptions())
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/options/","title":"options - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/options
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/options/#options","title":"options","text":"[jvm]\\ val options: TransacterOptions
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction-with-result/","title":"transactionWithResult - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/transactionWithResult
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction-with-result/#transactionwithresult","title":"transactionWithResult","text":"[jvm]\\ open override fun <R> transactionWithResult(noEnclosing: Boolean, bodyWithReturn: TransactionWithReturn<R>.() -> R): R
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction/","title":"transaction - Misk","text":"//misk-sqldelight/misk.sqldelight/RetryingTransacter/transaction
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-retrying-transacter/transaction/#transaction","title":"transaction","text":"[jvm]\\ open override fun transaction(noEnclosing: Boolean, body: TransactionWithoutReturn.() -> Unit)
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\ data class TransacterOptions@JvmOverloadsconstructor(val maxAttempts: Int = 3, val minRetryDelayMillis: Long = 100, val maxRetryDelayMillis: Long = 500, val retryJitterMillis: Long = 400)
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/#constructors","title":"Constructors","text":"TransacterOptions [jvm]@JvmOverloadsconstructor(maxAttempts: Int = 3, minRetryDelayMillis: Long = 100, maxRetryDelayMillis: Long = 500, retryJitterMillis: Long = 400)"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/#properties","title":"Properties","text":"Name Summary maxAttempts [jvm]val maxAttempts: Int = 3 maxRetryDelayMillis [jvm]val maxRetryDelayMillis: Long = 500 minRetryDelayMillis [jvm]val minRetryDelayMillis: Long = 100 retryJitterMillis [jvm]val retryJitterMillis: Long = 400"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/-transacter-options/","title":"TransacterOptions - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/TransacterOptions
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/-transacter-options/#transacteroptions","title":"TransacterOptions","text":"[jvm]\\
@JvmOverloads
constructor(maxAttempts: Int = 3, minRetryDelayMillis: Long = 100, maxRetryDelayMillis: Long = 500, retryJitterMillis: Long = 400)
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-attempts/","title":"maxAttempts - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/maxAttempts
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-attempts/#maxattempts","title":"maxAttempts","text":"[jvm]\\ val maxAttempts: Int = 3
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-retry-delay-millis/","title":"maxRetryDelayMillis - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/maxRetryDelayMillis
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/max-retry-delay-millis/#maxretrydelaymillis","title":"maxRetryDelayMillis","text":"[jvm]\\ val maxRetryDelayMillis: Long = 500
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/min-retry-delay-millis/","title":"minRetryDelayMillis - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/minRetryDelayMillis
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/min-retry-delay-millis/#minretrydelaymillis","title":"minRetryDelayMillis","text":"[jvm]\\ val minRetryDelayMillis: Long = 100
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/retry-jitter-millis/","title":"retryJitterMillis - Misk","text":"//misk-sqldelight/misk.sqldelight/TransacterOptions/retryJitterMillis
"},{"location":"0.x/misk-sqldelight/misk-sqldelight/misk.sqldelight/-transacter-options/retry-jitter-millis/#retryjittermillis","title":"retryJitterMillis","text":"[jvm]\\ val retryJitterMillis: Long = 400
"},{"location":"0.x/misk-tailwind/","title":"misk-tailwind - Misk","text":"//misk-tailwind
"},{"location":"0.x/misk-tailwind/#misk-tailwind","title":"misk-tailwind","text":""},{"location":"0.x/misk-tailwind/#packages","title":"Packages","text":"Name misk.tailwind misk.tailwind.components misk.tailwind.icons misk.tailwind.pages"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/","title":"Index","text":"//misk-tailwind/misk.tailwind
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/#types","title":"Types","text":"Name Summary Link [jvm]data class Link@JvmOverloadsconstructor(val label: String, val href: String, val style: Style? = null, val isSelected: Boolean = false, val isPageNavigation: Boolean = false, val dataTurbo: Boolean? = true, val openInNewTab: Boolean = false, val rawHtml: String? = null, val hoverText: String? = null)Defines a link (such as for ) with configuration including for styles and Hotwire Turbo handling. Style [jvm]interface Style"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/#functions","title":"Functions","text":"Name Summary TailwindHtmlLayout [jvm]fun TagConsumer<>.TailwindHtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-tailwind-html-layout/","title":"tailwind html layout","text":"//misk-tailwind/misk.tailwind/TailwindHtmlLayout
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-tailwind-html-layout/#tailwindhtmllayout","title":"TailwindHtmlLayout","text":"[jvm]\\ fun TagConsumer<>.TailwindHtmlLayout(appRoot: String, title: String, playCdn: Boolean = false, appCssPath: String? = null, headBlock: TagConsumer<>.() -> Unit = {}, bodyBlock: TagConsumer<*>.() -> Unit)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/","title":"Link - Misk","text":"//misk-tailwind/misk.tailwind/Link
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/#link","title":"Link","text":"[jvm]\\ data class Link@JvmOverloadsconstructor(val label: String, val href: String, val style: Style? = null, val isSelected: Boolean = false, val isPageNavigation: Boolean = false, val dataTurbo: Boolean? = true, val openInNewTab: Boolean = false, val rawHtml: String? = null, val hoverText: String? = null)
Defines a link (such as for ) with configuration including for styles and Hotwire Turbo handling.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/#constructors","title":"Constructors","text":"Link [jvm]@JvmOverloadsconstructor(label: String, href: String, style: Style? = null, isSelected: Boolean = false, isPageNavigation: Boolean = false, dataTurbo: Boolean? = true, openInNewTab: Boolean = false, rawHtml: String? = null, hoverText: String? = null)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/#properties","title":"Properties","text":"Name Summary dataTurbo [jvm]val dataTurbo: Boolean? = truenull: default true: preload false: disabled hoverText [jvm]val hoverText: String? = null href [jvm]val href: String isPageNavigation [jvm]val isPageNavigation: Boolean = falseThis forces page navigation vs within Turbo Frame navigation by adding a target=\"_top\" attribute. isSelected [jvm]val isSelected: Boolean = false label [jvm]val label: String openInNewTab [jvm]val openInNewTab: Boolean = false rawHtml [jvm]val rawHtml: String? = null style [jvm]val style: Style? = null"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/-link/","title":"Link - Misk","text":"//misk-tailwind/misk.tailwind/Link/Link
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/-link/#link","title":"Link","text":"[jvm]\\
@JvmOverloads
constructor(label: String, href: String, style: Style? = null, isSelected: Boolean = false, isPageNavigation: Boolean = false, dataTurbo: Boolean? = true, openInNewTab: Boolean = false, rawHtml: String? = null, hoverText: String? = null)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/data-turbo/","title":"dataTurbo - Misk","text":"//misk-tailwind/misk.tailwind/Link/dataTurbo
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/data-turbo/#dataturbo","title":"dataTurbo","text":"[jvm]\\ val dataTurbo: Boolean? = true
null: default true: preload false: disabled
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/hover-text/","title":"hoverText - Misk","text":"//misk-tailwind/misk.tailwind/Link/hoverText
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/hover-text/#hovertext","title":"hoverText","text":"[jvm]\\ val hoverText: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/href/","title":"href - Misk","text":"//misk-tailwind/misk.tailwind/Link/href
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/href/#href","title":"href","text":"[jvm]\\ val href: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-page-navigation/","title":"isPageNavigation - Misk","text":"//misk-tailwind/misk.tailwind/Link/isPageNavigation
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-page-navigation/#ispagenavigation","title":"isPageNavigation","text":"[jvm]\\ val isPageNavigation: Boolean = false
This forces page navigation vs within Turbo Frame navigation by adding a target=\"_top\" attribute.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-selected/","title":"isSelected - Misk","text":"//misk-tailwind/misk.tailwind/Link/isSelected
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/is-selected/#isselected","title":"isSelected","text":"[jvm]\\ val isSelected: Boolean = false
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/label/","title":"label - Misk","text":"//misk-tailwind/misk.tailwind/Link/label
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/label/#label","title":"label","text":"[jvm]\\ val label: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/open-in-new-tab/","title":"openInNewTab - Misk","text":"//misk-tailwind/misk.tailwind/Link/openInNewTab
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/open-in-new-tab/#openinnewtab","title":"openInNewTab","text":"[jvm]\\ val openInNewTab: Boolean = false
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/raw-html/","title":"rawHtml - Misk","text":"//misk-tailwind/misk.tailwind/Link/rawHtml
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/raw-html/#rawhtml","title":"rawHtml","text":"[jvm]\\ val rawHtml: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/style/","title":"style - Misk","text":"//misk-tailwind/misk.tailwind/Link/style
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-link/style/#style","title":"style","text":"[jvm]\\ val style: Style? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/","title":"Style - Misk","text":"//misk-tailwind/misk.tailwind/Style
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/#style","title":"Style","text":"[jvm]\\ interface Style
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/#properties","title":"Properties","text":"Name Summary classes [jvm]abstract val classes: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/classes/","title":"classes - Misk","text":"//misk-tailwind/misk.tailwind/Style/classes
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind/-style/classes/#classes","title":"classes","text":"[jvm]\\ abstract val classes: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/","title":"Package-level declarations - Misk","text":"//misk-tailwind/misk.tailwind.components
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/#types","title":"Types","text":"Name Summary AlertTheme [jvm]enum AlertTheme : Enum<AlertTheme>"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/#functions","title":"Functions","text":"Name Summary Alert [jvm]fun TagConsumer<*>.Alert(theme: AlertTheme, message: String?, label: String?, link: String?, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertError [jvm]fun TagConsumer<*>.AlertError(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertInfo [jvm]fun TagConsumer<*>.AlertInfo(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertInfoHighlight [jvm]fun TagConsumer<*>.AlertInfoHighlight(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) AlertMessage [jvm]fun TagConsumer<*>.AlertMessage(successMessage: String?, errorMessage: String?, label: String?, link: String?) AlertSuccess [jvm]fun TagConsumer<*>.AlertSuccess(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true) CodeBlock [jvm]fun TagConsumer<*>.CodeBlock(text: String) ToggleContainer [jvm]fun TagConsumer<>.ToggleContainer(buttonText: String, borderless: Boolean = false, menuBlock: TagConsumer<>.() -> Unit = {}, isOpen: Boolean = false, hiddenBlock: TagConsumer<*>.() -> Unit)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-error/","title":"AlertError - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertError
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-error/#alerterror","title":"AlertError","text":"[jvm]\\ fun TagConsumer<*>.AlertError(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info-highlight/","title":"AlertInfoHighlight - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertInfoHighlight
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info-highlight/#alertinfohighlight","title":"AlertInfoHighlight","text":"[jvm]\\ fun TagConsumer<*>.AlertInfoHighlight(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info/","title":"AlertInfo - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertInfo
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-info/#alertinfo","title":"AlertInfo","text":"[jvm]\\ fun TagConsumer<*>.AlertInfo(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-message/","title":"AlertMessage - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertMessage
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-message/#alertmessage","title":"AlertMessage","text":"[jvm]\\ fun TagConsumer<*>.AlertMessage(successMessage: String?, errorMessage: String?, label: String?, link: String?)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-success/","title":"AlertSuccess - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertSuccess
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-success/#alertsuccess","title":"AlertSuccess","text":"[jvm]\\ fun TagConsumer<*>.AlertSuccess(message: String?, label: String? = null, link: String? = null, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert/","title":"Alert - Misk","text":"//misk-tailwind/misk.tailwind.components/Alert
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert/#alert","title":"Alert","text":"[jvm]\\ fun TagConsumer<*>.Alert(theme: AlertTheme, message: String?, label: String?, link: String?, spaceAbove: Boolean = false, spaceBelow: Boolean = true)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-code-block/","title":"CodeBlock - Misk","text":"//misk-tailwind/misk.tailwind.components/CodeBlock
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-code-block/#codeblock","title":"CodeBlock","text":"[jvm]\\ fun TagConsumer<*>.CodeBlock(text: String)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-toggle-container/","title":"ToggleContainer - Misk","text":"//misk-tailwind/misk.tailwind.components/ToggleContainer
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-toggle-container/#togglecontainer","title":"ToggleContainer","text":"[jvm]\\ fun TagConsumer<>.ToggleContainer(buttonText: String, borderless: Boolean = false, menuBlock: TagConsumer<>.() -> Unit = {}, isOpen: Boolean = false, hiddenBlock: TagConsumer<*>.() -> Unit)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/","title":"AlertTheme - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#alerttheme","title":"AlertTheme","text":"[jvm]\\ enum AlertTheme : Enum<AlertTheme>
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#entries","title":"Entries","text":"BLUE_HIGHLIGHT [jvm]BLUE_HIGHLIGHT BLUE [jvm]BLUE GREEN [jvm]GREEN RED [jvm]RED"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String entries [jvm]val entries: EnumEntries<AlertTheme>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): AlertThemeReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<AlertTheme>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/background-color/","title":"backgroundColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/backgroundColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/background-color/#backgroundcolor","title":"backgroundColor","text":"[jvm]\\ val backgroundColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/entries/","title":"entries - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/entries
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<AlertTheme>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/heading-text-color/","title":"headingTextColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/headingTextColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/heading-text-color/#headingtextcolor","title":"headingTextColor","text":"[jvm]\\ val headingTextColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/hover-text-color/","title":"hoverTextColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/hoverTextColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/hover-text-color/#hovertextcolor","title":"hoverTextColor","text":"[jvm]\\ val hoverTextColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/icon-color/","title":"iconColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/iconColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/icon-color/#iconcolor","title":"iconColor","text":"[jvm]\\ val iconColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/text-color/","title":"textColor - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/textColor
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/text-color/#textcolor","title":"textColor","text":"[jvm]\\ val textColor: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/value-of/","title":"valueOf - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/valueOf
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): AlertTheme
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/values/","title":"values - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/values
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<AlertTheme>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e/","title":"BLUE - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/BLUE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e/#blue","title":"BLUE","text":"[jvm]\\ BLUE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e_-h-i-g-h-l-i-g-h-t/","title":"BLUE_HIGHLIGHT - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/BLUE_HIGHLIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e_-h-i-g-h-l-i-g-h-t/#blue_highlight","title":"BLUE_HIGHLIGHT","text":"[jvm]\\ BLUE_HIGHLIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-b-l-u-e_-h-i-g-h-l-i-g-h-t/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-g-r-e-e-n/","title":"GREEN - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/GREEN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-g-r-e-e-n/#green","title":"GREEN","text":"[jvm]\\ GREEN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-g-r-e-e-n/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-r-e-d/","title":"RED - Misk","text":"//misk-tailwind/misk.tailwind.components/AlertTheme/RED
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-r-e-d/#red","title":"RED","text":"[jvm]\\ RED
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.components/-alert-theme/-r-e-d/#properties","title":"Properties","text":"Name Summary backgroundColor [jvm]val backgroundColor: String headingTextColor [jvm]val headingTextColor: String hoverTextColor [jvm]val hoverTextColor: String iconColor [jvm]val iconColor: String name [jvm]val name: String ordinal [jvm]val ordinal: Int textColor [jvm]val textColor: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/","title":"Package-level declarations - Misk","text":"//misk-tailwind/misk.tailwind.icons
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/#types","title":"Types","text":"Name Summary HeroiconProps [jvm]data class HeroiconProps@JvmOverloadsconstructor(val icon: Heroicons, val modifierClass: String? = null, val spanClass: String? = null) Heroicons [jvm]enum Heroicons : Enum<Heroicons> Tailwind Heroicons Kotlin Bindings https://heroicons.com/"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/#functions","title":"Functions","text":"Name Summary heroicon [jvm]fun TagConsumer<*>.heroicon(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)kotlinx.html component to use the above Heroicons enum to inline SVG icons."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/heroicon/","title":"heroicon - Misk","text":"//misk-tailwind/misk.tailwind.icons/heroicon
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/heroicon/#heroicon","title":"heroicon","text":"[jvm]\\ fun TagConsumer<*>.heroicon(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)
kotlinx.html component to use the above Heroicons enum to inline SVG icons.
div {\n heroicon(Heroicons.MINI_CHEVRON_DOWN)\n heroicon(Heroicons.MINI_CHEVRON_DOWN, \"text-gray-400 group-hover:text-gray-500\")\n}\njvm
modifierClass override of the icon\u2019s defaultModifierClass. For example if icon should have a different color, boldness\u2026etc then a modifierClass can be provided which overrides the icon\u2019s defaultModifierClass."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/","title":"HeroiconProps - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/#heroiconprops","title":"HeroiconProps","text":"[jvm]\\ data class HeroiconProps@JvmOverloadsconstructor(val icon: Heroicons, val modifierClass: String? = null, val spanClass: String? = null)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/#constructors","title":"Constructors","text":"HeroiconProps [jvm]@JvmOverloadsconstructor(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/#properties","title":"Properties","text":"Name Summary icon [jvm]val icon: Heroicons modifierClass [jvm]val modifierClass: String? = null spanClass [jvm]val spanClass: String? = null"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/-heroicon-props/","title":"HeroiconProps - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/HeroiconProps
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/-heroicon-props/#heroiconprops","title":"HeroiconProps","text":"[jvm]\\
@JvmOverloads
constructor(icon: Heroicons, modifierClass: String? = null, spanClass: String? = null)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/icon/","title":"icon - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/icon
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/icon/#icon","title":"icon","text":"[jvm]\\ val icon: Heroicons
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/modifier-class/","title":"modifierClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/modifierClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/modifier-class/#modifierclass","title":"modifierClass","text":"[jvm]\\ val modifierClass: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/span-class/","title":"spanClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/HeroiconProps/spanClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicon-props/span-class/#spanclass","title":"spanClass","text":"[jvm]\\ val spanClass: String? = null
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/","title":"Heroicons - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#heroicons","title":"Heroicons","text":"[jvm]\\ enum Heroicons : Enum<Heroicons>
Tailwind Heroicons Kotlin Bindings https://heroicons.com/
Add any new icons as they are used.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#entries","title":"Entries","text":"OUTLINE_XMARK [jvm]OUTLINE_XMARK OUTLINE_HOME [jvm]OUTLINE_HOME OUTLINE_BARS_4 [jvm]OUTLINE_BARS_4 OUTLINE_CLOCK [jvm]OUTLINE_CLOCK OUTLINE_DOCUMENT_MAGNIFYING_GLASS [jvm]OUTLINE_DOCUMENT_MAGNIFYING_GLASS MINI_CHEVRON_UP_DOWN [jvm]MINI_CHEVRON_UP_DOWN QUEUE_LIST [jvm]QUEUE_LIST DOCUMENT_MAGNIFYING_GLASS [jvm]DOCUMENT_MAGNIFYING_GLASS BELL_ALERT [jvm]BELL_ALERT OUTLINE_BARS_3_CENTER_LEFT [jvm]OUTLINE_BARS_3_CENTER_LEFT MAGNIFYING_GLASS [jvm]MAGNIFYING_GLASS MINI_FUNNEL [jvm]MINI_FUNNEL MINI_CHEVRON_UP [jvm]MINI_CHEVRON_UP MINI_CHEVRON_DOWN [jvm]MINI_CHEVRON_DOWN MINI_ARROW_LONG_LEFT [jvm]MINI_ARROW_LONG_LEFT MINI_ARROW_LONG_RIGHT [jvm]MINI_ARROW_LONG_RIGHT MINI_ARROW_TOP_RIGHT_ON_SQUARE [jvm]MINI_ARROW_TOP_RIGHT_ON_SQUARE"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String entries [jvm]val entries: EnumEntries<Heroicons>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): HeroiconsReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Heroicons>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/default-modifier-class/","title":"defaultModifierClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/defaultModifierClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/default-modifier-class/#defaultmodifierclass","title":"defaultModifierClass","text":"[jvm]\\ val defaultModifierClass: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/entries/","title":"entries - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/entries
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Heroicons>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/id/","title":"id - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/id
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/id/#id","title":"id","text":"[jvm]\\ val id: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/raw-html/","title":"rawHtml - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/rawHtml
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/raw-html/#rawhtml","title":"rawHtml","text":"[jvm]\\ val rawHtml: (String) -> String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/svg-class/","title":"svgClass - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/svgClass
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/svg-class/#svgclass","title":"svgClass","text":"[jvm]\\ val svgClass: String
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/value-of/","title":"valueOf - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/valueOf
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Heroicons
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/values/","title":"values - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/values
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Heroicons>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-b-e-l-l_-a-l-e-r-t/","title":"BELL_ALERT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/BELL_ALERT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-b-e-l-l_-a-l-e-r-t/#bell_alert","title":"BELL_ALERT","text":"[jvm]\\ BELL_ALERT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-b-e-l-l_-a-l-e-r-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/","title":"DOCUMENT_MAGNIFYING_GLASS - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#document_magnifying_glass","title":"DOCUMENT_MAGNIFYING_GLASS","text":"[jvm]\\ DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/","title":"MAGNIFYING_GLASS - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#magnifying_glass","title":"MAGNIFYING_GLASS","text":"[jvm]\\ MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-l-e-f-t/","title":"MINI_ARROW_LONG_LEFT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_ARROW_LONG_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-l-e-f-t/#mini_arrow_long_left","title":"MINI_ARROW_LONG_LEFT","text":"[jvm]\\ MINI_ARROW_LONG_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-l-e-f-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-r-i-g-h-t/","title":"MINI_ARROW_LONG_RIGHT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_ARROW_LONG_RIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-r-i-g-h-t/#mini_arrow_long_right","title":"MINI_ARROW_LONG_RIGHT","text":"[jvm]\\ MINI_ARROW_LONG_RIGHT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-l-o-n-g_-r-i-g-h-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-t-o-p_-r-i-g-h-t_-o-n_-s-q-u-a-r-e/","title":"MINI_ARROW_TOP_RIGHT_ON_SQUARE - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_ARROW_TOP_RIGHT_ON_SQUARE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-t-o-p_-r-i-g-h-t_-o-n_-s-q-u-a-r-e/#mini_arrow_top_right_on_square","title":"MINI_ARROW_TOP_RIGHT_ON_SQUARE","text":"[jvm]\\ MINI_ARROW_TOP_RIGHT_ON_SQUARE
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-a-r-r-o-w_-t-o-p_-r-i-g-h-t_-o-n_-s-q-u-a-r-e/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-d-o-w-n/","title":"MINI_CHEVRON_DOWN - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_CHEVRON_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-d-o-w-n/#mini_chevron_down","title":"MINI_CHEVRON_DOWN","text":"[jvm]\\ MINI_CHEVRON_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-d-o-w-n/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p/","title":"MINI_CHEVRON_UP - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_CHEVRON_UP
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p/#mini_chevron_up","title":"MINI_CHEVRON_UP","text":"[jvm]\\ MINI_CHEVRON_UP
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p_-d-o-w-n/","title":"MINI_CHEVRON_UP_DOWN - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_CHEVRON_UP_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p_-d-o-w-n/#mini_chevron_up_down","title":"MINI_CHEVRON_UP_DOWN","text":"[jvm]\\ MINI_CHEVRON_UP_DOWN
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-c-h-e-v-r-o-n_-u-p_-d-o-w-n/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-f-u-n-n-e-l/","title":"MINI_FUNNEL - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/MINI_FUNNEL
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-f-u-n-n-e-l/#mini_funnel","title":"MINI_FUNNEL","text":"[jvm]\\ MINI_FUNNEL
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-m-i-n-i_-f-u-n-n-e-l/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_3_-c-e-n-t-e-r_-l-e-f-t/","title":"OUTLINE_BARS_3_CENTER_LEFT - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_BARS_3_CENTER_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_3_-c-e-n-t-e-r_-l-e-f-t/#outline_bars_3_center_left","title":"OUTLINE_BARS_3_CENTER_LEFT","text":"[jvm]\\ OUTLINE_BARS_3_CENTER_LEFT
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_3_-c-e-n-t-e-r_-l-e-f-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_4/","title":"OUTLINE_BARS_4 - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_BARS_4
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_4/#outline_bars_4","title":"OUTLINE_BARS_4","text":"[jvm]\\ OUTLINE_BARS_4
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-b-a-r-s_4/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-c-l-o-c-k/","title":"OUTLINE_CLOCK - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_CLOCK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-c-l-o-c-k/#outline_clock","title":"OUTLINE_CLOCK","text":"[jvm]\\ OUTLINE_CLOCK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-c-l-o-c-k/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/","title":"OUTLINE_DOCUMENT_MAGNIFYING_GLASS - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#outline_document_magnifying_glass","title":"OUTLINE_DOCUMENT_MAGNIFYING_GLASS","text":"[jvm]\\ OUTLINE_DOCUMENT_MAGNIFYING_GLASS
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-d-o-c-u-m-e-n-t_-m-a-g-n-i-f-y-i-n-g_-g-l-a-s-s/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-h-o-m-e/","title":"OUTLINE_HOME - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_HOME
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-h-o-m-e/#outline_home","title":"OUTLINE_HOME","text":"[jvm]\\ OUTLINE_HOME
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-h-o-m-e/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-x-m-a-r-k/","title":"OUTLINE_XMARK - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/OUTLINE_XMARK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-x-m-a-r-k/#outline_xmark","title":"OUTLINE_XMARK","text":"[jvm]\\ OUTLINE_XMARK
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-o-u-t-l-i-n-e_-x-m-a-r-k/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-q-u-e-u-e_-l-i-s-t/","title":"QUEUE_LIST - Misk","text":"//misk-tailwind/misk.tailwind.icons/Heroicons/QUEUE_LIST
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-q-u-e-u-e_-l-i-s-t/#queue_list","title":"QUEUE_LIST","text":"[jvm]\\ QUEUE_LIST
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.icons/-heroicons/-q-u-e-u-e_-l-i-s-t/#properties","title":"Properties","text":"Name Summary defaultModifierClass [jvm]val defaultModifierClass: String id [jvm]val id: String name [jvm]val name: String ordinal [jvm]val ordinal: Int rawHtml [jvm]val rawHtml: (String) -> String svgClass [jvm]val svgClass: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/","title":"Index","text":"//misk-tailwind/misk.tailwind.pages
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/#types","title":"Types","text":"Name Summary MenuSection [jvm]data class MenuSection(val title: String, val links: List<Link>)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/#functions","title":"Functions","text":"Name Summary Navbar [jvm]fun TagConsumer<>.Navbar(appName: String, deployment: Deployment, homeHref: String, menuSections: List<MenuSection> = listOf(), content: TagConsumer<>.() -> Unit = {})"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-navbar/","title":"Navbar - Misk","text":"//misk-tailwind/misk.tailwind.pages/Navbar
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-navbar/#navbar","title":"Navbar","text":"[jvm]\\ fun TagConsumer<>.Navbar(appName: String, deployment: Deployment, homeHref: String, menuSections: List<MenuSection> = listOf(), content: TagConsumer<>.() -> Unit = {})
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/","title":"Index","text":"//misk-tailwind/misk.tailwind.pages/MenuSection
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/#menusection","title":"MenuSection","text":"[jvm]\\ data class MenuSection(val title: String, val links: List<Link>)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/#constructors","title":"Constructors","text":"MenuSection [jvm]constructor(title: String, links: List<Link>)"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/#properties","title":"Properties","text":"Name Summary links [jvm]val links: List<Link> title [jvm]val title: String"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/-menu-section/","title":"menu section","text":"//misk-tailwind/misk.tailwind.pages/MenuSection/MenuSection
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/-menu-section/#menusection","title":"MenuSection","text":"[jvm]\\ constructor(title: String, links: List<Link>)
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/links/","title":"links - Misk","text":"//misk-tailwind/misk.tailwind.pages/MenuSection/links
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/links/#links","title":"links","text":"[jvm]\\ val links: List<Link>
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/title/","title":"title - Misk","text":"//misk-tailwind/misk.tailwind.pages/MenuSection/title
"},{"location":"0.x/misk-tailwind/misk-tailwind/misk.tailwind.pages/-menu-section/title/#title","title":"title","text":"[jvm]\\ val title: String
"},{"location":"0.x/misk-testing/","title":"misk-testing - Misk","text":"//misk-testing
"},{"location":"0.x/misk-testing/#misk-testing","title":"misk-testing","text":""},{"location":"0.x/misk-testing/#packages","title":"Packages","text":"Name misk misk.cloud.fake.security.keys misk.concurrent misk.containers misk.logging misk.mockito misk.random misk.service misk.services misk.testing misk.time misk.web org.assertj.core.api"},{"location":"0.x/misk-testing/misk-testing/misk/","title":"Package-level declarations - Misk","text":"//misk-testing/misk
"},{"location":"0.x/misk-testing/misk-testing/misk/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk/#types","title":"Types","text":"Name Summary MiskTestingServiceModule [jvm]class MiskTestingServiceModule : KAbstractModuleMiskTestingServiceModule should be installed in unit testing environments."},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/","title":"MiskTestingServiceModule - Misk","text":"//misk-testing/misk/MiskTestingServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/#misktestingservicemodule","title":"MiskTestingServiceModule","text":"[jvm]\\ class MiskTestingServiceModule : KAbstractModule
MiskTestingServiceModule should be installed in unit testing environments.
This should not contain application level fakes for testing. It includes a small, selective set of fake bindings to replace real bindings that cannot exist in a unit testing environment (e.g system env vars and filesystem dependencies).
"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/#constructors","title":"Constructors","text":"MiskTestingServiceModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/-misk-testing-service-module/","title":"MiskTestingServiceModule - Misk","text":"//misk-testing/misk/MiskTestingServiceModule/MiskTestingServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk/-misk-testing-service-module/-misk-testing-service-module/#misktestingservicemodule","title":"MiskTestingServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.cloud.fake.security.keys
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/#types","title":"Types","text":"Name Summary FakeKeyManagementModule [jvm]class FakeKeyManagementModule : KAbstractModule FakeKeyService [jvm]class FakeKeyService : KeyService"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/","title":"FakeKeyManagementModule - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyManagementModule
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/#fakekeymanagementmodule","title":"FakeKeyManagementModule","text":"[jvm]\\ class FakeKeyManagementModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/#constructors","title":"Constructors","text":"FakeKeyManagementModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/-fake-key-management-module/","title":"FakeKeyManagementModule - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyManagementModule/FakeKeyManagementModule
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-management-module/-fake-key-management-module/#fakekeymanagementmodule","title":"FakeKeyManagementModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/","title":"FakeKeyService - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/#fakekeyservice","title":"FakeKeyService","text":"[jvm]\\ class FakeKeyService : KeyService
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/#constructors","title":"Constructors","text":"FakeKeyService [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/#functions","title":"Functions","text":"Name Summary decrypt [jvm]open override fun decrypt(keyAlias: String, cipherText: ByteString): ByteString encrypt [jvm]open override fun encrypt(keyAlias: String, plainText: ByteString): ByteString"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/-fake-key-service/","title":"FakeKeyService - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService/FakeKeyService
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/-fake-key-service/#fakekeyservice","title":"FakeKeyService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/decrypt/","title":"decrypt - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService/decrypt
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/decrypt/#decrypt","title":"decrypt","text":"[jvm]\\ open override fun decrypt(keyAlias: String, cipherText: ByteString): ByteString
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/encrypt/","title":"encrypt - Misk","text":"//misk-testing/misk.cloud.fake.security.keys/FakeKeyService/encrypt
"},{"location":"0.x/misk-testing/misk-testing/misk.cloud.fake.security.keys/-fake-key-service/encrypt/#encrypt","title":"encrypt","text":"[jvm]\\ open override fun encrypt(keyAlias: String, plainText: ByteString): ByteString
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.concurrent
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/#types","title":"Types","text":"Name Summary FakeScheduledExecutorService [jvm]@Singletonclass FakeScheduledExecutorService@Injectconstructor(clock: Clock) : ScheduledExecutorService, ExecutorServiceScheduledExecutorService for testing that runs in the current thread and is triggered using thetick() method. An injected Clock is used to decide whether to execute a scheduled task. FakeSleeper [jvm]@Singletonclass FakeSleeper@Injectconstructor(clock: Clock) : SleeperSleeper for testing that blocks threads calling sleep, and checks whether the threads should wake using the tick() method. An injected Clock is used to decide whether to wake a thread. FakeSleeperModule [jvm]class FakeSleeperModule : KAbstractModule FakeTicker [jvm]@Singletonclass FakeTicker@Injectconstructor : Ticker, Sleeper"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/","title":"FakeScheduledExecutorService - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#fakescheduledexecutorservice","title":"FakeScheduledExecutorService","text":"[jvm]\\ @Singleton
class FakeScheduledExecutorService@Injectconstructor(clock: Clock) : ScheduledExecutorService, ExecutorService
ScheduledExecutorService for testing that runs in the current thread and is triggered using the tick() method. An injected Clock is used to decide whether to execute a scheduled task.
This service must always \"catch up\" to the clock, so fixed rate and fixed delay jobs are not different.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#constructors","title":"Constructors","text":"FakeScheduledExecutorService [jvm]@Injectconstructor(clock: Clock)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#types","title":"Types","text":"Name Summary ScheduledFutureTask [jvm]inner class ScheduledFutureTask<V>(var executeAt: Long, fixedDelay: Long, val clock: Clock, val task: () -> V) : FutureTask<V> , ScheduledFuture<V>"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/#functions","title":"Functions","text":"Name Summary awaitTermination [jvm]open override fun awaitTermination(p0: Long, p1: TimeUnit): Boolean execute [jvm]open override fun execute(p0: Runnable) invokeAll [jvm]open override fun <T : Any> invokeAll(p0: MutableCollection<out Callable<T>>): MutableList<Future<T>>open override fun <T : Any> invokeAll(p0: MutableCollection<out Callable<T>>, p1: Long, p2: TimeUnit): MutableList<Future<T>> invokeAny [jvm]open override fun <T : Any> invokeAny(p0: MutableCollection<out Callable<T>>): Topen override fun <T : Any> invokeAny(p0: MutableCollection<out Callable<T>>, p1: Long, p2: TimeUnit): T isShutdown [jvm]open override fun isShutdown(): Boolean isTerminated [jvm]open override fun isTerminated(): Boolean schedule [jvm]open override fun schedule(command: Runnable, delay: Long, unit: TimeUnit): ScheduledFuture<Unit>open override fun <V> schedule(callable: Callable<V>, delay: Long, unit: TimeUnit): ScheduledFuture<V> scheduleAtFixedRate [jvm]open override fun scheduleAtFixedRate(command: Runnable, initialDelay: Long, period: Long, unit: TimeUnit): ScheduledFuture<*> scheduleWithFixedDelay [jvm]open override fun scheduleWithFixedDelay(command: Runnable, initialDelay: Long, delay: Long, unit: TimeUnit): ScheduledFuture<*> shutdown [jvm]open override fun shutdown() shutdownNow [jvm]open override fun shutdownNow(): MutableList<Runnable> submit [jvm]open override fun submit(p0: Runnable): Future<*>open override fun <T : Any> submit(p0: Callable<T>): Future<T>open override fun <T : Any> submit(p0: Runnable, p1: T): Future<T> tick [jvm]fun tick()Check the current time on the clock and run any scheduled tasks that are due."},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-fake-scheduled-executor-service/","title":"FakeScheduledExecutorService - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/FakeScheduledExecutorService
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-fake-scheduled-executor-service/#fakescheduledexecutorservice","title":"FakeScheduledExecutorService","text":"[jvm]\\
@Inject
constructor(clock: Clock)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/is-shutdown/","title":"isShutdown - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/isShutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/is-shutdown/#isshutdown","title":"isShutdown","text":"[jvm]\\ open override fun isShutdown(): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-at-fixed-rate/","title":"scheduleAtFixedRate - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/scheduleAtFixedRate
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-at-fixed-rate/#scheduleatfixedrate","title":"scheduleAtFixedRate","text":"[jvm]\\ open override fun scheduleAtFixedRate(command: Runnable, initialDelay: Long, period: Long, unit: TimeUnit): ScheduledFuture<*>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-with-fixed-delay/","title":"scheduleWithFixedDelay - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/scheduleWithFixedDelay
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule-with-fixed-delay/#schedulewithfixeddelay","title":"scheduleWithFixedDelay","text":"[jvm]\\ open override fun scheduleWithFixedDelay(command: Runnable, initialDelay: Long, delay: Long, unit: TimeUnit): ScheduledFuture<*>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule/","title":"schedule - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/schedule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/schedule/#schedule","title":"schedule","text":"[jvm]\\ open override fun schedule(command: Runnable, delay: Long, unit: TimeUnit): ScheduledFuture<Unit>
open override fun <V> schedule(callable: Callable<V>, delay: Long, unit: TimeUnit): ScheduledFuture<V>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/shutdown/","title":"shutdown - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/shutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/shutdown/#shutdown","title":"shutdown","text":"[jvm]\\ open override fun shutdown()
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/tick/","title":"tick - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/tick
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/tick/#tick","title":"tick","text":"[jvm]\\ fun tick()
Check the current time on the clock and run any scheduled tasks that are due.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/","title":"ScheduledFutureTask - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#scheduledfuturetask","title":"ScheduledFutureTask","text":"[jvm]\\ inner class ScheduledFutureTask<V>(var executeAt: Long, fixedDelay: Long, val clock: Clock, val task: () -> V) : FutureTask<V> , ScheduledFuture<V>
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#constructors","title":"Constructors","text":"ScheduledFutureTask [jvm]constructor(executeAt: Long, clock: Clock, task: () -> V)constructor(executeAt: Long, fixedDelay: Long, clock: Clock, task: () -> V)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#properties","title":"Properties","text":"Name Summary clock [jvm]val clock: Clock executeAt [jvm]var executeAt: Long isRepeated [jvm]val isRepeated: Boolean task [jvm]val task: () -> V"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/#functions","title":"Functions","text":"Name Summary cancel [jvm]open override fun cancel(p0: Boolean): Boolean compareTo [jvm]open operator override fun compareTo(other: Delayed): Int get [jvm]open override fun get(): Vopen operator override fun get(p0: Long, p1: TimeUnit): V getDelay [jvm]open override fun getDelay(unit: TimeUnit): Long isCancelled [jvm]open override fun isCancelled(): Boolean isDone [jvm]open override fun isDone(): Boolean run [jvm]open override fun run() runAndReset [jvm]open override fun runAndReset(): Boolean toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/-scheduled-future-task/","title":"ScheduledFutureTask - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/ScheduledFutureTask
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/-scheduled-future-task/#scheduledfuturetask","title":"ScheduledFutureTask","text":"[jvm]\\ constructor(executeAt: Long, clock: Clock, task: () -> V)
constructor(executeAt: Long, fixedDelay: Long, clock: Clock, task: () -> V)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/clock/","title":"clock - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/clock
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/clock/#clock","title":"clock","text":"[jvm]\\ val clock: Clock
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/compare-to/","title":"compareTo - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/compareTo
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/compare-to/#compareto","title":"compareTo","text":"[jvm]\\ open operator override fun compareTo(other: Delayed): Int
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/execute-at/","title":"executeAt - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/executeAt
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/execute-at/#executeat","title":"executeAt","text":"[jvm]\\ var executeAt: Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/get-delay/","title":"getDelay - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/getDelay
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/get-delay/#getdelay","title":"getDelay","text":"[jvm]\\ open override fun getDelay(unit: TimeUnit): Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/is-repeated/","title":"isRepeated - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/isRepeated
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/is-repeated/#isrepeated","title":"isRepeated","text":"[jvm]\\ val isRepeated: Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/run-and-reset/","title":"runAndReset - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/runAndReset
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/run-and-reset/#runandreset","title":"runAndReset","text":"[jvm]\\ open override fun runAndReset(): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/task/","title":"task - Misk","text":"//misk-testing/misk.concurrent/FakeScheduledExecutorService/ScheduledFutureTask/task
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-scheduled-executor-service/-scheduled-future-task/task/#task","title":"task","text":"[jvm]\\ val task: () -> V
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/","title":"FakeSleeper - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/#fakesleeper","title":"FakeSleeper","text":"[jvm]\\ @Singleton
class FakeSleeper@Injectconstructor(clock: Clock) : Sleeper
Sleeper for testing that blocks threads calling sleep, and checks whether the threads should wake using the tick() method. An injected Clock is used to decide whether to wake a thread.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/#constructors","title":"Constructors","text":"FakeSleeper [jvm]@Injectconstructor(clock: Clock)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/#functions","title":"Functions","text":"Name Summary lastSleepDuration [jvm]fun lastSleepDuration(): Duration?Returns the last duration FakeSleeper was called with. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently. sleep [jvm]open override fun sleep(duration: Duration) sleepCount [jvm]fun sleepCount(): IntReturns the total number of times the FakeSleeper has been called. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently. tick [jvm]fun tick()Check the current time and triggers any sleeping threads that are due to be awoken. waitForSleep [jvm]fun waitForSleep(numThreads: Int)Blocks until the given number of threads are asleep (as a result of calling sleep on this FakeSleeper)."},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/-fake-sleeper/","title":"FakeSleeper - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/FakeSleeper
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/-fake-sleeper/#fakesleeper","title":"FakeSleeper","text":"[jvm]\\
@Inject
constructor(clock: Clock)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/last-sleep-duration/","title":"lastSleepDuration - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/lastSleepDuration
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/last-sleep-duration/#lastsleepduration","title":"lastSleepDuration","text":"[jvm]\\ fun lastSleepDuration(): Duration?
Returns the last duration FakeSleeper was called with. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep-count/","title":"sleepCount - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/sleepCount
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep-count/#sleepcount","title":"sleepCount","text":"[jvm]\\ fun sleepCount(): Int
Returns the total number of times the FakeSleeper has been called. This is thread-safe, but the value may not be meaningful if the sleeper is being used concurrently.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep/","title":"sleep - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/sleep
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/sleep/#sleep","title":"sleep","text":"[jvm]\\ open override fun sleep(duration: Duration)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/tick/","title":"tick - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/tick
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/tick/#tick","title":"tick","text":"[jvm]\\ fun tick()
Check the current time and triggers any sleeping threads that are due to be awoken.
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/wait-for-sleep/","title":"waitForSleep - Misk","text":"//misk-testing/misk.concurrent/FakeSleeper/waitForSleep
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper/wait-for-sleep/#waitforsleep","title":"waitForSleep","text":"[jvm]\\ fun waitForSleep(numThreads: Int)
Blocks until the given number of threads are asleep (as a result of calling sleep on this FakeSleeper).
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/","title":"FakeSleeperModule - Misk","text":"//misk-testing/misk.concurrent/FakeSleeperModule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/#fakesleepermodule","title":"FakeSleeperModule","text":"[jvm]\\ class FakeSleeperModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/#constructors","title":"Constructors","text":"FakeSleeperModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/-fake-sleeper-module/","title":"FakeSleeperModule - Misk","text":"//misk-testing/misk.concurrent/FakeSleeperModule/FakeSleeperModule
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-sleeper-module/-fake-sleeper-module/#fakesleepermodule","title":"FakeSleeperModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/","title":"FakeTicker - Misk","text":"//misk-testing/misk.concurrent/FakeTicker
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#faketicker","title":"FakeTicker","text":"[jvm]\\ @Singleton
class FakeTicker@Injectconstructor : Ticker, Sleeper
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#constructors","title":"Constructors","text":"FakeTicker [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#properties","title":"Properties","text":"Name Summary nowMs [jvm]val nowMs: Long"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/#functions","title":"Functions","text":"Name Summary read [jvm]open override fun read(): Long sleep [jvm]open override fun sleep(duration: Duration) sleepMs [jvm]fun sleepMs(durationMs: Long)"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/-fake-ticker/","title":"FakeTicker - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/FakeTicker
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/-fake-ticker/#faketicker","title":"FakeTicker","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/now-ms/","title":"nowMs - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/nowMs
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/now-ms/#nowms","title":"nowMs","text":"[jvm]\\ val nowMs: Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/read/","title":"read - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/read
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/read/#read","title":"read","text":"[jvm]\\ open override fun read(): Long
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep-ms/","title":"sleepMs - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/sleepMs
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep-ms/#sleepms","title":"sleepMs","text":"[jvm]\\ fun sleepMs(durationMs: Long)
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep/","title":"sleep - Misk","text":"//misk-testing/misk.concurrent/FakeTicker/sleep
"},{"location":"0.x/misk-testing/misk-testing/misk.concurrent/-fake-ticker/sleep/#sleep","title":"sleep","text":"[jvm]\\ open override fun sleep(duration: Duration)
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.containers
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.containers/#types","title":"Types","text":"Name Summary Composer [jvm]class Composer(name: String, containers: Container)Composer composes many Containers together to use in a unit test. Container [jvm]data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)A Container creates a Docker container for testing."},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/","title":"Composer - Misk","text":"//misk-testing/misk.containers/Composer
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/#composer","title":"Composer","text":"[jvm]\\ class Composer(name: String, containers: Container)
Composer composes many Containers together to use in a unit test.
The Containers are networked using a dedicated Docker network. Tests need to expose ports in order for the test to communicate with the containers over 127.0.0.1.
The following example composes Kafka and Zookeeper containers for testing. Kafka is exposed to the jUnit test via 127.0.0.1:9102. In this example, Zookeeper is not exposed to the test.
val zkContainer = Container {\n withImage(\"confluentinc/cp-zookeeper\")\n withName(\"zookeeper\")\n withEnv(\"ZOOKEEPER_CLIENT_PORT=2181\")\n }\n val kafka = Container {\n withImage(\"confluentinc/cp-kafka\"\n withName(\"kafka\")\n withExposedPorts(ExposedPort.tcp(port))\n withPortBindings(Ports().apply {\n bind(ExposedPort.tcp(9102), Ports.Binding.bindPort(9102))\n })\n withEnv(\n \"KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181\",\n \"KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9102\")\n }\n val composer = Composer(\"e-kafka\", zkContainer, kafka)\n composer.start()\n//misk-testing/misk.containers/Composer/Composer
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/-composer/#composer","title":"Composer","text":"[jvm]\\ constructor(name: String, vararg containers: Container)
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/start/","title":"start - Misk","text":"//misk-testing/misk.containers/Composer/start
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/start/#start","title":"start","text":"[jvm]\\ fun start()
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/stop/","title":"stop - Misk","text":"//misk-testing/misk.containers/Composer/stop
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-composer/stop/#stop","title":"stop","text":"[jvm]\\ fun stop()
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/","title":"Container - Misk","text":"//misk-testing/misk.containers/Container
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/#container","title":"Container","text":"[jvm]\\ data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)
A Container creates a Docker container for testing.
Tests provide a lambda to build a CreateContainerCmd. The createCmd lambda must set CreateContainerCmd.withName and CreateContainerCmd.withImage. All other fields are optional. The Composer takes care of setting up the network.
There may be a need to configure your container between the creation and start steps. beforeStartHook provides you with an id to your container allowing you to manipulate as necessary before the command/entrypoint is invoked.
See Composer for an example.
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/#constructors","title":"Constructors","text":"Container [jvm]constructor(createCmd: CreateContainerCmd.() -> Unit)constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/#properties","title":"Properties","text":"Name Summary beforeStartHook [jvm]val beforeStartHook: (docker: DockerClient, id: String) -> Unit createCmd [jvm]val createCmd: CreateContainerCmd.() -> Unit"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/-container/","title":"Container - Misk","text":"//misk-testing/misk.containers/Container/Container
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/-container/#container","title":"Container","text":"[jvm]\\ constructor(createCmd: CreateContainerCmd.() -> Unit)
constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/before-start-hook/","title":"beforeStartHook - Misk","text":"//misk-testing/misk.containers/Container/beforeStartHook
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/before-start-hook/#beforestarthook","title":"beforeStartHook","text":"[jvm]\\ val beforeStartHook: (docker: DockerClient, id: String) -> Unit
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/create-cmd/","title":"createCmd - Misk","text":"//misk-testing/misk.containers/Container/createCmd
"},{"location":"0.x/misk-testing/misk-testing/misk.containers/-container/create-cmd/#createcmd","title":"createCmd","text":"[jvm]\\ val createCmd: CreateContainerCmd.() -> Unit
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.logging
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.logging/#types","title":"Types","text":"Name Summary LogCollectorModule [jvm]class LogCollectorModule : KAbstractModule LogCollectorService [jvm]interface LogCollectorService : ServiceMarker interface for the service that produces a LogCollector."},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/","title":"LogCollectorModule - Misk","text":"//misk-testing/misk.logging/LogCollectorModule
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/#logcollectormodule","title":"LogCollectorModule","text":"[jvm]\\ class LogCollectorModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/#constructors","title":"Constructors","text":"LogCollectorModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/-log-collector-module/","title":"LogCollectorModule - Misk","text":"//misk-testing/misk.logging/LogCollectorModule/LogCollectorModule
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-module/-log-collector-module/#logcollectormodule","title":"LogCollectorModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-service/","title":"LogCollectorService - Misk","text":"//misk-testing/misk.logging/LogCollectorService
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-service/#logcollectorservice","title":"LogCollectorService","text":"[jvm]\\ interface LogCollectorService : Service
Marker interface for the service that produces a LogCollector.
"},{"location":"0.x/misk-testing/misk-testing/misk.logging/-log-collector-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]abstract fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]abstract fun awaitRunning()open fun awaitRunning(timeout: Duration)abstract fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]abstract fun awaitTerminated()open fun awaitTerminated(timeout: Duration)abstract fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]abstract fun failureCause(): Throwable isRunning [jvm]abstract fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueabstract fun startAsync(): Service state [jvm]abstract fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueabstract fun stopAsync(): Service"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.mockito
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.mockito/#types","title":"Types","text":"Name Summary Mockito [jvm]object Mockito"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/","title":"Mockito - Misk","text":"//misk-testing/misk.mockito/Mockito
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/#mockito","title":"Mockito","text":"[jvm]\\ object Mockito
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/#functions","title":"Functions","text":"Name Summary captor [jvm]inline fun <T : Any> captor(): ArgumentCaptor<T> mock [jvm]inline fun <T : Any> mock(): T whenever [jvm]inline fun <T : Any> whenever(t: T): OngoingStubbing<T>"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/captor/","title":"captor - Misk","text":"//misk-testing/misk.mockito/Mockito/captor
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/captor/#captor","title":"captor","text":"[jvm]\\ inline fun <T : Any> captor(): ArgumentCaptor<T>
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/mock/","title":"mock - Misk","text":"//misk-testing/misk.mockito/Mockito/mock
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/mock/#mock","title":"mock","text":"[jvm]\\ inline fun <T : Any> mock(): T
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/whenever/","title":"whenever - Misk","text":"//misk-testing/misk.mockito/Mockito/whenever
"},{"location":"0.x/misk-testing/misk-testing/misk.mockito/-mockito/whenever/#whenever","title":"whenever","text":"[jvm]\\ inline fun <T : Any> whenever(t: T): OngoingStubbing<T>
"},{"location":"0.x/misk-testing/misk-testing/misk.random/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.random
"},{"location":"0.x/misk-testing/misk-testing/misk.random/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.random/#types","title":"Types","text":"Name Summary FakeRandom [jvm]@Singletonclass FakeRandom@Injectconstructor : Random FakeRandomModule [jvm]class FakeRandomModule : KAbstractModule FakeThreadLocalRandom [jvm]@Singletonclass FakeThreadLocalRandom@Injectconstructor : ThreadLocalRandom"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/","title":"FakeRandom - Misk","text":"//misk-testing/misk.random/FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#fakerandom","title":"FakeRandom","text":"[jvm]\\ @Singleton
class FakeRandom@Injectconstructor : Random
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#constructors","title":"Constructors","text":"FakeRandom [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#properties","title":"Properties","text":"Name Summary nextBoolean [jvm]var nextBoolean: Boolean? nextDouble [jvm]var nextDouble: Double? nextFloat [jvm]var nextFloat: Float? nextInt [jvm]var nextInt: Int? nextLong [jvm]var nextLong: Long?"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/#functions","title":"Functions","text":"Name Summary doubles [jvm]open override fun doubles(): DoubleStreamopen override fun doubles(p0: Long): DoubleStreamopen override fun doubles(p0: Double, p1: Double): DoubleStreamopen override fun doubles(p0: Long, p1: Double, p2: Double): DoubleStream ints [jvm]open override fun ints(): IntStreamopen override fun ints(p0: Long): IntStreamopen override fun ints(p0: Int, p1: Int): IntStreamopen override fun ints(p0: Long, p1: Int, p2: Int): IntStream isDeprecated [jvm]open fun isDeprecated(): Boolean longs [jvm]open override fun longs(): LongStreamopen override fun longs(p0: Long): LongStreamopen override fun longs(p0: Long, p1: Long): LongStreamopen override fun longs(p0: Long, p1: Long, p2: Long): LongStream nextBoolean [jvm]open override fun nextBoolean(): Boolean nextBytes [jvm]open override fun nextBytes(p0: ByteArray) nextDouble [jvm]open fun nextDouble(p0: Double): Doubleopen fun nextDouble(p0: Double, p1: Double): Doubleopen override fun nextDouble(): Double nextExponential [jvm]open fun nextExponential(): Double nextFloat [jvm]open fun nextFloat(p0: Float): Floatopen fun nextFloat(p0: Float, p1: Float): Floatopen override fun nextFloat(): Float nextGaussian [jvm]open override fun nextGaussian(): Doubleopen fun nextGaussian(p0: Double, p1: Double): Double nextInt [jvm]open override fun nextInt(p0: Int): Intopen fun nextInt(p0: Int, p1: Int): Intopen override fun nextInt(): Int nextLong [jvm]open fun nextLong(p0: Long): Longopen fun nextLong(p0: Long, p1: Long): Longopen override fun nextLong(): Long setSeed [jvm]open fun setSeed(p0: Long)"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/-fake-random/","title":"FakeRandom - Misk","text":"//misk-testing/misk.random/FakeRandom/FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/-fake-random/#fakerandom","title":"FakeRandom","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-boolean/","title":"nextBoolean - Misk","text":"//misk-testing/misk.random/FakeRandom/nextBoolean
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-boolean/#nextboolean","title":"nextBoolean","text":"[jvm]\\ open override fun nextBoolean(): Boolean
var nextBoolean: Boolean?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-double/","title":"nextDouble - Misk","text":"//misk-testing/misk.random/FakeRandom/nextDouble
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-double/#nextdouble","title":"nextDouble","text":"[jvm]\\ open override fun nextDouble(): Double
var nextDouble: Double?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-float/","title":"nextFloat - Misk","text":"//misk-testing/misk.random/FakeRandom/nextFloat
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-float/#nextfloat","title":"nextFloat","text":"[jvm]\\ open override fun nextFloat(): Float
var nextFloat: Float?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-int/","title":"nextInt - Misk","text":"//misk-testing/misk.random/FakeRandom/nextInt
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-int/#nextint","title":"nextInt","text":"[jvm]\\ open override fun nextInt(): Int
var nextInt: Int?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-long/","title":"nextLong - Misk","text":"//misk-testing/misk.random/FakeRandom/nextLong
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random/next-long/#nextlong","title":"nextLong","text":"[jvm]\\ open override fun nextLong(): Long
var nextLong: Long?
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/","title":"FakeRandomModule - Misk","text":"//misk-testing/misk.random/FakeRandomModule
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/#fakerandommodule","title":"FakeRandomModule","text":"[jvm]\\ class FakeRandomModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/#constructors","title":"Constructors","text":"FakeRandomModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/-fake-random-module/","title":"FakeRandomModule - Misk","text":"//misk-testing/misk.random/FakeRandomModule/FakeRandomModule
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-random-module/-fake-random-module/#fakerandommodule","title":"FakeRandomModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/","title":"FakeThreadLocalRandom - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#fakethreadlocalrandom","title":"FakeThreadLocalRandom","text":"[jvm]\\ @Singleton
class FakeThreadLocalRandom@Injectconstructor : ThreadLocalRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#constructors","title":"Constructors","text":"FakeThreadLocalRandom [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#properties","title":"Properties","text":"Name Summary fakeRandom [jvm]@Injectlateinit var fakeRandom: FakeRandom"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/#functions","title":"Functions","text":"Name Summary current [jvm]open override fun current(): FakeRandom"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/-fake-thread-local-random/","title":"FakeThreadLocalRandom - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom/FakeThreadLocalRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/-fake-thread-local-random/#fakethreadlocalrandom","title":"FakeThreadLocalRandom","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/current/","title":"current - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom/current
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/current/#current","title":"current","text":"[jvm]\\ open override fun current(): FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/fake-random/","title":"fakeRandom - Misk","text":"//misk-testing/misk.random/FakeThreadLocalRandom/fakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.random/-fake-thread-local-random/fake-random/#fakerandom","title":"fakeRandom","text":"[jvm]\\
@Inject
lateinit var fakeRandom: FakeRandom
"},{"location":"0.x/misk-testing/misk-testing/misk.service/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.service
"},{"location":"0.x/misk-testing/misk-testing/misk.service/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.service/#types","title":"Types","text":"Name Summary CachedTestService [jvm]abstract class CachedTestService : AbstractIdleServiceTest services can derive from CachedTestService if they\u2019d like to reuse the same service for the span of a given runtime. This is helpful when you want to avoid incurring the cost of service startup and shutdown with each test run."},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/","title":"CachedTestService - Misk","text":"//misk-testing/misk.service/CachedTestService
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#cachedtestservice","title":"CachedTestService","text":"[jvm]\\ abstract class CachedTestService : AbstractIdleService
Test services can derive from CachedTestService if they\u2019d like to reuse the same service for the span of a given runtime. This is helpful when you want to avoid incurring the cost of service startup and shutdown with each test run.
NOTE: The caching is only useful if the implementing service references a shared instance of their underlying resources. A common way to do this is to leverage a companion object.
Example:
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#constructors","title":"Constructors","text":"CachedTestService [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/#functions","title":"Functions","text":"Name Summary actualShutdown [jvm]abstract fun actualShutdown()Actually shuts the service down. This will be invoked once per runtime. actualStartup [jvm]abstract fun actualStartup()Actually starts the service up. This will be invoked once per runtime. addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-cached-test-service/","title":"CachedTestService - Misk","text":"//misk-testing/misk.service/CachedTestService/CachedTestService
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-cached-test-service/#cachedtestservice","title":"CachedTestService","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-shutdown/","title":"actualShutdown - Misk","text":"//misk-testing/misk.service/CachedTestService/actualShutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-shutdown/#actualshutdown","title":"actualShutdown","text":"[jvm]\\ abstract fun actualShutdown()
Actually shuts the service down. This will be invoked once per runtime.
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-startup/","title":"actualStartup - Misk","text":"//misk-testing/misk.service/CachedTestService/actualStartup
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/actual-startup/#actualstartup","title":"actualStartup","text":"[jvm]\\ abstract fun actualStartup()
Actually starts the service up. This will be invoked once per runtime.
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-companion/","title":"Companion - Misk","text":"//misk-testing/misk.service/CachedTestService/Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.service/-cached-test-service/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.services/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.services
"},{"location":"0.x/misk-testing/misk-testing/misk.services/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.services/#types","title":"Types","text":"Name Summary FakeService [jvm]@Singletonclass FakeService@Injectconstructor : AbstractIdleService FakeServiceModule [jvm]class FakeServiceModule : KAbstractModule"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/","title":"FakeService - Misk","text":"//misk-testing/misk.services/FakeService
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/#fakeservice","title":"FakeService","text":"[jvm]\\ @Singleton
class FakeService@Injectconstructor : AbstractIdleService
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/#constructors","title":"Constructors","text":"FakeService [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/#functions","title":"Functions","text":"Name Summary addListener [jvm]override fun addListener(listener: Service.Listener, executor: Executor) awaitRunning [jvm]override fun awaitRunning()override fun awaitRunning(timeout: Duration)override fun awaitRunning(timeout: Long, unit: TimeUnit) awaitTerminated [jvm]override fun awaitTerminated()override fun awaitTerminated(timeout: Duration)override fun awaitTerminated(timeout: Long, unit: TimeUnit) failureCause [jvm]override fun failureCause(): Throwable isRunning [jvm]override fun isRunning(): Boolean startAsync [jvm]@CanIgnoreReturnValueoverride fun startAsync(): Service state [jvm]override fun state(): Service.State stopAsync [jvm]@CanIgnoreReturnValueoverride fun stopAsync(): Service toString [jvm]open override fun toString(): String"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/-fake-service/","title":"FakeService - Misk","text":"//misk-testing/misk.services/FakeService/FakeService
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service/-fake-service/#fakeservice","title":"FakeService","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/","title":"FakeServiceModule - Misk","text":"//misk-testing/misk.services/FakeServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/#fakeservicemodule","title":"FakeServiceModule","text":"[jvm]\\ class FakeServiceModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/#constructors","title":"Constructors","text":"FakeServiceModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/-fake-service-module/","title":"FakeServiceModule - Misk","text":"//misk-testing/misk.services/FakeServiceModule/FakeServiceModule
"},{"location":"0.x/misk-testing/misk-testing/misk.services/-fake-service-module/-fake-service-module/#fakeservicemodule","title":"FakeServiceModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.testing
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.testing/#types","title":"Types","text":"Name Summary ConcurrentMockTracer [jvm]@Singletonclass ConcurrentMockTracer@Injectconstructor : MockTracerExtends MockTracer for use in concurrent environments, such as a web server and test client. Prefer this wherever you\u2019d otherwise use MockTracer. ExternalDependency [jvm]interface ExternalDependencyAn external dependency of the Misk Application that needs to be started for test, like Redis, Vitess, MySQL, SQS, etc. InjectingParameterResolver [jvm]class InjectingParameterResolver : ParameterResolver InjectTest [jvm]@Target(allowedTargets = [AnnotationTarget.FUNCTION])@Test@ExtendWith(value = [InjectingParameterResolver::class])annotation class InjectTest LogLevel [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])annotation class LogLevel(val level: LogLevel.Level = Level.INFO)Annotate your test classes or methods with@LogLevel to change the log level used by the test. It can be useful to have different LogLevel by test, specially if you\u2019re debugging issues on CI. LogLevelExtension [jvm]class LogLevelExtension@Injectconstructor : BeforeEachCallback MiskExternalDependency [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class MiskExternalDependency MiskTest [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])@ExtendWith(value = [MiskTestExtension::class])annotation class MiskTest(val startService: Boolean = false)Annotate your test classes with @MiskTest to have fields annotated with @Inject initialized. Provide modules to be installed by annotating a Module field in your test class with MiskTestModule. This can be a compound module, composed using Modules.combine. MiskTestModule [jvm]@Target(allowedTargets = [AnnotationTarget.FIELD])annotation class MiskTestModule MockTracingBackendModule [jvm]class MockTracingBackendModule : KAbstractModule TemporaryFolder [jvm]class TemporaryFolder(val root: Path)A temporary folder for use by a given test TemporaryFolderModule [jvm]class TemporaryFolderModule : KAbstractModule"},{"location":"0.x/misk-testing/misk-testing/misk.testing/#functions","title":"Functions","text":"Name Summary retrieve [jvm]inline fun <T> ExtensionContext.retrieve(name: String): T store [jvm]fun <T> ExtensionContext.store(name: String, value: T)Stores an object scoped to the test class on the context"},{"location":"0.x/misk-testing/misk-testing/misk.testing/retrieve/","title":"retrieve - Misk","text":"//misk-testing/misk.testing/retrieve
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/retrieve/#retrieve","title":"retrieve","text":"[jvm]\\ inline fun <T> ExtensionContext.retrieve(name: String): T
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/retrieve/#return","title":"Return","text":"A previously stored object scoped to the test class
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/store/","title":"store - Misk","text":"//misk-testing/misk.testing/store
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/store/#store","title":"store","text":"[jvm]\\ fun <T> ExtensionContext.store(name: String, value: T)
Stores an object scoped to the test class on the context
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/","title":"ConcurrentMockTracer - Misk","text":"//misk-testing/misk.testing/ConcurrentMockTracer
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/#concurrentmocktracer","title":"ConcurrentMockTracer","text":"[jvm]\\ @Singleton
class ConcurrentMockTracer@Injectconstructor : MockTracer
Extends MockTracer for use in concurrent environments, such as a web server and test client. Prefer this wherever you\u2019d otherwise use MockTracer.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/#constructors","title":"Constructors","text":"ConcurrentMockTracer [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/#functions","title":"Functions","text":"Name Summary activateSpan [jvm]open override fun activateSpan(p0: Span): Scope activeSpan [jvm]open override fun activeSpan(): Span buildSpan [jvm]open override fun buildSpan(p0: String): MockTracer.SpanBuilder close [jvm]open override fun close() extract [jvm]open override fun <C : Any> extract(p0: Format<C>, p1: C): SpanContext finishedSpans [jvm]open fun finishedSpans(): MutableList<MockSpan> inject [jvm]open override fun <C : Any> inject(p0: SpanContext, p1: Format<C>, p2: C) reset [jvm]open fun reset() scopeManager [jvm]open override fun scopeManager(): ScopeManager take [jvm]fun take(): MockSpanAwaits a span, removes it, and returns it.[jvm]fun take(operationName: String): MockSpanAwaits a span named operationName, removes it, and returns it. Spans with other names are consumed and discarded."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/-concurrent-mock-tracer/","title":"ConcurrentMockTracer - Misk","text":"//misk-testing/misk.testing/ConcurrentMockTracer/ConcurrentMockTracer
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/-concurrent-mock-tracer/#concurrentmocktracer","title":"ConcurrentMockTracer","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/take/","title":"take - Misk","text":"//misk-testing/misk.testing/ConcurrentMockTracer/take
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-concurrent-mock-tracer/take/#take","title":"take","text":"[jvm]\\ fun take(): MockSpan
Awaits a span, removes it, and returns it.
[jvm]\\ fun take(operationName: String): MockSpan
Awaits a span named operationName, removes it, and returns it. Spans with other names are consumed and discarded.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/","title":"ExternalDependency - Misk","text":"//misk-testing/misk.testing/ExternalDependency
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/#externaldependency","title":"ExternalDependency","text":"[jvm]\\ interface ExternalDependency
An external dependency of the Misk Application that needs to be started for test, like Redis, Vitess, MySQL, SQS, etc.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/#properties","title":"Properties","text":"Name Summary id [jvm]open val id: StringUnique ID for the dependency, used as a stable key across tests. Can be overridden if more than one instance of the dependency is supported."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/#functions","title":"Functions","text":"Name Summary afterEach [jvm]abstract fun afterEach()Called before each test run beforeEach [jvm]abstract fun beforeEach()Called before each test run shutdown [jvm]abstract fun shutdown()Stops the dependency. startup [jvm]abstract fun startup()Starts the dependency."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/after-each/","title":"afterEach - Misk","text":"//misk-testing/misk.testing/ExternalDependency/afterEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/after-each/#aftereach","title":"afterEach","text":"[jvm]\\ abstract fun afterEach()
Called before each test run
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/before-each/","title":"beforeEach - Misk","text":"//misk-testing/misk.testing/ExternalDependency/beforeEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/before-each/#beforeeach","title":"beforeEach","text":"[jvm]\\ abstract fun beforeEach()
Called before each test run
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/id/","title":"id - Misk","text":"//misk-testing/misk.testing/ExternalDependency/id
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/id/#id","title":"id","text":"[jvm]\\ open val id: String
Unique ID for the dependency, used as a stable key across tests. Can be overridden if more than one instance of the dependency is supported.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/shutdown/","title":"shutdown - Misk","text":"//misk-testing/misk.testing/ExternalDependency/shutdown
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/shutdown/#shutdown","title":"shutdown","text":"[jvm]\\ abstract fun shutdown()
Stops the dependency.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/startup/","title":"startup - Misk","text":"//misk-testing/misk.testing/ExternalDependency/startup
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-external-dependency/startup/#startup","title":"startup","text":"[jvm]\\ abstract fun startup()
Starts the dependency.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-inject-test/","title":"InjectTest - Misk","text":"//misk-testing/misk.testing/InjectTest
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-inject-test/#injecttest","title":"InjectTest","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FUNCTION])
@Test
@ExtendWith(value = [InjectingParameterResolver::class])
annotation class InjectTest
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/","title":"InjectingParameterResolver - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/#injectingparameterresolver","title":"InjectingParameterResolver","text":"[jvm]\\ class InjectingParameterResolver : ParameterResolver
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/#constructors","title":"Constructors","text":"InjectingParameterResolver [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/#functions","title":"Functions","text":"Name Summary resolveParameter [jvm]open override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any supportsParameter [jvm]open override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/-injecting-parameter-resolver/","title":"InjectingParameterResolver - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver/InjectingParameterResolver
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/-injecting-parameter-resolver/#injectingparameterresolver","title":"InjectingParameterResolver","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/resolve-parameter/","title":"resolveParameter - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver/resolveParameter
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/resolve-parameter/#resolveparameter","title":"resolveParameter","text":"[jvm]\\ open override fun resolveParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Any
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/supports-parameter/","title":"supportsParameter - Misk","text":"//misk-testing/misk.testing/InjectingParameterResolver/supportsParameter
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-injecting-parameter-resolver/supports-parameter/#supportsparameter","title":"supportsParameter","text":"[jvm]\\ open override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/","title":"LogLevel - Misk","text":"//misk-testing/misk.testing/LogLevel
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/#loglevel","title":"LogLevel","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])
annotation class LogLevel(val level: LogLevel.Level = Level.INFO)
Annotate your test classes or methods with @LogLevel to change the log level used by the test. It can be useful to have different LogLevel by test, specially if you\u2019re debugging issues on CI.
You can annotate methods:
@LogLevel(level = LogLevel.Level.DEBUG)\n@Test fun levelDebug() {\n}\nAlso, You can annotate test classes:
@LogLevel(level = LogLevel.Level.ERROR)\nclass `you can annotate the test` {\n@Test fun levelError() {\n//misk-testing/misk.testing/LogLevel/level
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/level/#level","title":"level","text":"[jvm]\\ val level: LogLevel.Level
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/","title":"Level - Misk","text":"//misk-testing/misk.testing/LogLevel/Level
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#level","title":"Level","text":"[jvm]\\ enum Level : Enum<LogLevel.Level>
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#entries","title":"Entries","text":"DEBUG [jvm]DEBUG INFO [jvm]INFO WARN [jvm]WARN ERROR [jvm]ERROR"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<LogLevel.Level>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): LogLevel.LevelReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<LogLevel.Level>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/entries/","title":"entries - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/entries
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<LogLevel.Level>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/value-of/","title":"valueOf - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/valueOf
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): LogLevel.Level
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/values/","title":"values - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/values
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<LogLevel.Level>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-d-e-b-u-g/","title":"DEBUG - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/DEBUG
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-d-e-b-u-g/#debug","title":"DEBUG","text":"[jvm]\\ DEBUG
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-d-e-b-u-g/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-e-r-r-o-r/","title":"ERROR - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/ERROR
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-e-r-r-o-r/#error","title":"ERROR","text":"[jvm]\\ ERROR
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-e-r-r-o-r/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-i-n-f-o/","title":"INFO - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/INFO
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-i-n-f-o/#info","title":"INFO","text":"[jvm]\\ INFO
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-i-n-f-o/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-w-a-r-n/","title":"WARN - Misk","text":"//misk-testing/misk.testing/LogLevel/Level/WARN
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-w-a-r-n/#warn","title":"WARN","text":"[jvm]\\ WARN
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level/-level/-w-a-r-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/","title":"LogLevelExtension - Misk","text":"//misk-testing/misk.testing/LogLevelExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/#loglevelextension","title":"LogLevelExtension","text":"[jvm]\\ class LogLevelExtension@Injectconstructor : BeforeEachCallback
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/#constructors","title":"Constructors","text":"LogLevelExtension [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/#functions","title":"Functions","text":"Name Summary beforeEach [jvm]open override fun beforeEach(context: ExtensionContext?)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/-log-level-extension/","title":"LogLevelExtension - Misk","text":"//misk-testing/misk.testing/LogLevelExtension/LogLevelExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/-log-level-extension/#loglevelextension","title":"LogLevelExtension","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/before-each/","title":"beforeEach - Misk","text":"//misk-testing/misk.testing/LogLevelExtension/beforeEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-log-level-extension/before-each/#beforeeach","title":"beforeEach","text":"[jvm]\\ open override fun beforeEach(context: ExtensionContext?)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-external-dependency/","title":"MiskExternalDependency - Misk","text":"//misk-testing/misk.testing/MiskExternalDependency
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-external-dependency/#miskexternaldependency","title":"MiskExternalDependency","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class MiskExternalDependency
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test/","title":"MiskTest - Misk","text":"//misk-testing/misk.testing/MiskTest
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test/#misktest","title":"MiskTest","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
@ExtendWith(value = [MiskTestExtension::class])
annotation class MiskTest(val startService: Boolean = false)
Annotate your test classes with @MiskTest to have fields annotated with @Inject initialized. Provide modules to be installed by annotating a Module field in your test class with MiskTestModule. This can be a compound module, composed using Modules.combine.
Configure test callbacks with Guice multibindings. Register instances by calling multibind() in a KAbstractModule:
multibind<BeforeEachCallback>().to<MyBeforeEach>()\nmultibind<AfterEachCallback>().to<MyAfterEach>()\n//misk-testing/misk.testing/MiskTest/startService
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test/start-service/#startservice","title":"startService","text":"[jvm]\\ val startService: Boolean = false
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test-module/","title":"MiskTestModule - Misk","text":"//misk-testing/misk.testing/MiskTestModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-misk-test-module/#misktestmodule","title":"MiskTestModule","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.FIELD])
annotation class MiskTestModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/","title":"MockTracingBackendModule - Misk","text":"//misk-testing/misk.testing/MockTracingBackendModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/#mocktracingbackendmodule","title":"MockTracingBackendModule","text":"[jvm]\\ class MockTracingBackendModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/#constructors","title":"Constructors","text":"MockTracingBackendModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/-mock-tracing-backend-module/","title":"MockTracingBackendModule - Misk","text":"//misk-testing/misk.testing/MockTracingBackendModule/MockTracingBackendModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-mock-tracing-backend-module/-mock-tracing-backend-module/#mocktracingbackendmodule","title":"MockTracingBackendModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/","title":"TemporaryFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#temporaryfolder","title":"TemporaryFolder","text":"[jvm]\\ class TemporaryFolder(val root: Path)
A temporary folder for use by a given test
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#constructors","title":"Constructors","text":"TemporaryFolder [jvm]constructor(root: Path)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#properties","title":"Properties","text":"Name Summary root [jvm]val root: Path"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/#functions","title":"Functions","text":"Name Summary delete [jvm]fun delete()Deletes all files and folders under the temporary folder newFile [jvm]fun newFile(): Pathfun newFile(name: String): Path newFolder [jvm]fun newFolder(): Pathfun newFolder(name: String): Path"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/-temporary-folder/","title":"TemporaryFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/TemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/-temporary-folder/#temporaryfolder","title":"TemporaryFolder","text":"[jvm]\\ constructor(root: Path)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/delete/","title":"delete - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/delete
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/delete/#delete","title":"delete","text":"[jvm]\\ fun delete()
Deletes all files and folders under the temporary folder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/","title":"newFile - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/newFile
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/#newfile","title":"newFile","text":"[jvm]\\ fun newFile(): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/#return","title":"Return","text":"a new file with a randomly generated name
[jvm]\\ fun newFile(name: String): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-file/#return_1","title":"Return","text":"a new file with the given name
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/","title":"newFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/newFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/#newfolder","title":"newFolder","text":"[jvm]\\ fun newFolder(): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/#return","title":"Return","text":"a new folder with a randomly generated name
[jvm]\\ fun newFolder(name: String): Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/new-folder/#return_1","title":"Return","text":"a new folder with the given name
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/root/","title":"root - Misk","text":"//misk-testing/misk.testing/TemporaryFolder/root
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder/root/#root","title":"root","text":"[jvm]\\ val root: Path
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/","title":"TemporaryFolderModule - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#temporaryfoldermodule","title":"TemporaryFolderModule","text":"[jvm]\\ class TemporaryFolderModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#constructors","title":"Constructors","text":"TemporaryFolderModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#types","title":"Types","text":"Name Summary DeleteTempFolder [jvm]class DeleteTempFolder@Injectconstructor(tempDir: TemporaryFolder) : AfterEachCallback"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) provideTemporaryFolder [jvm]@Provides@Singletonfun provideTemporaryFolder(): TemporaryFolder"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-temporary-folder-module/","title":"TemporaryFolderModule - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/TemporaryFolderModule
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-temporary-folder-module/#temporaryfoldermodule","title":"TemporaryFolderModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/provide-temporary-folder/","title":"provideTemporaryFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/provideTemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/provide-temporary-folder/#providetemporaryfolder","title":"provideTemporaryFolder","text":"[jvm]\\
@Provides
@Singleton
fun provideTemporaryFolder(): TemporaryFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/","title":"DeleteTempFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/DeleteTempFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/#deletetempfolder","title":"DeleteTempFolder","text":"[jvm]\\ class DeleteTempFolder@Injectconstructor(tempDir: TemporaryFolder) : AfterEachCallback
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/#constructors","title":"Constructors","text":"DeleteTempFolder [jvm]@Injectconstructor(tempDir: TemporaryFolder)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/#functions","title":"Functions","text":"Name Summary afterEach [jvm]open override fun afterEach(context: ExtensionContext)"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/-delete-temp-folder/","title":"DeleteTempFolder - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/DeleteTempFolder/DeleteTempFolder
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/-delete-temp-folder/#deletetempfolder","title":"DeleteTempFolder","text":"[jvm]\\
@Inject
constructor(tempDir: TemporaryFolder)
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/after-each/","title":"afterEach - Misk","text":"//misk-testing/misk.testing/TemporaryFolderModule/DeleteTempFolder/afterEach
"},{"location":"0.x/misk-testing/misk-testing/misk.testing/-temporary-folder-module/-delete-temp-folder/after-each/#aftereach","title":"afterEach","text":"[jvm]\\ open override fun afterEach(context: ExtensionContext)
"},{"location":"0.x/misk-testing/misk-testing/misk.time/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.time
"},{"location":"0.x/misk-testing/misk-testing/misk.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.time/#types","title":"Types","text":"Name Summary FakeClock [jvm]@Singletonclass FakeClock@Injectconstructor : FakeClock FakeClockModule [jvm]class FakeClockModule : KInstallOnceModule FakeTickerModule [jvm]class FakeTickerModule : KAbstractModule"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/","title":"FakeClock - Misk","text":"//misk-testing/misk.time/FakeClock
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\ @Singleton
class FakeClock@Injectconstructor : FakeClock
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/#constructors","title":"Constructors","text":"FakeClock [jvm]@Injectconstructor()"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(d: Duration): Longfun add(p: Period): Longfun add(n: Long, unit: TimeUnit): Long equals [jvm]open operator override fun equals(other: Any?): Boolean getZone [jvm]open override fun getZone(): ZoneId hashCode [jvm]open override fun hashCode(): Int instant [jvm]open override fun instant(): Instant millis [jvm]open override fun millis(): Long reset [jvm]open override fun reset() setNow [jvm]fun setNow(instant: Instant) withZone [jvm]open override fun withZone(zone: ZoneId): Clock"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/-fake-clock/","title":"FakeClock - Misk","text":"//misk-testing/misk.time/FakeClock/FakeClock
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\
@Inject
constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/","title":"FakeClockModule - Misk","text":"//misk-testing/misk.time/FakeClockModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/#fakeclockmodule","title":"FakeClockModule","text":"[jvm]\\ class FakeClockModule : KInstallOnceModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/#constructors","title":"Constructors","text":"FakeClockModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder) equals [jvm]operator override fun equals(other: Any?): Boolean hashCode [jvm]override fun hashCode(): Int"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/-fake-clock-module/","title":"FakeClockModule - Misk","text":"//misk-testing/misk.time/FakeClockModule/FakeClockModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-clock-module/-fake-clock-module/#fakeclockmodule","title":"FakeClockModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/","title":"FakeTickerModule - Misk","text":"//misk-testing/misk.time/FakeTickerModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/#faketickermodule","title":"FakeTickerModule","text":"[jvm]\\ class FakeTickerModule : KAbstractModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/#constructors","title":"Constructors","text":"FakeTickerModule [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/-fake-ticker-module/","title":"FakeTickerModule - Misk","text":"//misk-testing/misk.time/FakeTickerModule/FakeTickerModule
"},{"location":"0.x/misk-testing/misk-testing/misk.time/-fake-ticker-module/-fake-ticker-module/#faketickermodule","title":"FakeTickerModule","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/","title":"Package-level declarations - Misk","text":"//misk-testing/misk.web
"},{"location":"0.x/misk-testing/misk-testing/misk.web/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/misk.web/#types","title":"Types","text":"Name Summary FakeHttpCall [jvm]data class FakeHttpCall@JvmOverloadsconstructor(val url: HttpUrl = \"https://example.com/\".toHttpUrl(), val linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), val dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, var requestHeaders: Headers = headersOf(), var statusCode: Int = 200, var networkStatusCode: Int = 200, val headersBuilder: Headers.Builder = Headers.Builder(), var sendTrailers: Boolean = false, val trailersBuilder: Headers.Builder = Headers.Builder(), var requestBody: BufferedSource? = Buffer(), var responseBody: BufferedSink? = Buffer(), var webSocket: WebSocket? = null, var webSocketListener: WebSocketListener? = null, var cookies: List<Cookie> = listOf()) : HttpCall FakeWebSocket [jvm]class FakeWebSocket : WebSocket FakeWebSocketListener [jvm]class FakeWebSocketListener : WebSocketListener MiskCallerExtension [jvm]class MiskCallerExtension : BeforeTestExecutionCallback, AfterTestExecutionCallback WebServerTestingModule [jvm]class WebServerTestingModule@JvmOverloadsconstructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true) : KAbstractModuleA module that starts an embedded Jetty web server configured for testing. The server supports both plaintext and TLS. WebTestClient [jvm]class WebTestClient@Injectconstructor(moshi: Moshi, jettyService: JettyService)Use WebTestClient to test calls to the application at the integration level. WithMiskCaller [jvm]@Target(allowedTargets = [AnnotationTarget.CLASS])@ExtendWith(value = [MiskCallerExtension::class])annotation class WithMiskCaller(val user: String = \"\", val service: String = \"\")Use this annotation to specify an ActionScoped for this class."},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/","title":"FakeHttpCall - Misk","text":"//misk-testing/misk.web/FakeHttpCall
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#fakehttpcall","title":"FakeHttpCall","text":"[jvm]\\ data class FakeHttpCall@JvmOverloadsconstructor(val url: HttpUrl = \"https://example.com/\".toHttpUrl(), val linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), val dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, var requestHeaders: Headers = headersOf(), var statusCode: Int = 200, var networkStatusCode: Int = 200, val headersBuilder: Headers.Builder = Headers.Builder(), var sendTrailers: Boolean = false, val trailersBuilder: Headers.Builder = Headers.Builder(), var requestBody: BufferedSource? = Buffer(), var responseBody: BufferedSink? = Buffer(), var webSocket: WebSocket? = null, var webSocketListener: WebSocketListener? = null, var cookies: List<Cookie> = listOf()) : HttpCall
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#constructors","title":"Constructors","text":"FakeHttpCall [jvm]@JvmOverloadsconstructor(url: HttpUrl = \"https://example.com/\".toHttpUrl(), linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, requestHeaders: Headers = headersOf(), statusCode: Int = 200, networkStatusCode: Int = 200, headersBuilder: Headers.Builder = Headers.Builder(), sendTrailers: Boolean = false, trailersBuilder: Headers.Builder = Headers.Builder(), requestBody: BufferedSource? = Buffer(), responseBody: BufferedSink? = Buffer(), webSocket: WebSocket? = null, webSocketListener: WebSocketListener? = null, cookies: List<Cookie> = listOf())"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#properties","title":"Properties","text":"Name Summary cookies [jvm]open override var cookies: List<Cookie> dispatchMechanism [jvm]open override val dispatchMechanism: DispatchMechanism headersBuilder [jvm]val headersBuilder: Headers.Builder linkLayerLocalAddress [jvm]open override val linkLayerLocalAddress: SocketAddress networkStatusCode [jvm]open override var networkStatusCode: Int requestBody [jvm]var requestBody: BufferedSource? requestHeaders [jvm]open override var requestHeaders: Headers responseBody [jvm]var responseBody: BufferedSink? responseHeaders [jvm]open override val responseHeaders: Headers sendTrailers [jvm]var sendTrailers: Boolean statusCode [jvm]open override var statusCode: Int trailersBuilder [jvm]val trailersBuilder: Headers.Builder url [jvm]open override val url: HttpUrl webSocket [jvm]var webSocket: WebSocket? webSocketListener [jvm]var webSocketListener: WebSocketListener?"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/#functions","title":"Functions","text":"Name Summary accepts [jvm]open fun accepts(): List<MediaRange> addResponseHeaders [jvm]open override fun addResponseHeaders(headers: Headers) asOkHttpRequest [jvm]open fun asOkHttpRequest(): Request computeRequestHeader [jvm]open fun computeRequestHeader(name: String, computeFn: (String?) -> Pair<String, String>?) contentType [jvm]open fun contentType(): MediaType? initWebSocketListener [jvm]open override fun initWebSocketListener(webSocketListener: WebSocketListener) putRequestBody [jvm]open override fun putRequestBody(requestBody: BufferedSource) putResponseBody [jvm]open override fun putResponseBody(responseBody: BufferedSink) putWebSocket [jvm]open override fun putWebSocket(webSocket: WebSocket) requireTrailers [jvm]open override fun requireTrailers() setResponseHeader [jvm]open override fun setResponseHeader(name: String, value: String) setResponseTrailer [jvm]open override fun setResponseTrailer(name: String, value: String) setStatusCodes [jvm]open override fun setStatusCodes(statusCode: Int, networkStatusCode: Int) takeRequestBody [jvm]open override fun takeRequestBody(): BufferedSource? takeResponseBody [jvm]open override fun takeResponseBody(): BufferedSink? takeWebSocket [jvm]open override fun takeWebSocket(): WebSocket?"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/-fake-http-call/","title":"FakeHttpCall - Misk","text":"//misk-testing/misk.web/FakeHttpCall/FakeHttpCall
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/-fake-http-call/#fakehttpcall","title":"FakeHttpCall","text":"[jvm]\\
@JvmOverloads
constructor(url: HttpUrl = \"https://example.com/\".toHttpUrl(), linkLayerLocalAddress: SocketAddress = SocketAddress.Network(\"1.2.3.4\", 56789), dispatchMechanism: DispatchMechanism = DispatchMechanism.GET, requestHeaders: Headers = headersOf(), statusCode: Int = 200, networkStatusCode: Int = 200, headersBuilder: Headers.Builder = Headers.Builder(), sendTrailers: Boolean = false, trailersBuilder: Headers.Builder = Headers.Builder(), requestBody: BufferedSource? = Buffer(), responseBody: BufferedSink? = Buffer(), webSocket: WebSocket? = null, webSocketListener: WebSocketListener? = null, cookies: List<Cookie> = listOf())
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/add-response-headers/","title":"addResponseHeaders - Misk","text":"//misk-testing/misk.web/FakeHttpCall/addResponseHeaders
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/add-response-headers/#addresponseheaders","title":"addResponseHeaders","text":"[jvm]\\ open override fun addResponseHeaders(headers: Headers)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/cookies/","title":"cookies - Misk","text":"//misk-testing/misk.web/FakeHttpCall/cookies
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/cookies/#cookies","title":"cookies","text":"[jvm]\\ open override var cookies: List<Cookie>
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/dispatch-mechanism/","title":"dispatchMechanism - Misk","text":"//misk-testing/misk.web/FakeHttpCall/dispatchMechanism
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/dispatch-mechanism/#dispatchmechanism","title":"dispatchMechanism","text":"[jvm]\\ open override val dispatchMechanism: DispatchMechanism
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/headers-builder/","title":"headersBuilder - Misk","text":"//misk-testing/misk.web/FakeHttpCall/headersBuilder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/headers-builder/#headersbuilder","title":"headersBuilder","text":"[jvm]\\ val headersBuilder: Headers.Builder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/init-web-socket-listener/","title":"initWebSocketListener - Misk","text":"//misk-testing/misk.web/FakeHttpCall/initWebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/init-web-socket-listener/#initwebsocketlistener","title":"initWebSocketListener","text":"[jvm]\\ open override fun initWebSocketListener(webSocketListener: WebSocketListener)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/link-layer-local-address/","title":"linkLayerLocalAddress - Misk","text":"//misk-testing/misk.web/FakeHttpCall/linkLayerLocalAddress
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/link-layer-local-address/#linklayerlocaladdress","title":"linkLayerLocalAddress","text":"[jvm]\\ open override val linkLayerLocalAddress: SocketAddress
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/network-status-code/","title":"networkStatusCode - Misk","text":"//misk-testing/misk.web/FakeHttpCall/networkStatusCode
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/network-status-code/#networkstatuscode","title":"networkStatusCode","text":"[jvm]\\ open override var networkStatusCode: Int
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-request-body/","title":"putRequestBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/putRequestBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-request-body/#putrequestbody","title":"putRequestBody","text":"[jvm]\\ open override fun putRequestBody(requestBody: BufferedSource)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-response-body/","title":"putResponseBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/putResponseBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-response-body/#putresponsebody","title":"putResponseBody","text":"[jvm]\\ open override fun putResponseBody(responseBody: BufferedSink)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-web-socket/","title":"putWebSocket - Misk","text":"//misk-testing/misk.web/FakeHttpCall/putWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/put-web-socket/#putwebsocket","title":"putWebSocket","text":"[jvm]\\ open override fun putWebSocket(webSocket: WebSocket)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-body/","title":"requestBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/requestBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-body/#requestbody","title":"requestBody","text":"[jvm]\\ var requestBody: BufferedSource?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-headers/","title":"requestHeaders - Misk","text":"//misk-testing/misk.web/FakeHttpCall/requestHeaders
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/request-headers/#requestheaders","title":"requestHeaders","text":"[jvm]\\ open override var requestHeaders: Headers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/require-trailers/","title":"requireTrailers - Misk","text":"//misk-testing/misk.web/FakeHttpCall/requireTrailers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/require-trailers/#requiretrailers","title":"requireTrailers","text":"[jvm]\\ open override fun requireTrailers()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-body/","title":"responseBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/responseBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-body/#responsebody","title":"responseBody","text":"[jvm]\\ var responseBody: BufferedSink?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-headers/","title":"responseHeaders - Misk","text":"//misk-testing/misk.web/FakeHttpCall/responseHeaders
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/response-headers/#responseheaders","title":"responseHeaders","text":"[jvm]\\ open override val responseHeaders: Headers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/send-trailers/","title":"sendTrailers - Misk","text":"//misk-testing/misk.web/FakeHttpCall/sendTrailers
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/send-trailers/#sendtrailers","title":"sendTrailers","text":"[jvm]\\ var sendTrailers: Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-header/","title":"setResponseHeader - Misk","text":"//misk-testing/misk.web/FakeHttpCall/setResponseHeader
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-header/#setresponseheader","title":"setResponseHeader","text":"[jvm]\\ open override fun setResponseHeader(name: String, value: String)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-trailer/","title":"setResponseTrailer - Misk","text":"//misk-testing/misk.web/FakeHttpCall/setResponseTrailer
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-response-trailer/#setresponsetrailer","title":"setResponseTrailer","text":"[jvm]\\ open override fun setResponseTrailer(name: String, value: String)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-status-codes/","title":"setStatusCodes - Misk","text":"//misk-testing/misk.web/FakeHttpCall/setStatusCodes
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/set-status-codes/#setstatuscodes","title":"setStatusCodes","text":"[jvm]\\ open override fun setStatusCodes(statusCode: Int, networkStatusCode: Int)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/status-code/","title":"statusCode - Misk","text":"//misk-testing/misk.web/FakeHttpCall/statusCode
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/status-code/#statuscode","title":"statusCode","text":"[jvm]\\ open override var statusCode: Int
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-request-body/","title":"takeRequestBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/takeRequestBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-request-body/#takerequestbody","title":"takeRequestBody","text":"[jvm]\\ open override fun takeRequestBody(): BufferedSource?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-response-body/","title":"takeResponseBody - Misk","text":"//misk-testing/misk.web/FakeHttpCall/takeResponseBody
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-response-body/#takeresponsebody","title":"takeResponseBody","text":"[jvm]\\ open override fun takeResponseBody(): BufferedSink?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-web-socket/","title":"takeWebSocket - Misk","text":"//misk-testing/misk.web/FakeHttpCall/takeWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/take-web-socket/#takewebsocket","title":"takeWebSocket","text":"[jvm]\\ open override fun takeWebSocket(): WebSocket?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/trailers-builder/","title":"trailersBuilder - Misk","text":"//misk-testing/misk.web/FakeHttpCall/trailersBuilder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/trailers-builder/#trailersbuilder","title":"trailersBuilder","text":"[jvm]\\ val trailersBuilder: Headers.Builder
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/url/","title":"url - Misk","text":"//misk-testing/misk.web/FakeHttpCall/url
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/url/#url","title":"url","text":"[jvm]\\ open override val url: HttpUrl
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket-listener/","title":"webSocketListener - Misk","text":"//misk-testing/misk.web/FakeHttpCall/webSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket-listener/#websocketlistener","title":"webSocketListener","text":"[jvm]\\ var webSocketListener: WebSocketListener?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket/","title":"webSocket - Misk","text":"//misk-testing/misk.web/FakeHttpCall/webSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-http-call/web-socket/#websocket","title":"webSocket","text":"[jvm]\\ var webSocket: WebSocket?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/","title":"FakeWebSocket - Misk","text":"//misk-testing/misk.web/FakeWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/#fakewebsocket","title":"FakeWebSocket","text":"[jvm]\\ class FakeWebSocket : WebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/#constructors","title":"Constructors","text":"FakeWebSocket [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/#functions","title":"Functions","text":"Name Summary cancel [jvm]open override fun cancel() close [jvm]open override fun close(code: Int, reason: String?): Boolean poll [jvm]fun poll(): String? queueSize [jvm]open override fun queueSize(): Long send [jvm]open override fun send(text: String): Booleanopen override fun send(bytes: ByteString): Boolean"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/-fake-web-socket/","title":"FakeWebSocket - Misk","text":"//misk-testing/misk.web/FakeWebSocket/FakeWebSocket
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/-fake-web-socket/#fakewebsocket","title":"FakeWebSocket","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/cancel/","title":"cancel - Misk","text":"//misk-testing/misk.web/FakeWebSocket/cancel
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/cancel/#cancel","title":"cancel","text":"[jvm]\\ open override fun cancel()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/close/","title":"close - Misk","text":"//misk-testing/misk.web/FakeWebSocket/close
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/close/#close","title":"close","text":"[jvm]\\ open override fun close(code: Int, reason: String?): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/poll/","title":"poll - Misk","text":"//misk-testing/misk.web/FakeWebSocket/poll
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/poll/#poll","title":"poll","text":"[jvm]\\ fun poll(): String?
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/queue-size/","title":"queueSize - Misk","text":"//misk-testing/misk.web/FakeWebSocket/queueSize
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/queue-size/#queuesize","title":"queueSize","text":"[jvm]\\ open override fun queueSize(): Long
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/send/","title":"send - Misk","text":"//misk-testing/misk.web/FakeWebSocket/send
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket/send/#send","title":"send","text":"[jvm]\\ open override fun send(bytes: ByteString): Boolean
open override fun send(text: String): Boolean
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/","title":"FakeWebSocketListener - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#fakewebsocketlistener","title":"FakeWebSocketListener","text":"[jvm]\\ class FakeWebSocketListener : WebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#constructors","title":"Constructors","text":"FakeWebSocketListener [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#properties","title":"Properties","text":"Name Summary messages [jvm]val messages: LinkedBlockingDeque<String>"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/#functions","title":"Functions","text":"Name Summary onClosed [jvm]open fun onClosed(webSocket: WebSocket, code: Int, reason: String) onClosing [jvm]open fun onClosing(webSocket: WebSocket, code: Int, reason: String) onFailure [jvm]open fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?) onMessage [jvm]open override fun onMessage(webSocket: WebSocket, text: String)open fun onMessage(webSocket: WebSocket, bytes: ByteString) onOpen [jvm]open fun onOpen(webSocket: WebSocket, response: Response) takeMessage [jvm]fun takeMessage(): String"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/-fake-web-socket-listener/","title":"FakeWebSocketListener - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/FakeWebSocketListener
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/-fake-web-socket-listener/#fakewebsocketlistener","title":"FakeWebSocketListener","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/messages/","title":"messages - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/messages
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/messages/#messages","title":"messages","text":"[jvm]\\ val messages: LinkedBlockingDeque<String>
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/on-message/","title":"onMessage - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/onMessage
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/on-message/#onmessage","title":"onMessage","text":"[jvm]\\ open override fun onMessage(webSocket: WebSocket, text: String)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/take-message/","title":"takeMessage - Misk","text":"//misk-testing/misk.web/FakeWebSocketListener/takeMessage
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-fake-web-socket-listener/take-message/#takemessage","title":"takeMessage","text":"[jvm]\\ fun takeMessage(): String
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/","title":"MiskCallerExtension - Misk","text":"//misk-testing/misk.web/MiskCallerExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/#miskcallerextension","title":"MiskCallerExtension","text":"[jvm]\\ class MiskCallerExtension : BeforeTestExecutionCallback, AfterTestExecutionCallback
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/#constructors","title":"Constructors","text":"MiskCallerExtension [jvm]constructor()"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/#functions","title":"Functions","text":"Name Summary afterTestExecution [jvm]open override fun afterTestExecution(context: ExtensionContext) beforeTestExecution [jvm]open override fun beforeTestExecution(context: ExtensionContext)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/-misk-caller-extension/","title":"MiskCallerExtension - Misk","text":"//misk-testing/misk.web/MiskCallerExtension/MiskCallerExtension
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/-misk-caller-extension/#miskcallerextension","title":"MiskCallerExtension","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/after-test-execution/","title":"afterTestExecution - Misk","text":"//misk-testing/misk.web/MiskCallerExtension/afterTestExecution
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/after-test-execution/#aftertestexecution","title":"afterTestExecution","text":"[jvm]\\ open override fun afterTestExecution(context: ExtensionContext)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/before-test-execution/","title":"beforeTestExecution - Misk","text":"//misk-testing/misk.web/MiskCallerExtension/beforeTestExecution
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-misk-caller-extension/before-test-execution/#beforetestexecution","title":"beforeTestExecution","text":"[jvm]\\ open override fun beforeTestExecution(context: ExtensionContext)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/","title":"WebServerTestingModule - Misk","text":"//misk-testing/misk.web/WebServerTestingModule
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#webservertestingmodule","title":"WebServerTestingModule","text":"[jvm]\\ class WebServerTestingModule@JvmOverloadsconstructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true) : KAbstractModule
A module that starts an embedded Jetty web server configured for testing. The server supports both plaintext and TLS.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#constructors","title":"Constructors","text":"WebServerTestingModule [jvm]@JvmOverloadsconstructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-web-server-testing-module/","title":"WebServerTestingModule - Misk","text":"//misk-testing/misk.web/WebServerTestingModule/WebServerTestingModule
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-web-server-testing-module/#webservertestingmodule","title":"WebServerTestingModule","text":"[jvm]\\
@JvmOverloads
constructor(webConfig: WebConfig = TESTING_WEB_CONFIG, overrideShutdownTimeout: Boolean = true)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/","title":"Companion - Misk","text":"//misk-testing/misk.web/WebServerTestingModule/Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/#properties","title":"Properties","text":"Name Summary TESTING_WEB_CONFIG [jvm]val TESTING_WEB_CONFIG: WebConfig"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/-t-e-s-t-i-n-g_-w-e-b_-c-o-n-f-i-g/","title":"TESTING_WEB_CONFIG - Misk","text":"//misk-testing/misk.web/WebServerTestingModule/Companion/TESTING_WEB_CONFIG
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-server-testing-module/-companion/-t-e-s-t-i-n-g_-w-e-b_-c-o-n-f-i-g/#testing_web_config","title":"TESTING_WEB_CONFIG","text":"[jvm]\\ val TESTING_WEB_CONFIG: WebConfig
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/","title":"WebTestClient - Misk","text":"//misk-testing/misk.web/WebTestClient
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/#webtestclient","title":"WebTestClient","text":"[jvm]\\ class WebTestClient@Injectconstructor(moshi: Moshi, jettyService: JettyService)
Use WebTestClient to test calls to the application at the integration level.
To use:
@MiskTest(startService = true) to the test class@MiskTestModule val module = TestModule()WebTestingModule to the module under test: install(WebTestingModule())WebTestClient in the test class//misk-testing/misk.web/WebTestClient/WebTestClient
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-client/#webtestclient","title":"WebTestClient","text":"[jvm]\\
@Inject
constructor(moshi: Moshi, jettyService: JettyService)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/call/","title":"call - Misk","text":"//misk-testing/misk.web/WebTestClient/call
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/call/#call","title":"call","text":"[jvm]\\ fun call(path: String, action: Request.Builder.() -> Unit): WebTestClient.WebTestResponse
Performs a call to the started service. Allows the caller to customize the action before it\u2019s sent through.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/get/","title":"get - Misk","text":"//misk-testing/misk.web/WebTestClient/get
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/get/#get","title":"get","text":"[jvm]\\ fun get(path: String): WebTestClient.WebTestResponse
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/post/","title":"post - Misk","text":"//misk-testing/misk.web/WebTestClient/post
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/post/#post","title":"post","text":"[jvm]\\ fun <T : Any> post(path: String, body: T, tClass: KClass<T>): WebTestClient.WebTestResponse
inline fun <T : Any> post(path: String, body: T): WebTestClient.WebTestResponse
Performs a POST request with a JSON request body created from the input.
[jvm]\\
@JvmOverloads
fun post(path: String, body: String, mediaType: MediaType = MediaTypes.APPLICATION_JSON_MEDIA_TYPE): WebTestClient.WebTestResponse
Performs a POST request.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/","title":"WebTestResponse - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#webtestresponse","title":"WebTestResponse","text":"[jvm]\\ data class WebTestResponse(val response: Response, moshi: Moshi)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#constructors","title":"Constructors","text":"WebTestResponse [jvm]constructor(response: Response, moshi: Moshi)"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#properties","title":"Properties","text":"Name Summary response [jvm]val response: Response"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/#functions","title":"Functions","text":"Name Summary parseJson [jvm]inline fun <T : Any> parseJson(): Tfun <T : Any> parseJson(tClass: KClass<T>): T"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/-web-test-response/","title":"WebTestResponse - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse/WebTestResponse
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/-web-test-response/#webtestresponse","title":"WebTestResponse","text":"[jvm]\\ constructor(response: Response, moshi: Moshi)
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/parse-json/","title":"parseJson - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse/parseJson
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/parse-json/#parsejson","title":"parseJson","text":"[jvm]\\ fun <T : Any> parseJson(tClass: KClass<T>): T
inline fun <T : Any> parseJson(): T
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/response/","title":"response - Misk","text":"//misk-testing/misk.web/WebTestClient/WebTestResponse/response
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-web-test-client/-web-test-response/response/#response","title":"response","text":"[jvm]\\ val response: Response
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/","title":"WithMiskCaller - Misk","text":"//misk-testing/misk.web/WithMiskCaller
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/#withmiskcaller","title":"WithMiskCaller","text":"[jvm]\\ @Target(allowedTargets = [AnnotationTarget.CLASS])
@ExtendWith(value = [MiskCallerExtension::class])
annotation class WithMiskCaller(val user: String = \"\", val service: String = \"\")
Use this annotation to specify an ActionScoped for this class.
Annotate after misk.testing.MiskTest.
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/#properties","title":"Properties","text":"Name Summary service [jvm]val service: String user [jvm]val user: String"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/service/","title":"service - Misk","text":"//misk-testing/misk.web/WithMiskCaller/service
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/service/#service","title":"service","text":"[jvm]\\ val service: String
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/user/","title":"user - Misk","text":"//misk-testing/misk.web/WithMiskCaller/user
"},{"location":"0.x/misk-testing/misk-testing/misk.web/-with-misk-caller/user/#user","title":"user","text":"[jvm]\\ val user: String
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/","title":"Package-level declarations - Misk","text":"//misk-testing/org.assertj.core.api
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/#functions","title":"Functions","text":"Name Summary assertOrdering [jvm]fun <A : Comparable<A>> assertOrdering(vararg values: A) containsExactly [jvm]inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE> isEqualToAsJson [jvm]fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/assert-ordering/","title":"assertOrdering - Misk","text":"//misk-testing/org.assertj.core.api/assertOrdering
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/assert-ordering/#assertordering","title":"assertOrdering","text":"[jvm]\\ fun <A : Comparable<A>> assertOrdering(vararg values: A)
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/contains-exactly/","title":"containsExactly - Misk","text":"//misk-testing/org.assertj.core.api/containsExactly
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/contains-exactly/#containsexactly","title":"containsExactly","text":"[jvm]\\ inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE>
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/is-equal-to-as-json/","title":"isEqualToAsJson - Misk","text":"//misk-testing/org.assertj.core.api/isEqualToAsJson
"},{"location":"0.x/misk-testing/misk-testing/org.assertj.core.api/is-equal-to-as-json/#isequaltoasjson","title":"isEqualToAsJson","text":"[jvm]\\ fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>
"},{"location":"0.x/misk-testing-api/","title":"misk-testing-api - Misk","text":"//misk-testing-api
"},{"location":"0.x/misk-testing-api/#misk-testing-api","title":"misk-testing-api","text":""},{"location":"0.x/misk-testing-api/#packages","title":"Packages","text":"Name misk.testing"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/","title":"Package-level declarations - Misk","text":"//misk-testing-api/misk.testing
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/#types","title":"Types","text":"Name Summary FakeFixture [jvm]open class FakeFixture : TestFixtureBase class providing a mechanism to define properties in fakes that will automatically be reset between test runs. The properties are defined using theresettable function, which creates a resettable property delegate. ResettablePropertyDelegate [jvm]class ResettablePropertyDelegate<T>(initializer: () -> T) TestFixture [jvm]interface TestFixtureInterface for test fixtures that need to be reset between test runs, when the reuse injector feature is enabled."},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/","title":"FakeFixture - Misk","text":"//misk-testing-api/misk.testing/FakeFixture
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/#fakefixture","title":"FakeFixture","text":"[jvm]\\ open class FakeFixture : TestFixture
Base class providing a mechanism to define properties in fakes that will automatically be reset between test runs. The properties are defined using the resettable function, which creates a resettable property delegate.
class FakeJwtVerifier @Inject constructor() : JwtVerifier, FakeFixture() {\n - private var succeeds = true\n + private var succeeds by resettable { true }\n\n // more methods\n}\n//misk-testing-api/misk.testing/FakeFixture/FakeFixture
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/-fake-fixture/#fakefixture","title":"FakeFixture","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/reset/","title":"reset - Misk","text":"//misk-testing-api/misk.testing/FakeFixture/reset
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
Called before each test run to reset the state of the fixture.
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/resettable/","title":"resettable - Misk","text":"//misk-testing-api/misk.testing/FakeFixture/resettable
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-fake-fixture/resettable/#resettable","title":"resettable","text":"[jvm]\\ fun <T> resettable(initializer: () -> T): ResettablePropertyDelegate<T>
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/","title":"ResettablePropertyDelegate - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/#resettablepropertydelegate","title":"ResettablePropertyDelegate","text":"[jvm]\\ class ResettablePropertyDelegate<T>(initializer: () -> T)
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/#constructors","title":"Constructors","text":"ResettablePropertyDelegate [jvm]constructor(initializer: () -> T)"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/#functions","title":"Functions","text":"Name Summary getValue [jvm]operator fun getValue(thisRef: Any?, property: KProperty<*>): T reset [jvm]fun reset() setValue [jvm]operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T)"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/-resettable-property-delegate/","title":"ResettablePropertyDelegate - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/ResettablePropertyDelegate
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/-resettable-property-delegate/#resettablepropertydelegate","title":"ResettablePropertyDelegate","text":"[jvm]\\ constructor(initializer: () -> T)
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/get-value/","title":"getValue - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/getValue
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/get-value/#getvalue","title":"getValue","text":"[jvm]\\ operator fun getValue(thisRef: Any?, property: KProperty<*>): T
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/reset/","title":"reset - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/reset
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/reset/#reset","title":"reset","text":"[jvm]\\ fun reset()
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/set-value/","title":"setValue - Misk","text":"//misk-testing-api/misk.testing/ResettablePropertyDelegate/setValue
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-resettable-property-delegate/set-value/#setvalue","title":"setValue","text":"[jvm]\\ operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T)
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-test-fixture/","title":"TestFixture - Misk","text":"//misk-testing-api/misk.testing/TestFixture
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-test-fixture/#testfixture","title":"TestFixture","text":"interface TestFixture
Interface for test fixtures that need to be reset between test runs, when the reuse injector feature is enabled.
This needs to be implemented by:
vars or mutable collections. The reset implementation should set the state to the initial values. In such case, prefer extending the DelegatedPropertiesTestFixture class instead.reset implementation needs to clear the store.TestFixtures must be multibound in a Guice module to ensure that the test infrastructure can reset them between test runs. For example:
bind<Clock>().to<FakeClock>()\n + multibind<TestFixture>().to<FakeClock>()\n//misk-testing-api/misk.testing/TestFixture/reset
"},{"location":"0.x/misk-testing-api/misk-testing-api/misk.testing/-test-fixture/reset/#reset","title":"reset","text":"[jvm]\\ abstract fun reset()
Called before each test run to reset the state of the fixture.
"},{"location":"0.x/misk-warmup/","title":"misk-warmup - Misk","text":"//misk-warmup
"},{"location":"0.x/misk-warmup/#misk-warmup","title":"misk-warmup","text":""},{"location":"0.x/misk-warmup/#packages","title":"Packages","text":"Name misk.warmup"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/","title":"Package-level declarations - Misk","text":"//misk-warmup/misk.warmup
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/#types","title":"Types","text":"Name Summary WarmupModule [jvm]class WarmupModule(name: String, key: Key<out WarmupTask>) : KAbstractModule WarmupTask [jvm]abstract class WarmupTaskRegister a warmup task in your service with the following:"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/#functions","title":"Functions","text":"Name Summary WarmupModule [jvm]inline fun <T : WarmupTask> WarmupModule(qualifier: KClass<out Annotation>? = null): WarmupModule"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/","title":"WarmupModule - Misk","text":"//misk-warmup/misk.warmup/WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#warmupmodule","title":"WarmupModule","text":"[jvm]\\ inline fun <T : WarmupTask> WarmupModule(qualifier: KClass<out Annotation>? = null): WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/","title":"WarmupModule - Misk","text":"//misk-warmup/misk.warmup/WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#warmupmodule","title":"WarmupModule","text":"[jvm]\\ class WarmupModule(name: String, key: Key<out WarmupTask>) : KAbstractModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#constructors","title":"Constructors","text":"WarmupModule [jvm]constructor(name: String, key: Key<out WarmupTask>)"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/#functions","title":"Functions","text":"Name Summary configure [jvm]override fun configure(builder: Binder)"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/-warmup-module/","title":"WarmupModule - Misk","text":"//misk-warmup/misk.warmup/WarmupModule/WarmupModule
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-module/-warmup-module/#warmupmodule","title":"WarmupModule","text":"[jvm]\\ constructor(name: String, key: Key<out WarmupTask>)
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/","title":"WarmupTask - Misk","text":"//misk-warmup/misk.warmup/WarmupTask
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/#warmuptask","title":"WarmupTask","text":"[jvm]\\ abstract class WarmupTask
Register a warmup task in your service with the following:
install(WarmupModule<MyWarmupTask>())\nMisk will run the task after all services have started successfully, but before health checks report the service as healthy. Warm up tasks should complete quickly (under 10 seconds is best) because the service won\u2019t serve live traffic until all warm up tasks complete.
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/#constructors","title":"Constructors","text":"WarmupTask [jvm]constructor()"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/#functions","title":"Functions","text":"Name Summary execute [jvm]abstract fun execute()Perform production-like work to cause caches to be seeded, pools to be filled, and hot spots to be compiled. This should return once warmup is complete."},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/-warmup-task/","title":"WarmupTask - Misk","text":"//misk-warmup/misk.warmup/WarmupTask/WarmupTask
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/-warmup-task/#warmuptask","title":"WarmupTask","text":"[jvm]\\ constructor()
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/execute/","title":"execute - Misk","text":"//misk-warmup/misk.warmup/WarmupTask/execute
"},{"location":"0.x/misk-warmup/misk-warmup/misk.warmup/-warmup-task/execute/#execute","title":"execute","text":"[jvm]\\ abstract fun execute()
Perform production-like work to cause caches to be seeded, pools to be filled, and hot spots to be compiled. This should return once warmup is complete.
"},{"location":"0.x/wisp-aws-environment/","title":"wisp-aws-environment - Misk","text":"//wisp-aws-environment
"},{"location":"0.x/wisp-aws-environment/#wisp-aws-environment","title":"wisp-aws-environment","text":""},{"location":"0.x/wisp-aws-environment/#packages","title":"Packages","text":"Name wisp.aws.environment"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/","title":"Package-level declarations - Misk","text":"//wisp-aws-environment/wisp.aws.environment
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/#types","title":"Types","text":"Name Summary AwsAccountId [jvm]data class AwsAccountId(val value: String)AwsAccountId is the id of the account in which the service is running AwsEnvironment [jvm]object AwsEnvironmentAwsEnvironment pulls region and account information from installed environment variables AwsRegion [jvm]data class AwsRegion(val name: String)AwsRegion is the region in which the service is running"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/","title":"AwsAccountId - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ data class AwsAccountId(val value: String)
AwsAccountId is the id of the account in which the service is running
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/#constructors","title":"Constructors","text":"AwsAccountId [jvm]constructor(value: String)"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/#properties","title":"Properties","text":"Name Summary value [jvm]val value: String"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/-aws-account-id/","title":"AwsAccountId - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsAccountId/AwsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/-aws-account-id/#awsaccountid","title":"AwsAccountId","text":"[jvm]\\ constructor(value: String)
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/value/","title":"value - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsAccountId/value
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-account-id/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/","title":"AwsEnvironment - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsEnvironment
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/#awsenvironment","title":"AwsEnvironment","text":"[jvm]\\ object AwsEnvironment
AwsEnvironment pulls region and account information from installed environment variables
Note: Because of different package names for AWS1 vs AWS2 sdks, we can\u2019t use AWS\u2019s Region class.
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/#functions","title":"Functions","text":"Name Summary awsAccountId [jvm]fun awsAccountId(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariable: String = \"ACCOUNT_ID\"): AwsAccountId awsRegion [jvm]fun awsRegion(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariables: List<String> = listOf(\"REGION\", \"AWS_REGION\"), defaultAwsRegion: String = \"us-west-2\"): AwsRegion"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-account-id/","title":"awsAccountId - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsEnvironment/awsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-account-id/#awsaccountid","title":"awsAccountId","text":"[jvm]\\ fun awsAccountId(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariable: String = \"ACCOUNT_ID\"): AwsAccountId
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-region/","title":"awsRegion - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsEnvironment/awsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-environment/aws-region/#awsregion","title":"awsRegion","text":"[jvm]\\ fun awsRegion(environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real, environmentVariables: List<String> = listOf(\"REGION\", \"AWS_REGION\"), defaultAwsRegion: String = \"us-west-2\"): AwsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/","title":"AwsRegion - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ data class AwsRegion(val name: String)
AwsRegion is the region in which the service is running
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/#constructors","title":"Constructors","text":"AwsRegion [jvm]constructor(name: String)"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/-aws-region/","title":"AwsRegion - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsRegion/AwsRegion
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/-aws-region/#awsregion","title":"AwsRegion","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/name/","title":"name - Misk","text":"//wisp-aws-environment/wisp.aws.environment/AwsRegion/name
"},{"location":"0.x/wisp-aws-environment/wisp-aws-environment/wisp.aws.environment/-aws-region/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-client/","title":"wisp-client - Misk","text":"//wisp-client
"},{"location":"0.x/wisp-client/#wisp-client","title":"wisp-client","text":""},{"location":"0.x/wisp-client/#packages","title":"Packages","text":"Name wisp.client"},{"location":"0.x/wisp-client/wisp-client/wisp.client/","title":"Package-level declarations - Misk","text":"//wisp-client/wisp.client
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-client/wisp-client/wisp.client/#types","title":"Types","text":"Name Summary EnvoyClientEndpointProvider [jvm]interface EnvoyClientEndpointProviderEnvoy configuration provider per endpoint that wisp clients can customize to their needs. HttpClientConfig [jvm]data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null) HttpClientEndpointConfig [jvm]data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig()) HttpClientEnvoyConfig [jvm]data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null) HttpClientFactory [jvm]class HttpClientFactory@JvmOverloadsconstructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null) HttpClientsConfig [jvm]data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf()) HttpClientSSLConfig [jvm]data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig) NoOpDns [jvm]object NoOpDns : Dns OkHttpClientCommonConfigurator [jvm]class OkHttpClientCommonConfigurator UnixDomainServerSocketFactory [jvm]class UnixDomainServerSocketFactory : ServerSocketFactoryImpersonate TCP-style ServerSocketFactory over UNIX domain sockets. UnixDomainSocketFactory [jvm]class UnixDomainSocketFactory : SocketFactoryImpersonate TCP-style SocketFactory over UNIX domain sockets."},{"location":"0.x/wisp-client/wisp-client/wisp.client/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/apply-defaults/","title":"applyDefaults - Misk","text":"//wisp-client/wisp.client/applyDefaults
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/apply-defaults/#applydefaults","title":"applyDefaults","text":"[jvm]\\ fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/","title":"EnvoyClientEndpointProvider - Misk","text":"//wisp-client/wisp.client/EnvoyClientEndpointProvider
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/#envoyclientendpointprovider","title":"EnvoyClientEndpointProvider","text":"[jvm]\\ interface EnvoyClientEndpointProvider
Envoy configuration provider per endpoint that wisp clients can customize to their needs.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/#functions","title":"Functions","text":"Name Summary unixSocket [jvm]abstract fun unixSocket(httpClientEnvoyConfig: HttpClientEnvoyConfig): FileUnix socket file to be used to communicate to the local Envoy sidecar. url [jvm]abstract fun url(httpClientEnvoyConfig: HttpClientEnvoyConfig): StringHost header that will be used to route the request."},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/unix-socket/","title":"unixSocket - Misk","text":"//wisp-client/wisp.client/EnvoyClientEndpointProvider/unixSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/unix-socket/#unixsocket","title":"unixSocket","text":"[jvm]\\ abstract fun unixSocket(httpClientEnvoyConfig: HttpClientEnvoyConfig): File
Unix socket file to be used to communicate to the local Envoy sidecar.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/url/","title":"url - Misk","text":"//wisp-client/wisp.client/EnvoyClientEndpointProvider/url
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-envoy-client-endpoint-provider/url/#url","title":"url","text":"[jvm]\\ abstract fun url(httpClientEnvoyConfig: HttpClientEnvoyConfig): String
Host header that will be used to route the request.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/","title":"HttpClientConfig - Misk","text":"//wisp-client/wisp.client/HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\ data class HttpClientConfig@JvmOverloadsconstructor(val connectTimeout: Duration? = null, val writeTimeout: Duration? = null, val readTimeout: Duration? = null, val pingInterval: Duration? = null, val callTimeout: Duration? = null, val maxRequests: Int? = null, val maxRequestsPerHost: Int? = null, val maxIdleConnections: Int? = null, val keepAliveDuration: Duration? = null, val ssl: HttpClientSSLConfig? = null, val unixSocketFile: String? = null, val protocols: List<String>? = null, val retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#constructors","title":"Constructors","text":"HttpClientConfig [jvm]@JvmOverloadsconstructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#properties","title":"Properties","text":"Name Summary callTimeout [jvm]val callTimeout: Duration? = null connectTimeout [jvm]val connectTimeout: Duration? = null keepAliveDuration [jvm]val keepAliveDuration: Duration? = null maxIdleConnections [jvm]val maxIdleConnections: Int? = null maxRequests [jvm]val maxRequests: Int? = null maxRequestsPerHost [jvm]val maxRequestsPerHost: Int? = null pingInterval [jvm]val pingInterval: Duration? = null protocols [jvm]val protocols: List<String>? = null readTimeout [jvm]val readTimeout: Duration? = null retryOnConnectionFailure [jvm]val retryOnConnectionFailure: Boolean? = null ssl [jvm]val ssl: HttpClientSSLConfig? = null unixSocketFile [jvm]val unixSocketFile: String? = null writeTimeout [jvm]val writeTimeout: Duration? = null"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/#functions","title":"Functions","text":"Name Summary applyDefaults [jvm]fun HttpClientConfig.applyDefaults(other: HttpClientConfig): HttpClientConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/-http-client-config/","title":"HttpClientConfig - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/-http-client-config/#httpclientconfig","title":"HttpClientConfig","text":"[jvm]\\
@JvmOverloads
constructor(connectTimeout: Duration? = null, writeTimeout: Duration? = null, readTimeout: Duration? = null, pingInterval: Duration? = null, callTimeout: Duration? = null, maxRequests: Int? = null, maxRequestsPerHost: Int? = null, maxIdleConnections: Int? = null, keepAliveDuration: Duration? = null, ssl: HttpClientSSLConfig? = null, unixSocketFile: String? = null, protocols: List<String>? = null, retryOnConnectionFailure: Boolean? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/call-timeout/","title":"callTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/callTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/call-timeout/#calltimeout","title":"callTimeout","text":"[jvm]\\ val callTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/connect-timeout/","title":"connectTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/connectTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/connect-timeout/#connecttimeout","title":"connectTimeout","text":"[jvm]\\ val connectTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/keepAliveDuration
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/maxIdleConnections
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ val maxIdleConnections: Int? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests-per-host/","title":"maxRequestsPerHost - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/maxRequestsPerHost
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests-per-host/#maxrequestsperhost","title":"maxRequestsPerHost","text":"[jvm]\\ val maxRequestsPerHost: Int? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests/","title":"maxRequests - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/maxRequests
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/max-requests/#maxrequests","title":"maxRequests","text":"[jvm]\\ val maxRequests: Int? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ping-interval/","title":"pingInterval - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/pingInterval
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ping-interval/#pinginterval","title":"pingInterval","text":"[jvm]\\ val pingInterval: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/protocols/","title":"protocols - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/protocols
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/protocols/#protocols","title":"protocols","text":"[jvm]\\ val protocols: List<String>? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/read-timeout/","title":"readTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/readTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/read-timeout/#readtimeout","title":"readTimeout","text":"[jvm]\\ val readTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/retryOnConnectionFailure
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"[jvm]\\ val retryOnConnectionFailure: Boolean? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ssl/","title":"ssl - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/ssl
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/unix-socket-file/","title":"unixSocketFile - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/unixSocketFile
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/unix-socket-file/#unixsocketfile","title":"unixSocketFile","text":"[jvm]\\ val unixSocketFile: String? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/write-timeout/","title":"writeTimeout - Misk","text":"//wisp-client/wisp.client/HttpClientConfig/writeTimeout
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-config/write-timeout/#writetimeout","title":"writeTimeout","text":"[jvm]\\ val writeTimeout: Duration? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\ data class HttpClientEndpointConfig@JvmOverloadsconstructor(val url: String? = null, val envoy: HttpClientEnvoyConfig? = null, val clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/#constructors","title":"Constructors","text":"HttpClientEndpointConfig [jvm]@JvmOverloadsconstructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/#properties","title":"Properties","text":"Name Summary clientConfig [jvm]val clientConfig: HttpClientConfig envoy [jvm]val envoy: HttpClientEnvoyConfig? = null url [jvm]val url: String? = null"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/-http-client-endpoint-config/","title":"HttpClientEndpointConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/-http-client-endpoint-config/#httpclientendpointconfig","title":"HttpClientEndpointConfig","text":"[jvm]\\
@JvmOverloads
constructor(url: String? = null, envoy: HttpClientEnvoyConfig? = null, clientConfig: HttpClientConfig = HttpClientConfig())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/client-config/","title":"clientConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/clientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/client-config/#clientconfig","title":"clientConfig","text":"[jvm]\\ val clientConfig: HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/envoy/","title":"envoy - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/envoy
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/envoy/#envoy","title":"envoy","text":"[jvm]\\ val envoy: HttpClientEnvoyConfig? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/url/","title":"url - Misk","text":"//wisp-client/wisp.client/HttpClientEndpointConfig/url
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-endpoint-config/url/#url","title":"url","text":"[jvm]\\ val url: String? = null
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\ data class HttpClientEnvoyConfig@JvmOverloadsconstructor(val app: String, val env: String? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/#constructors","title":"Constructors","text":"HttpClientEnvoyConfig [jvm]@JvmOverloadsconstructor(app: String, env: String? = null)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/#properties","title":"Properties","text":"Name Summary app [jvm]val app: String env [jvm]val env: String? = nullEnvironment to target. If null, the same environment as the app is running in is assumed."},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/-http-client-envoy-config/","title":"HttpClientEnvoyConfig - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig/HttpClientEnvoyConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/-http-client-envoy-config/#httpclientenvoyconfig","title":"HttpClientEnvoyConfig","text":"[jvm]\\
@JvmOverloads
constructor(app: String, env: String? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/app/","title":"app - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig/app
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/app/#app","title":"app","text":"[jvm]\\ val app: String
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/env/","title":"env - Misk","text":"//wisp-client/wisp.client/HttpClientEnvoyConfig/env
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-envoy-config/env/#env","title":"env","text":"[jvm]\\ val env: String? = null
Environment to target. If null, the same environment as the app is running in is assumed.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//wisp-client/wisp.client/HttpClientFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\ class HttpClientFactory@JvmOverloadsconstructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#constructors","title":"Constructors","text":"HttpClientFactory [jvm]@JvmOverloadsconstructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/#functions","title":"Functions","text":"Name Summary create [jvm]fun create(config: HttpClientEndpointConfig): OkHttpClientReturns a client initialized based onconfig."},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/-http-client-factory/","title":"HttpClientFactory - Misk","text":"//wisp-client/wisp.client/HttpClientFactory/HttpClientFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/-http-client-factory/#httpclientfactory","title":"HttpClientFactory","text":"[jvm]\\
@JvmOverloads
constructor(sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM), sslContextFactory: SslContextFactory = SslContextFactory(sslLoader), okHttpClientCommonConfigurator: OkHttpClientCommonConfigurator = OkHttpClientCommonConfigurator(), envoyClientEndpointProvider: EnvoyClientEndpointProvider? = null, okhttpInterceptors: List<Interceptor>? = null)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/create/","title":"create - Misk","text":"//wisp-client/wisp.client/HttpClientFactory/create
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/create/#create","title":"create","text":"[jvm]\\ fun create(config: HttpClientEndpointConfig): OkHttpClient
Returns a client initialized based on config.
//wisp-client/wisp.client/HttpClientFactory/Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-factory/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ data class HttpClientSSLConfig(val cert_store: CertStoreConfig?, val trust_store: TrustStoreConfig)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/#constructors","title":"Constructors","text":"HttpClientSSLConfig [jvm]constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/#properties","title":"Properties","text":"Name Summary cert_store [jvm]val cert_store: CertStoreConfig? trust_store [jvm]val trust_store: TrustStoreConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/-http-client-s-s-l-config/","title":"HttpClientSSLConfig - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig/HttpClientSSLConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/-http-client-s-s-l-config/#httpclientsslconfig","title":"HttpClientSSLConfig","text":"[jvm]\\ constructor(cert_store: CertStoreConfig?, trust_store: TrustStoreConfig)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/cert_store/","title":"cert_store - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig/cert_store
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/cert_store/#cert_store","title":"cert_store","text":"[jvm]\\ val cert_store: CertStoreConfig?
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/trust_store/","title":"trust_store - Misk","text":"//wisp-client/wisp.client/HttpClientSSLConfig/trust_store
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-client-s-s-l-config/trust_store/#trust_store","title":"trust_store","text":"[jvm]\\ val trust_store: TrustStoreConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\ data class HttpClientsConfig@JvmOverloadsconstructor(val hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), val endpoints: Map<String, HttpClientEndpointConfig> = mapOf())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#constructors","title":"Constructors","text":"HttpClientsConfig [jvm]@JvmOverloadsconstructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf())"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#properties","title":"Properties","text":"Name Summary endpoints [jvm]val endpoints: Map<String, HttpClientEndpointConfig> hostConfigs [jvm]val hostConfigs: LinkedHashMap<String, HttpClientConfig>"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/#functions","title":"Functions","text":"Name Summary endpointNames [jvm]fun endpointNames(): Set<String>Names of configured endpoints, all of which can be fetched using get get [jvm]operator fun get(url: URL): HttpClientEndpointConfigoperator fun get(clientName: String): HttpClientEndpointConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-http-clients-config/","title":"HttpClientsConfig - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/HttpClientsConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-http-clients-config/#httpclientsconfig","title":"HttpClientsConfig","text":"[jvm]\\
@JvmOverloads
constructor(hostConfigs: LinkedHashMap<String, HttpClientConfig> = linkedMapOf(), endpoints: Map<String, HttpClientEndpointConfig> = mapOf())
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoint-names/","title":"endpointNames - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/endpointNames
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoint-names/#endpointnames","title":"endpointNames","text":"[jvm]\\ fun endpointNames(): Set<String>
Names of configured endpoints, all of which can be fetched using get
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoints/","title":"endpoints - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/endpoints
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/endpoints/#endpoints","title":"endpoints","text":"[jvm]\\ val endpoints: Map<String, HttpClientEndpointConfig>
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/","title":"get - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/get
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/#get","title":"get","text":"[jvm]\\ operator fun get(clientName: String): HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/#return","title":"Return","text":"The HttpClientEndpointConfig for the given client, populated with defaults as needed
[jvm]\\ operator fun get(url: URL): HttpClientEndpointConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/get/#return_1","title":"Return","text":"The HttpClientEndpointConfig for the given URL, populated with defaults as needed
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/host-configs/","title":"hostConfigs - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/hostConfigs
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/host-configs/#hostconfigs","title":"hostConfigs","text":"[jvm]\\ val hostConfigs: LinkedHashMap<String, HttpClientConfig>
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/","title":"Companion - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/#properties","title":"Properties","text":"Name Summary httpClientConfigDefaults [jvm]val httpClientConfigDefaults: HttpClientConfig"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/http-client-config-defaults/","title":"httpClientConfigDefaults - Misk","text":"//wisp-client/wisp.client/HttpClientsConfig/Companion/httpClientConfigDefaults
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-http-clients-config/-companion/http-client-config-defaults/#httpclientconfigdefaults","title":"httpClientConfigDefaults","text":"[jvm]\\ val httpClientConfigDefaults: HttpClientConfig
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/","title":"NoOpDns - Misk","text":"//wisp-client/wisp.client/NoOpDns
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/#noopdns","title":"NoOpDns","text":"[jvm]\\ object NoOpDns : Dns
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/#functions","title":"Functions","text":"Name Summary lookup [jvm]open override fun lookup(hostname: String): List<InetAddress>"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/lookup/","title":"lookup - Misk","text":"//wisp-client/wisp.client/NoOpDns/lookup
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-no-op-dns/lookup/#lookup","title":"lookup","text":"[jvm]\\ open override fun lookup(hostname: String): List<InetAddress>
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\ class OkHttpClientCommonConfigurator
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#constructors","title":"Constructors","text":"OkHttpClientCommonConfigurator [jvm]constructor()"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/#functions","title":"Functions","text":"Name Summary configure [jvm]fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/","title":"OkHttpClientCommonConfigurator - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/OkHttpClientCommonConfigurator
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-ok-http-client-common-configurator/#okhttpclientcommonconfigurator","title":"OkHttpClientCommonConfigurator","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/configure/","title":"configure - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/configure
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/configure/#configure","title":"configure","text":"[jvm]\\ fun configure(builder: OkHttpClient.Builder, config: HttpClientEndpointConfig): OkHttpClient.Builder
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/","title":"Companion - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/#properties","title":"Properties","text":"Name Summary keepAliveDuration [jvm]val keepAliveDuration: Duration maxIdleConnections [jvm]const val maxIdleConnections: Int = 5 retryOnConnectionFailure [jvm]const val retryOnConnectionFailure: Boolean = false"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/keep-alive-duration/","title":"keepAliveDuration - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion/keepAliveDuration
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/keep-alive-duration/#keepaliveduration","title":"keepAliveDuration","text":"[jvm]\\ val keepAliveDuration: Duration
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/max-idle-connections/","title":"maxIdleConnections - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion/maxIdleConnections
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/max-idle-connections/#maxidleconnections","title":"maxIdleConnections","text":"[jvm]\\ const val maxIdleConnections: Int = 5
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/retry-on-connection-failure/","title":"retryOnConnectionFailure - Misk","text":"//wisp-client/wisp.client/OkHttpClientCommonConfigurator/Companion/retryOnConnectionFailure
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-ok-http-client-common-configurator/-companion/retry-on-connection-failure/#retryonconnectionfailure","title":"retryOnConnectionFailure","text":"[jvm]\\ const val retryOnConnectionFailure: Boolean = false
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/","title":"UnixDomainServerSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainServerSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/#unixdomainserversocketfactory","title":"UnixDomainServerSocketFactory","text":"[jvm]\\ class UnixDomainServerSocketFactory : ServerSocketFactory
Impersonate TCP-style ServerSocketFactory over UNIX domain sockets.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/#constructors","title":"Constructors","text":"UnixDomainServerSocketFactory [jvm]constructor(path: File)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/#functions","title":"Functions","text":"Name Summary createServerSocket [jvm]open fun createServerSocket(): ServerSocketopen fun createServerSocket(port: Int): ServerSocketopen fun createServerSocket(port: Int, backlog: Int): ServerSocketopen fun createServerSocket(port: Int, backlog: Int, inetAddress: InetAddress): ServerSocket getDefault [jvm]open fun getDefault(): ServerSocketFactory"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/-unix-domain-server-socket-factory/","title":"UnixDomainServerSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainServerSocketFactory/UnixDomainServerSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/-unix-domain-server-socket-factory/#unixdomainserversocketfactory","title":"UnixDomainServerSocketFactory","text":"[jvm]\\ constructor(path: File)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/create-server-socket/","title":"createServerSocket - Misk","text":"//wisp-client/wisp.client/UnixDomainServerSocketFactory/createServerSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-server-socket-factory/create-server-socket/#createserversocket","title":"createServerSocket","text":"[jvm]\\ open fun createServerSocket(): ServerSocket
open fun createServerSocket(port: Int): ServerSocket
open fun createServerSocket(port: Int, backlog: Int): ServerSocket
open fun createServerSocket(port: Int, backlog: Int, inetAddress: InetAddress): ServerSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/","title":"UnixDomainSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/#unixdomainsocketfactory","title":"UnixDomainSocketFactory","text":"[jvm]\\ class UnixDomainSocketFactory : SocketFactory
Impersonate TCP-style SocketFactory over UNIX domain sockets.
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/#constructors","title":"Constructors","text":"UnixDomainSocketFactory [jvm]constructor(path: File)"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/#functions","title":"Functions","text":"Name Summary createSocket [jvm]open fun createSocket(): Socketopen fun createSocket(host: String, port: Int): Socketopen fun createSocket(host: InetAddress, port: Int): Socketopen fun createSocket(host: String, port: Int, localHost: InetAddress, localPort: Int): Socketopen fun createSocket(host: InetAddress, port: Int, localAddress: InetAddress, localPort: Int): Socket getDefault [jvm]open fun getDefault(): SocketFactory"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/-unix-domain-socket-factory/","title":"UnixDomainSocketFactory - Misk","text":"//wisp-client/wisp.client/UnixDomainSocketFactory/UnixDomainSocketFactory
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/-unix-domain-socket-factory/#unixdomainsocketfactory","title":"UnixDomainSocketFactory","text":"[jvm]\\ constructor(path: File)
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/create-socket/","title":"createSocket - Misk","text":"//wisp-client/wisp.client/UnixDomainSocketFactory/createSocket
"},{"location":"0.x/wisp-client/wisp-client/wisp.client/-unix-domain-socket-factory/create-socket/#createsocket","title":"createSocket","text":"[jvm]\\ open fun createSocket(): Socket
open fun createSocket(host: String, port: Int): Socket
open fun createSocket(host: String, port: Int, localHost: InetAddress, localPort: Int): Socket
open fun createSocket(host: InetAddress, port: Int): Socket
open fun createSocket(host: InetAddress, port: Int, localAddress: InetAddress, localPort: Int): Socket
"},{"location":"0.x/wisp-config/","title":"wisp-config - Misk","text":"//wisp-config
"},{"location":"0.x/wisp-config/#wisp-config","title":"wisp-config","text":""},{"location":"0.x/wisp-config/#packages","title":"Packages","text":"Name wisp.config"},{"location":"0.x/wisp-config/wisp-config/wisp.config/","title":"Package-level declarations - Misk","text":"//wisp-config/wisp.config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-config/wisp-config/wisp.config/#types","title":"Types","text":"Name Summary Config [jvm]interface Config ConfigSource [jvm]data class ConfigSource@JvmOverloadsconstructor(val configLocation: String, val format: String = \"yml\")Config location and format (default yaml). The location should be in a format that ResourceLoader understands. Configurable [jvm]interface Configurable<T : Config> PrefixResourceLoaderPreprocessor [jvm]class PrefixResourceLoaderPreprocessor@JvmOverloadsconstructor(val prefix: String, val resourceLoader: ResourceLoader = ResourceLoader.SYSTEM) : TraversingPrimitivePreprocessorPreprocessor for a config node. If the node is a StringNode and the value starts with the prefix, then the node value is treated as a resource location. This is loaded using the resourceLoader and returned as a StringNode. WispConfig [jvm]object WispConfigWispConfig is a wrapper around the Hoplite config library: https://github.com/sksamuel/hoplite"},{"location":"0.x/wisp-config/wisp-config/wisp.config/#functions","title":"Functions","text":"Name Summary addWispConfigSources [jvm]fun ConfigLoaderBuilder.addWispConfigSources(configSources: List<ConfigSource>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): ConfigLoaderBuilderAdd the config sources in the order supplied. If the config source location does not exist it is silently skipped, i.e. the config locations are optional."},{"location":"0.x/wisp-config/wisp-config/wisp.config/add-wisp-config-sources/","title":"addWispConfigSources - Misk","text":"//wisp-config/wisp.config/addWispConfigSources
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/add-wisp-config-sources/#addwispconfigsources","title":"addWispConfigSources","text":"[jvm]\\ fun ConfigLoaderBuilder.addWispConfigSources(configSources: List<ConfigSource>, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM): ConfigLoaderBuilder
Add the config sources in the order supplied. If the config source location does not exist it is silently skipped, i.e. the config locations are optional.
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config/","title":"Config - Misk","text":"//wisp-config/wisp.config/Config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config/#config","title":"Config","text":"[jvm]\\ interface Config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/","title":"ConfigSource - Misk","text":"//wisp-config/wisp.config/ConfigSource
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/#configsource","title":"ConfigSource","text":"[jvm]\\ data class ConfigSource@JvmOverloadsconstructor(val configLocation: String, val format: String = \"yml\")
Config location and format (default yaml). The location should be in a format that ResourceLoader understands.
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/#constructors","title":"Constructors","text":"ConfigSource [jvm]@JvmOverloadsconstructor(configLocation: String, format: String = \"yml\")"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/#properties","title":"Properties","text":"Name Summary configLocation [jvm]val configLocation: String format [jvm]val format: String"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/-config-source/","title":"ConfigSource - Misk","text":"//wisp-config/wisp.config/ConfigSource/ConfigSource
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/-config-source/#configsource","title":"ConfigSource","text":"[jvm]\\
@JvmOverloads
constructor(configLocation: String, format: String = \"yml\")
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/config-location/","title":"configLocation - Misk","text":"//wisp-config/wisp.config/ConfigSource/configLocation
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/config-location/#configlocation","title":"configLocation","text":"[jvm]\\ val configLocation: String
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/format/","title":"format - Misk","text":"//wisp-config/wisp.config/ConfigSource/format
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-config-source/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/","title":"Configurable - Misk","text":"//wisp-config/wisp.config/Configurable
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/#configurable","title":"Configurable","text":"[jvm]\\ interface Configurable<T : Config>
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/#functions","title":"Functions","text":"Name Summary configure [jvm]abstract fun configure(config: T) getConfigClass [jvm]abstract fun getConfigClass(): KClass<T>"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/configure/","title":"configure - Misk","text":"//wisp-config/wisp.config/Configurable/configure
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/configure/#configure","title":"configure","text":"[jvm]\\ abstract fun configure(config: T)
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/get-config-class/","title":"getConfigClass - Misk","text":"//wisp-config/wisp.config/Configurable/getConfigClass
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-configurable/get-config-class/#getconfigclass","title":"getConfigClass","text":"[jvm]\\ abstract fun getConfigClass(): KClass<T>
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/","title":"PrefixResourceLoaderPreprocessor - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#prefixresourceloaderpreprocessor","title":"PrefixResourceLoaderPreprocessor","text":"[jvm]\\ class PrefixResourceLoaderPreprocessor@JvmOverloadsconstructor(val prefix: String, val resourceLoader: ResourceLoader = ResourceLoader.SYSTEM) : TraversingPrimitivePreprocessor
Preprocessor for a config node. If the node is a StringNode and the value starts with the prefix, then the node value is treated as a resource location. This is loaded using the resourceLoader and returned as a StringNode.
prefix is one of ClasspathResourceLoaderBackend.SCHEME, EnvironmentResourceLoaderBackend.SCHEME or FilesystemLoaderBackend.SCHEME
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#constructors","title":"Constructors","text":"PrefixResourceLoaderPreprocessor [jvm]@JvmOverloadsconstructor(prefix: String, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM)"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#properties","title":"Properties","text":"Name Summary prefix [jvm]val prefix: String resourceLoader [jvm]val resourceLoader: ResourceLoader"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/#functions","title":"Functions","text":"Name Summary handle [jvm]open override fun handle(node: PrimitiveNode, context: DecoderContext): ConfigResult<Node> process [jvm]open override fun process(node: Node, context: DecoderContext): ConfigResult<Node>"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/-prefix-resource-loader-preprocessor/","title":"PrefixResourceLoaderPreprocessor - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/PrefixResourceLoaderPreprocessor
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/-prefix-resource-loader-preprocessor/#prefixresourceloaderpreprocessor","title":"PrefixResourceLoaderPreprocessor","text":"[jvm]\\
@JvmOverloads
constructor(prefix: String, resourceLoader: ResourceLoader = ResourceLoader.SYSTEM)
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/handle/","title":"handle - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/handle
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/handle/#handle","title":"handle","text":"[jvm]\\ open override fun handle(node: PrimitiveNode, context: DecoderContext): ConfigResult<Node>
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/prefix/","title":"prefix - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/prefix
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/prefix/#prefix","title":"prefix","text":"[jvm]\\ val prefix: String
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/resource-loader/","title":"resourceLoader - Misk","text":"//wisp-config/wisp.config/PrefixResourceLoaderPreprocessor/resourceLoader
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-prefix-resource-loader-preprocessor/resource-loader/#resourceloader","title":"resourceLoader","text":"[jvm]\\ val resourceLoader: ResourceLoader
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/","title":"WispConfig - Misk","text":"//wisp-config/wisp.config/WispConfig
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/#wispconfig","title":"WispConfig","text":"[jvm]\\ object WispConfig
WispConfig is a wrapper around the Hoplite config library: https://github.com/sksamuel/hoplite
Config precedence is in order of sources added for loading, so if you want an environment config file to override values in the default file, it has to be added first.
Note that config values from Environment Variables, System Properties and User Settings are always loaded first, see: https://github.com/sksamuel/hoplite#property-sources for details.
Secrets in config are automatically handled, see: https://github.com/sksamuel/hoplite#masked-values
Note that if you are passing configuration fragments within Wisp, your config class should implement Config
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/#functions","title":"Functions","text":"Name Summary builder [jvm]fun builder(): ConfigLoaderBuilderGet a config builder."},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/builder/","title":"builder - Misk","text":"//wisp-config/wisp.config/WispConfig/builder
"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/builder/#builder","title":"builder","text":"[jvm]\\ fun builder(): ConfigLoaderBuilder
Get a config builder.
Example use:
val myConfig = WispConfig.builder() \u2026 .addWispConfigSources(\u2026) \u2026 .build() .loadConfigOrThrow() Note that if you are passing configuration fragments within Wisp, MyConfig should implement Config"},{"location":"0.x/wisp-config/wisp-config/wisp.config/-wisp-config/builder/#return","title":"Return","text":"
ConfigLoader.Builder
"},{"location":"0.x/wisp-containers-testing/","title":"wisp-containers-testing - Misk","text":"//wisp-containers-testing
"},{"location":"0.x/wisp-containers-testing/#wisp-containers-testing","title":"wisp-containers-testing","text":""},{"location":"0.x/wisp-containers-testing/#packages","title":"Packages","text":"Name wisp.containers"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/","title":"Package-level declarations - Misk","text":"//wisp-containers-testing/wisp.containers
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/#types","title":"Types","text":"Name Summary Composer [jvm]class Composer(name: String, containers: Container)Composer composes many Containers together to use in a unit test. Container [jvm]data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)A Container creates a Docker container for testing. ContainerUtil [jvm]object ContainerUtil"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/","title":"Composer - Misk","text":"//wisp-containers-testing/wisp.containers/Composer
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/#composer","title":"Composer","text":"[jvm]\\ class Composer(name: String, containers: Container)
Composer composes many Containers together to use in a unit test.
The Containers are networked using a dedicated Docker network. Tests need to expose ports in order for the test to communicate with the containers over 127.0.0.1.
The following example composes Kafka and Zookeeper containers for testing. Kafka is exposed to the jUnit test via 127.0.0.1:9102. In this example, Zookeeper is not exposed to the test.
val zkContainer = Container {\n withImage(\"confluentinc/cp-zookeeper\")\n withName(\"zookeeper\")\n withEnv(\"ZOOKEEPER_CLIENT_PORT=2181\")\n }\n val kafka = Container {\n withImage(\"confluentinc/cp-kafka\")\n withName(\"kafka\")\n withExposedPorts(ExposedPort.tcp(port))\n withPortBindings(Ports().apply {\n bind(ExposedPort.tcp(9102), Ports.Binding.bindPort(9102))\n })\n withEnv(\n \"KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181\",\n \"KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9102\")\n }\n val composer = Composer(\"e-kafka\", zkContainer, kafka)\n composer.start()\n//wisp-containers-testing/wisp.containers/Composer/Composer
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-composer/#composer","title":"Composer","text":"[jvm]\\ constructor(name: String, vararg containers: Container)
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/running/","title":"running - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/running
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/running/#running","title":"running","text":"[jvm]\\ val running: AtomicBoolean
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/start/","title":"start - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/start
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/start/#start","title":"start","text":"[jvm]\\ fun start()
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/stop/","title":"stop - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/stop
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/stop/#stop","title":"stop","text":"[jvm]\\ fun stop()
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/","title":"Companion - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/Companion
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/#properties","title":"Properties","text":"Name Summary dockerClient [jvm]val dockerClient: DockerClient"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/docker-client/","title":"dockerClient - Misk","text":"//wisp-containers-testing/wisp.containers/Composer/Companion/dockerClient
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-composer/-companion/docker-client/#dockerclient","title":"dockerClient","text":"[jvm]\\ val dockerClient: DockerClient
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/","title":"Container - Misk","text":"//wisp-containers-testing/wisp.containers/Container
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/#container","title":"Container","text":"[jvm]\\ data class Container(val createCmd: CreateContainerCmd.() -> Unit, val beforeStartHook: (docker: DockerClient, id: String) -> Unit)
A Container creates a Docker container for testing.
Tests provide a lambda to build a CreateContainerCmd. The createCmd lambda must set CreateContainerCmd.withName and CreateContainerCmd.withImage. All other fields are optional. The Composer takes care of setting up the network.
There may be a need to configure your container between the creation and start steps. beforeStartHook provides you with an id to your container allowing you to manipulate as necessary before the command/entrypoint is invoked.
See Composer for an example.
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/#constructors","title":"Constructors","text":"Container [jvm]constructor(createCmd: CreateContainerCmd.() -> Unit)constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/#properties","title":"Properties","text":"Name Summary beforeStartHook [jvm]val beforeStartHook: (docker: DockerClient, id: String) -> Unit createCmd [jvm]val createCmd: CreateContainerCmd.() -> Unit"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/-container/","title":"Container - Misk","text":"//wisp-containers-testing/wisp.containers/Container/Container
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/-container/#container","title":"Container","text":"[jvm]\\ constructor(createCmd: CreateContainerCmd.() -> Unit)
constructor(createCmd: CreateContainerCmd.() -> Unit, beforeStartHook: (docker: DockerClient, id: String) -> Unit)
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/before-start-hook/","title":"beforeStartHook - Misk","text":"//wisp-containers-testing/wisp.containers/Container/beforeStartHook
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/before-start-hook/#beforestarthook","title":"beforeStartHook","text":"[jvm]\\ val beforeStartHook: (docker: DockerClient, id: String) -> Unit
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/create-cmd/","title":"createCmd - Misk","text":"//wisp-containers-testing/wisp.containers/Container/createCmd
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container/create-cmd/#createcmd","title":"createCmd","text":"[jvm]\\ val createCmd: CreateContainerCmd.() -> Unit
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/","title":"ContainerUtil - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/#containerutil","title":"ContainerUtil","text":"[jvm]\\ object ContainerUtil
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/#properties","title":"Properties","text":"Name Summary isRunningInDocker [jvm]val isRunningInDocker: Boolean"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/#functions","title":"Functions","text":"Name Summary dockerTargetOrLocalHost [jvm]fun dockerTargetOrLocalHost(): String dockerTargetOrLocalIp [jvm]fun dockerTargetOrLocalIp(): String"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-host/","title":"dockerTargetOrLocalHost - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil/dockerTargetOrLocalHost
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-host/#dockertargetorlocalhost","title":"dockerTargetOrLocalHost","text":"[jvm]\\ fun dockerTargetOrLocalHost(): String
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-ip/","title":"dockerTargetOrLocalIp - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil/dockerTargetOrLocalIp
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/docker-target-or-local-ip/#dockertargetorlocalip","title":"dockerTargetOrLocalIp","text":"[jvm]\\ fun dockerTargetOrLocalIp(): String
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/is-running-in-docker/","title":"isRunningInDocker - Misk","text":"//wisp-containers-testing/wisp.containers/ContainerUtil/isRunningInDocker
"},{"location":"0.x/wisp-containers-testing/wisp-containers-testing/wisp.containers/-container-util/is-running-in-docker/#isrunningindocker","title":"isRunningInDocker","text":"[jvm]\\ val isRunningInDocker: Boolean
"},{"location":"0.x/wisp-deployment/","title":"wisp-deployment - Misk","text":"//wisp-deployment
"},{"location":"0.x/wisp-deployment/#wisp-deployment","title":"wisp-deployment","text":""},{"location":"0.x/wisp-deployment/#packages","title":"Packages","text":"Name wisp.deployment"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/","title":"Package-level declarations - Misk","text":"//wisp-deployment/wisp.deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#types","title":"Types","text":"Name Summary Deployment [jvm]data class Deployment@JvmOverloadsconstructor(val name: String, val isProduction: Boolean = false, val isStaging: Boolean = false, val isTest: Boolean = false, val isLocalDevelopment: Boolean = false)Deployment describes the context in which the application is running DeploymentLocation [jvm]interface DeploymentLocationFor information about the deployment location. EnvironmentVariableDeploymentLocation [jvm]class EnvironmentVariableDeploymentLocation@JvmOverloadsconstructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real) : DeploymentLocationProvides a deployment location id from the environment variable value. EnvironmentVariableLoader [jvm]interface EnvironmentVariableLoaderLoads an environment variable value. RealEnvironmentVariableLoader [jvm]class RealEnvironmentVariableLoader : EnvironmentVariableLoader"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#properties","title":"Properties","text":"Name Summary deployments [jvm]val deployments: Map<String, Deployment> DEVELOPMENT [jvm]val DEVELOPMENT: Deployment PRODUCTION [jvm]val PRODUCTION: Deployment STAGING [jvm]val STAGING: Deployment TESTING [jvm]val TESTING: Deployment"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/#functions","title":"Functions","text":"Name Summary getDeploymentFromEnvironmentVariable [jvm]fun getDeploymentFromEnvironmentVariable(defaultDeployment: Deployment = DEVELOPMENT, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real): DeploymentDetermines a Deployment based on the value within the ENVIRONMENT variable, defaulting to local development if not set (i.e. isLocalDevelopment == true)"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-d-e-v-e-l-o-p-m-e-n-t/","title":"DEVELOPMENT - Misk","text":"//wisp-deployment/wisp.deployment/DEVELOPMENT
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-d-e-v-e-l-o-p-m-e-n-t/#development","title":"DEVELOPMENT","text":"[jvm]\\ val DEVELOPMENT: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-p-r-o-d-u-c-t-i-o-n/","title":"PRODUCTION - Misk","text":"//wisp-deployment/wisp.deployment/PRODUCTION
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-p-r-o-d-u-c-t-i-o-n/#production","title":"PRODUCTION","text":"[jvm]\\ val PRODUCTION: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-s-t-a-g-i-n-g/","title":"STAGING - Misk","text":"//wisp-deployment/wisp.deployment/STAGING
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-s-t-a-g-i-n-g/#staging","title":"STAGING","text":"[jvm]\\ val STAGING: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-t-e-s-t-i-n-g/","title":"TESTING - Misk","text":"//wisp-deployment/wisp.deployment/TESTING
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-t-e-s-t-i-n-g/#testing","title":"TESTING","text":"[jvm]\\ val TESTING: Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/deployments/","title":"deployments - Misk","text":"//wisp-deployment/wisp.deployment/deployments
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/deployments/#deployments","title":"deployments","text":"[jvm]\\ val deployments: Map<String, Deployment>
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/get-deployment-from-environment-variable/","title":"getDeploymentFromEnvironmentVariable - Misk","text":"//wisp-deployment/wisp.deployment/getDeploymentFromEnvironmentVariable
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/get-deployment-from-environment-variable/#getdeploymentfromenvironmentvariable","title":"getDeploymentFromEnvironmentVariable","text":"[jvm]\\ fun getDeploymentFromEnvironmentVariable(defaultDeployment: Deployment = DEVELOPMENT, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real): Deployment
Determines a Deployment based on the value within the ENVIRONMENT variable, defaulting to local development if not set (i.e. isLocalDevelopment == true)
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/","title":"Deployment - Misk","text":"//wisp-deployment/wisp.deployment/Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#deployment","title":"Deployment","text":"[jvm]\\ data class Deployment@JvmOverloadsconstructor(val name: String, val isProduction: Boolean = false, val isStaging: Boolean = false, val isTest: Boolean = false, val isLocalDevelopment: Boolean = false)
Deployment describes the context in which the application is running
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#constructors","title":"Constructors","text":"Deployment [jvm]@JvmOverloadsconstructor(name: String, isProduction: Boolean = false, isStaging: Boolean = false, isTest: Boolean = false, isLocalDevelopment: Boolean = false)"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#properties","title":"Properties","text":"Name Summary isFake [jvm]val isFake: BooleanReturns true if running outside of a cluster (CI or local development). Mutually exclusive with isReal. isLocalDevelopment [jvm]val isLocalDevelopment: Boolean = falseWhether the service is running on a local developer machine, including as a Docker image. isProduction [jvm]val isProduction: Boolean = falseWhether the service is running in a production environment, having an SLA or handling customer data. isReal [jvm]val isReal: BooleanReturns true if running in a managed cluster, such as a staging or production cluster. Mutually exclusive with isFake. isStaging [jvm]val isStaging: Boolean = falseWhether the service is running in a staging environment. isTest [jvm]val isTest: Boolean = falseWhether the service is running in a test environment, either locally or in a CI. name [jvm]val name: StringThe name of this deployment. This is used for debugging and should not be parsed."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/#functions","title":"Functions","text":"Name Summary mapToEnvironmentName [jvm]fun mapToEnvironmentName(): String"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/-deployment/","title":"Deployment - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/Deployment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/-deployment/#deployment","title":"Deployment","text":"[jvm]\\
@JvmOverloads
constructor(name: String, isProduction: Boolean = false, isStaging: Boolean = false, isTest: Boolean = false, isLocalDevelopment: Boolean = false)
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-fake/","title":"isFake - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isFake
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-fake/#isfake","title":"isFake","text":"[jvm]\\ val isFake: Boolean
Returns true if running outside of a cluster (CI or local development). Mutually exclusive with isReal.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-local-development/","title":"isLocalDevelopment - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isLocalDevelopment
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-local-development/#islocaldevelopment","title":"isLocalDevelopment","text":"[jvm]\\ val isLocalDevelopment: Boolean = false
Whether the service is running on a local developer machine, including as a Docker image.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-production/","title":"isProduction - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isProduction
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-production/#isproduction","title":"isProduction","text":"[jvm]\\ val isProduction: Boolean = false
Whether the service is running in a production environment, having an SLA or handling customer data.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-real/","title":"isReal - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isReal
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-real/#isreal","title":"isReal","text":"[jvm]\\ val isReal: Boolean
Returns true if running in a managed cluster, such as a staging or production cluster. Mutually exclusive with isFake.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-staging/","title":"isStaging - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isStaging
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-staging/#isstaging","title":"isStaging","text":"[jvm]\\ val isStaging: Boolean = false
Whether the service is running in a staging environment.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-test/","title":"isTest - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/isTest
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/is-test/#istest","title":"isTest","text":"[jvm]\\ val isTest: Boolean = false
Whether the service is running in a test environment, either locally or in a CI.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/map-to-environment-name/","title":"mapToEnvironmentName - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/mapToEnvironmentName
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/map-to-environment-name/#maptoenvironmentname","title":"mapToEnvironmentName","text":"[jvm]\\ fun mapToEnvironmentName(): String
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/name/","title":"name - Misk","text":"//wisp-deployment/wisp.deployment/Deployment/name
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment/name/#name","title":"name","text":"[jvm]\\ val name: String
The name of this deployment. This is used for debugging and should not be parsed.
All pods in the same deployment will have this same name.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/","title":"DeploymentLocation - Misk","text":"//wisp-deployment/wisp.deployment/DeploymentLocation
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/#deploymentlocation","title":"DeploymentLocation","text":"interface DeploymentLocation
For information about the deployment location.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/#inheritors","title":"Inheritors","text":"EnvironmentVariableDeploymentLocation"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/#properties","title":"Properties","text":"Name Summary id [jvm]abstract val id: StringDeployment identification, e.g. Kubernetes pod name or host name, etc."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/id/","title":"id - Misk","text":"//wisp-deployment/wisp.deployment/DeploymentLocation/id
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-deployment-location/id/#id","title":"id","text":"[jvm]\\ abstract val id: String
Deployment identification, e.g. Kubernetes pod name or host name, etc.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/","title":"EnvironmentVariableDeploymentLocation - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableDeploymentLocation
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/#environmentvariabledeploymentlocation","title":"EnvironmentVariableDeploymentLocation","text":"[jvm]\\ class EnvironmentVariableDeploymentLocation@JvmOverloadsconstructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real) : DeploymentLocation
Provides a deployment location id from the environment variable value.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/#constructors","title":"Constructors","text":"EnvironmentVariableDeploymentLocation [jvm]@JvmOverloadsconstructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real)"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: StringDeployment identification, e.g. Kubernetes pod name or host name, etc."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/-environment-variable-deployment-location/","title":"EnvironmentVariableDeploymentLocation - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableDeploymentLocation/EnvironmentVariableDeploymentLocation
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/-environment-variable-deployment-location/#environmentvariabledeploymentlocation","title":"EnvironmentVariableDeploymentLocation","text":"[jvm]\\
@JvmOverloads
constructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real)
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/id/","title":"id - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableDeploymentLocation/id
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-deployment-location/id/#id","title":"id","text":"[jvm]\\ open override val id: String
Deployment identification, e.g. Kubernetes pod name or host name, etc.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/","title":"EnvironmentVariableLoader - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#environmentvariableloader","title":"EnvironmentVariableLoader","text":"interface EnvironmentVariableLoader
Loads an environment variable value.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#inheritors","title":"Inheritors","text":"RealEnvironmentVariableLoader"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): StringGet the environment variable value that must exist getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): StringGet the environment variable value, or if it does not exist, use the defaultValue supplied."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable-or-default/","title":"getEnvironmentVariableOrDefault - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/getEnvironmentVariableOrDefault
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable-or-default/#getenvironmentvariableordefault","title":"getEnvironmentVariableOrDefault","text":"[jvm]\\ open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String
Get the environment variable value, or if it does not exist, use the defaultValue supplied.
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable/","title":"getEnvironmentVariable - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/getEnvironmentVariable
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable/#getenvironmentvariable","title":"getEnvironmentVariable","text":"[jvm]\\ open fun getEnvironmentVariable(name: String): String
Get the environment variable value that must exist
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/get-environment-variable/#throws","title":"Throws","text":"IllegalStateException if the environment variable is not found"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/","title":"Companion - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/Companion
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/#properties","title":"Properties","text":"Name Summary real [jvm]val real: RealEnvironmentVariableLoader"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/real/","title":"real - Misk","text":"//wisp-deployment/wisp.deployment/EnvironmentVariableLoader/Companion/real
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-environment-variable-loader/-companion/real/#real","title":"real","text":"[jvm]\\ val real: RealEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/","title":"RealEnvironmentVariableLoader - Misk","text":"//wisp-deployment/wisp.deployment/RealEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/#realenvironmentvariableloader","title":"RealEnvironmentVariableLoader","text":"[jvm]\\ class RealEnvironmentVariableLoader : EnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/#constructors","title":"Constructors","text":"RealEnvironmentVariableLoader [jvm]constructor()"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open fun getEnvironmentVariable(name: String): StringGet the environment variable value that must exist getEnvironmentVariableOrDefault [jvm]open fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): StringGet the environment variable value, or if it does not exist, use the defaultValue supplied."},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/-real-environment-variable-loader/","title":"RealEnvironmentVariableLoader - Misk","text":"//wisp-deployment/wisp.deployment/RealEnvironmentVariableLoader/RealEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment/wisp-deployment/wisp.deployment/-real-environment-variable-loader/-real-environment-variable-loader/#realenvironmentvariableloader","title":"RealEnvironmentVariableLoader","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-deployment-testing/","title":"wisp-deployment-testing - Misk","text":"//wisp-deployment-testing
"},{"location":"0.x/wisp-deployment-testing/#wisp-deployment-testing","title":"wisp-deployment-testing","text":""},{"location":"0.x/wisp-deployment-testing/#packages","title":"Packages","text":"Name wisp.deployment"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/","title":"Package-level declarations - Misk","text":"//wisp-deployment-testing/wisp.deployment
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/#types","title":"Types","text":"Name Summary FakeDeploymentLocation [jvm]class FakeDeploymentLocation@JvmOverloadsconstructor(deploymentLocation: String = \"FakeDeploymentLocation\") : DeploymentLocation FakeEnvironmentVariableLoader [jvm]class FakeEnvironmentVariableLoader@JvmOverloadsconstructor(val vars: MutableMap<String, String> = mutableMapOf()) : EnvironmentVariableLoaderA Fake EnvironmentVariableLoader that loads from an in memory map"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/","title":"FakeDeploymentLocation - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeDeploymentLocation
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/#fakedeploymentlocation","title":"FakeDeploymentLocation","text":"[jvm]\\ class FakeDeploymentLocation@JvmOverloadsconstructor(deploymentLocation: String = \"FakeDeploymentLocation\") : DeploymentLocation
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/#constructors","title":"Constructors","text":"FakeDeploymentLocation [jvm]@JvmOverloadsconstructor(deploymentLocation: String = \"FakeDeploymentLocation\")"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/#properties","title":"Properties","text":"Name Summary id [jvm]open override val id: StringDeployment identification, e.g. Kubernetes pod name or host name, etc."},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/-fake-deployment-location/","title":"FakeDeploymentLocation - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeDeploymentLocation/FakeDeploymentLocation
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/-fake-deployment-location/#fakedeploymentlocation","title":"FakeDeploymentLocation","text":"[jvm]\\
@JvmOverloads
constructor(deploymentLocation: String = \"FakeDeploymentLocation\")
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/id/","title":"id - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeDeploymentLocation/id
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-deployment-location/id/#id","title":"id","text":"[jvm]\\ open override val id: String
Deployment identification, e.g. Kubernetes pod name or host name, etc.
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/","title":"FakeEnvironmentVariableLoader - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#fakeenvironmentvariableloader","title":"FakeEnvironmentVariableLoader","text":"[jvm]\\ class FakeEnvironmentVariableLoader@JvmOverloadsconstructor(val vars: MutableMap<String, String> = mutableMapOf()) : EnvironmentVariableLoader
A Fake EnvironmentVariableLoader that loads from an in memory map
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#constructors","title":"Constructors","text":"FakeEnvironmentVariableLoader [jvm]@JvmOverloadsconstructor(vars: MutableMap<String, String> = mutableMapOf())"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#properties","title":"Properties","text":"Name Summary vars [jvm]val vars: MutableMap<String, String>"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/#functions","title":"Functions","text":"Name Summary getEnvironmentVariable [jvm]open override fun getEnvironmentVariable(name: String): String getEnvironmentVariableOrDefault [jvm]open override fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/-fake-environment-variable-loader/","title":"FakeEnvironmentVariableLoader - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/FakeEnvironmentVariableLoader
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/-fake-environment-variable-loader/#fakeenvironmentvariableloader","title":"FakeEnvironmentVariableLoader","text":"[jvm]\\
@JvmOverloads
constructor(vars: MutableMap<String, String> = mutableMapOf())
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable-or-default/","title":"getEnvironmentVariableOrDefault - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/getEnvironmentVariableOrDefault
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable-or-default/#getenvironmentvariableordefault","title":"getEnvironmentVariableOrDefault","text":"[jvm]\\ open override fun getEnvironmentVariableOrDefault(name: String, defaultValue: String): String
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable/","title":"getEnvironmentVariable - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/getEnvironmentVariable
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/get-environment-variable/#getenvironmentvariable","title":"getEnvironmentVariable","text":"[jvm]\\ open override fun getEnvironmentVariable(name: String): String
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/vars/","title":"vars - Misk","text":"//wisp-deployment-testing/wisp.deployment/FakeEnvironmentVariableLoader/vars
"},{"location":"0.x/wisp-deployment-testing/wisp-deployment-testing/wisp.deployment/-fake-environment-variable-loader/vars/#vars","title":"vars","text":"[jvm]\\ val vars: MutableMap<String, String>
"},{"location":"0.x/wisp-feature/","title":"wisp-feature - Misk","text":"//wisp-feature
"},{"location":"0.x/wisp-feature/#wisp-feature","title":"wisp-feature","text":""},{"location":"0.x/wisp-feature/#packages","title":"Packages","text":"Name wisp.feature"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/","title":"Package-level declarations - Misk","text":"//wisp-feature/wisp.feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/#types","title":"Types","text":"Name Summary Attributes [jvm]open class Attributes@JvmOverloadsconstructor(val text: Map<String, String> = mapOf(), val number: Map<String, Number>? = null, val anonymous: Boolean = false)Extra attributes to be used for evaluating features. BooleanFeatureFlag [jvm]interface BooleanFeatureFlag : FeatureFlag<Boolean> DoubleFeatureFlag [jvm]interface DoubleFeatureFlag : FeatureFlag<Double> DynamicConfig [jvm]interface DynamicConfigInterface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys. EnumFeatureFlag [jvm]interface EnumFeatureFlag<T : Enum<T>> : FeatureFlag<T> A Enumeration feature flag, when evaluated returns T Feature [jvm]open class Feature(val name: String)Typed feature string. FeatureFlag [jvm]sealed interface FeatureFlag<T : Any> FeatureFlags [jvm]interface FeatureFlags : StrongFeatureFlags, LegacyFeatureFlagsInterface for evaluating feature flags. FeatureFlagValidation [jvm]object FeatureFlagValidation IntFeatureFlag [jvm]interface IntFeatureFlag : FeatureFlag<Int> JsonFeatureFlag [jvm]interface JsonFeatureFlag<T : Any> : FeatureFlag<T> A JSON feature flag, when evaluated returns T. LegacyFeatureFlags [jvm]interface LegacyFeatureFlags StringFeatureFlag [jvm]interface StringFeatureFlag : FeatureFlag<String> StrongFeatureFlags [jvm]interface StrongFeatureFlags TrackerReference [jvm]interface TrackerReference"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/#functions","title":"Functions","text":"Name Summary fromSafeJson [jvm]fun <T> JsonAdapter<T>.fromSafeJson(value: String): T?fun <T> JsonAdapter<T>.fromSafeJson(json: String, onUnknownFields: (JsonDataException) -> Unit): T?Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields. getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): Tinline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): Tinline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T toSafeJson [jvm]fun <T> JsonAdapter<T>.toSafeJson(value: T): Stringfun <T> JsonAdapter<T>.toSafeJson(value: T, onUnknownFields: (JsonDataException) -> Unit): StringAttempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields. trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReferenceinline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/from-safe-json/","title":"fromSafeJson - Misk","text":"//wisp-feature/wisp.feature/fromSafeJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/from-safe-json/#fromsafejson","title":"fromSafeJson","text":"[jvm]\\ fun <T> JsonAdapter<T>.fromSafeJson(value: String): T?
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
This overload is needed for JVM compatibility.
[jvm]\\ fun <T> JsonAdapter<T>.fromSafeJson(json: String, onUnknownFields: (JsonDataException) -> Unit): T?
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-enum/","title":"getEnum - Misk","text":"//wisp-feature/wisp.feature/getEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T
inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-json/","title":"getJson - Misk","text":"//wisp-feature/wisp.feature/getJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/get-json/#getjson","title":"getJson","text":"[jvm]\\ inline fun <T> DynamicConfig.getJson(feature: Feature): T
inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/to-safe-json/","title":"toSafeJson - Misk","text":"//wisp-feature/wisp.feature/toSafeJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/to-safe-json/#tosafejson","title":"toSafeJson","text":"[jvm]\\ fun <T> JsonAdapter<T>.toSafeJson(value: T): String
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
This overload is needed for JVM compatibility.
[jvm]\\ fun <T> JsonAdapter<T>.toSafeJson(value: T, onUnknownFields: (JsonDataException) -> Unit): String
Attempts to use JsonAdapter.failOnUnknown and logs any issues before falling back to ignoring the unknown fields.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature/wisp.feature/trackEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-json/","title":"trackJson - Misk","text":"//wisp-feature/wisp.feature/trackJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/","title":"Attributes - Misk","text":"//wisp-feature/wisp.feature/Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#attributes","title":"Attributes","text":"[jvm]\\ open class Attributes@JvmOverloadsconstructor(val text: Map<String, String> = mapOf(), val number: Map<String, Number>? = null, val anonymous: Boolean = false)
Extra attributes to be used for evaluating features.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#constructors","title":"Constructors","text":"Attributes [jvm]@JvmOverloadsconstructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#properties","title":"Properties","text":"Name Summary anonymous [jvm]val anonymous: Boolean = false number [jvm]val number: Map<String, Number>? = null text [jvm]val text: Map<String, String>"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/#functions","title":"Functions","text":"Name Summary copy [jvm]@JvmOverloadsfun copy(text: Map<String, String> = this.text, number: Map<String, Number>? = this.number, anonymous: Boolean = this.anonymous): Attributes equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String with [jvm]fun with(name: String, value: Number): Attributesfun with(name: String, value: String): Attributes"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/-attributes/","title":"Attributes - Misk","text":"//wisp-feature/wisp.feature/Attributes/Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/-attributes/#attributes","title":"Attributes","text":"[jvm]\\
@JvmOverloads
constructor(text: Map<String, String> = mapOf(), number: Map<String, Number>? = null, anonymous: Boolean = false)
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/anonymous/","title":"anonymous - Misk","text":"//wisp-feature/wisp.feature/Attributes/anonymous
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/anonymous/#anonymous","title":"anonymous","text":"[jvm]\\ val anonymous: Boolean = false
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/copy/","title":"copy - Misk","text":"//wisp-feature/wisp.feature/Attributes/copy
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/copy/#copy","title":"copy","text":"[jvm]\\
@JvmOverloads
fun copy(text: Map<String, String> = this.text, number: Map<String, Number>? = this.number, anonymous: Boolean = this.anonymous): Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/equals/","title":"equals - Misk","text":"//wisp-feature/wisp.feature/Attributes/equals
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/hash-code/","title":"hashCode - Misk","text":"//wisp-feature/wisp.feature/Attributes/hashCode
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/number/","title":"number - Misk","text":"//wisp-feature/wisp.feature/Attributes/number
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/number/#number","title":"number","text":"[jvm]\\ val number: Map<String, Number>? = null
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/text/","title":"text - Misk","text":"//wisp-feature/wisp.feature/Attributes/text
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/text/#text","title":"text","text":"[jvm]\\ val text: Map<String, String>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/to-string/","title":"toString - Misk","text":"//wisp-feature/wisp.feature/Attributes/toString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/with/","title":"with - Misk","text":"//wisp-feature/wisp.feature/Attributes/with
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-attributes/with/#with","title":"with","text":"[jvm]\\ fun with(name: String, value: String): Attributes
fun with(name: String, value: Number): Attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-boolean-feature-flag/","title":"BooleanFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/BooleanFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-boolean-feature-flag/#booleanfeatureflag","title":"BooleanFeatureFlag","text":"[jvm]\\ interface BooleanFeatureFlag : FeatureFlag<Boolean>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-boolean-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-double-feature-flag/","title":"DoubleFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/DoubleFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-double-feature-flag/#doublefeatureflag","title":"DoubleFeatureFlag","text":"[jvm]\\ interface DoubleFeatureFlag : FeatureFlag<Double>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-double-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/","title":"DynamicConfig - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/#dynamicconfig","title":"DynamicConfig","text":"[jvm]\\ interface DynamicConfig
Interface for evaluating dynamic flags. Dynamic flags are similar to feature flags, but they don\u2019t support different variations for different keys.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]abstract fun getBoolean(feature: Feature): BooleanReturns the value of a boolean dynamic flag. getDouble [jvm]abstract fun getDouble(feature: Feature): DoubleReturns the value of a double dynamic flag. getEnum [jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): TReturns the value of an enumerated dynamic flag. getEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.getEnum(feature: Feature): T getInt [jvm]abstract fun getInt(feature: Feature): IntReturns the value of an integer dynamic flag. getJson [jvm]abstract fun <T> getJson(feature: Feature, clazz: Class<T>): TReturns the value of a JSON dynamic flag. getJson [jvm]inline fun <T> DynamicConfig.getJson(feature: Feature): T getJsonString [jvm]abstract fun getJsonString(feature: Feature): StringReturns the value of a JSON string value of the dynamic flag. getString [jvm]abstract fun getString(feature: Feature): StringReturns the value of a string dynamic flag. trackBoolean [jvm]abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value. trackDouble [jvm]abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a double dynamic config tracker which will be invoked whenever the double dynamic config changes value. trackEnum [jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value. trackEnum [jvm]inline fun <T : Enum<T>> DynamicConfig.trackEnum(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value. trackJson [jvm]abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a json dynamic config tracker which will be invoked whenever the json dynamic config changes value. trackJson [jvm]inline fun <T> DynamicConfig.trackJson(feature: Feature, executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a string dynamic config tracker which will be invoked whenever the string dynamic config changes value."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature): Boolean
Returns the value of a boolean dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-double/","title":"getDouble - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature): Double
Returns the value of a double dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
Returns the value of an enumerated dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-int/","title":"getInt - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature): Int
Returns the value of an integer dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json-string/","title":"getJsonString - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getJsonString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ abstract fun getJsonString(feature: Feature): String
Returns the value of a JSON string value of the dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json/","title":"getJson - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, clazz: Class<T>): T
Returns the value of a JSON dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-string/","title":"getString - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/getString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature): String
Returns the value of a string dynamic flag.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a boolean dynamic config tracker which will be invoked whenever the boolean dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a double dynamic config tracker which will be invoked whenever the double dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a enum dynamic config tracker which will be invoked whenever the enum dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-int/","title":"trackInt - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a integer dynamic config tracker which will be invoked whenever the integer dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-json/","title":"trackJson - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a json dynamic config tracker which will be invoked whenever the json dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-string/","title":"trackString - Misk","text":"//wisp-feature/wisp.feature/DynamicConfig/trackString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a string dynamic config tracker which will be invoked whenever the string dynamic config changes value.
Returns a tracker reference which can be used to un-register the tracker.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/","title":"EnumFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/EnumFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/#enumfeatureflag","title":"EnumFeatureFlag","text":"[jvm]\\ interface EnumFeatureFlag<T : Enum<T>> : FeatureFlag<T>
A Enumeration feature flag, when evaluated returns T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against. returnType [jvm]abstract val returnType: Class<T>"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/return-type/","title":"returnType - Misk","text":"//wisp-feature/wisp.feature/EnumFeatureFlag/returnType
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-enum-feature-flag/return-type/#returntype","title":"returnType","text":"[jvm]\\ abstract val returnType: Class<T>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/","title":"Feature - Misk","text":"//wisp-feature/wisp.feature/Feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#feature","title":"Feature","text":"[jvm]\\ open class Feature(val name: String)
Typed feature string.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#constructors","title":"Constructors","text":"Feature [jvm]constructor(name: String)"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/#functions","title":"Functions","text":"Name Summary equals [jvm]open operator override fun equals(other: Any?): Boolean hashCode [jvm]open override fun hashCode(): Int toString [jvm]open override fun toString(): String"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/-feature/","title":"Feature - Misk","text":"//wisp-feature/wisp.feature/Feature/Feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/-feature/#feature","title":"Feature","text":"[jvm]\\ constructor(name: String)
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/equals/","title":"equals - Misk","text":"//wisp-feature/wisp.feature/Feature/equals
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/equals/#equals","title":"equals","text":"[jvm]\\ open operator override fun equals(other: Any?): Boolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/hash-code/","title":"hashCode - Misk","text":"//wisp-feature/wisp.feature/Feature/hashCode
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/hash-code/#hashcode","title":"hashCode","text":"[jvm]\\ open override fun hashCode(): Int
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/name/","title":"name - Misk","text":"//wisp-feature/wisp.feature/Feature/name
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/to-string/","title":"toString - Misk","text":"//wisp-feature/wisp.feature/Feature/toString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature/to-string/#tostring","title":"toString","text":"[jvm]\\ open override fun toString(): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/","title":"FeatureFlag - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/#featureflag","title":"FeatureFlag","text":"sealed interface FeatureFlag<T : Any>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/#inheritors","title":"Inheritors","text":"StringFeatureFlag BooleanFeatureFlag IntFeatureFlag DoubleFeatureFlag EnumFeatureFlag JsonFeatureFlag"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/attributes/","title":"attributes - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag/attributes
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/attributes/#attributes","title":"attributes","text":"[jvm]\\ open val attributes: Attributes
The attributes of this feature flag, provided during flag evaluation
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/feature/","title":"feature - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag/feature
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/feature/#feature","title":"feature","text":"[jvm]\\ abstract val feature: Feature
Feature name of the feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/key/","title":"key - Misk","text":"//wisp-feature/wisp.feature/FeatureFlag/key
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag/key/#key","title":"key","text":"[jvm]\\ abstract val key: String
Unique primary key for the entity the flag should be evaluated against.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/","title":"FeatureFlagValidation - Misk","text":"//wisp-feature/wisp.feature/FeatureFlagValidation
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/#featureflagvalidation","title":"FeatureFlagValidation","text":"[jvm]\\ object FeatureFlagValidation
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/#functions","title":"Functions","text":"Name Summary checkValidKey [jvm]fun checkValidKey(feature: Feature, key: String)Validates the feature flags\u2019s hashing \"key\". Most implementation technically support arbitrary strings, but we still prefer to restrict valid input to prevent accidentally passing in the wrong value or potentially sensitive information."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/check-valid-key/","title":"checkValidKey - Misk","text":"//wisp-feature/wisp.feature/FeatureFlagValidation/checkValidKey
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flag-validation/check-valid-key/#checkvalidkey","title":"checkValidKey","text":"[jvm]\\ fun checkValidKey(feature: Feature, key: String)
Validates the feature flags\u2019s hashing \"key\". Most implementation technically support arbitrary strings, but we still prefer to restrict valid input to prevent accidentally passing in the wrong value or potentially sensitive information.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flags/","title":"FeatureFlags - Misk","text":"//wisp-feature/wisp.feature/FeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flags/#featureflags","title":"FeatureFlags","text":"[jvm]\\ interface FeatureFlags : StrongFeatureFlags, LegacyFeatureFlags
Interface for evaluating feature flags.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(flag: BooleanFeatureFlag): BooleanCalculates the value of a boolean feature flag[jvm]abstract fun get(flag: DoubleFeatureFlag): DoubleCalculates the value of a double feature flag[jvm]abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): TCalculates the value of an enum feature flag[jvm]abstract fun get(flag: IntFeatureFlag): IntCalculates the value of an int feature flag[jvm]abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): TCalculates the value of a json feature flag[jvm]abstract fun get(flag: StringFeatureFlag): StringCalculates the value of a string feature flag getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Boolean[jvm]abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): BooleanCalculates the value of a boolean feature flag for the given key and attributes. getDouble [jvm]open fun getDouble(feature: Feature, key: String): Double[jvm]abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): DoubleCalculates the value of a double feature flag for the given key and attributes. getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of an enumerated feature flag for the given key and attributes. getEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.getEnum(feature: Feature, key: String, attributes: Attributes = Attributes()): T getInt [jvm]open fun getInt(feature: Feature, key: String): Int[jvm]abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): IntCalculates the value of an integer feature flag for the given key and attributes. getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of a JSON feature flag for the given key and attributes. getJson [jvm]inline fun <T> FeatureFlags.getJson(feature: Feature, key: String, attributes: Attributes = Attributes()): T getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): String[jvm]abstract fun getJsonString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a JSON feature flag for the given key and attributes and returns it as a json string. getString [jvm]open fun getString(feature: Feature, key: String): String[jvm]abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a string feature flag for the given key and attributes. trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference[jvm]abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a tracker for the value of a boolean feature flag for the given key and attributes. trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference[jvm]abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a tracker for the value of a double feature flag for the given key and attributes. trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of an enumerated feature flag for the given key and attributes. trackEnum [jvm]inline fun <T : Enum<T>> FeatureFlags.trackEnum(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference[jvm]abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a tracker for the value of an integer feature flag for the given key and attributes. trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of a JSON feature flag for the given key and attributes. trackJson [jvm]inline fun <T> FeatureFlags.trackJson(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, noinline tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference[jvm]abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a tracker for the value of a string feature flag for the given key and attributes."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-int-feature-flag/","title":"IntFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/IntFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-int-feature-flag/#intfeatureflag","title":"IntFeatureFlag","text":"[jvm]\\ interface IntFeatureFlag : FeatureFlag<Int>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-int-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-json-feature-flag/","title":"JsonFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/JsonFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-json-feature-flag/#jsonfeatureflag","title":"JsonFeatureFlag","text":"[jvm]\\ interface JsonFeatureFlag<T : Any> : FeatureFlag<T>
A JSON feature flag, when evaluated returns T.
It is expected that a Moshi type adapter is registered for T.
Example definition:
// Step 1: Define the object we expect to get from the JSON flag\ndata class PaymentConfiguration(\n val fraudulent: Boolean,\n val vipTreatment: Boolean,\n val specialDescription: String\n)\n\n// Step 2: Define the feature flag\ndata class PaymentConfigurationFeature(\n // Put the `key` and `attributes` here\n val customerId: String,\n val extraAttribute: String\n) : JsonFeatureFlag<PaymentConfiguration> {\n override val feature = Feature(\"payment-configuration-feature\")\n override val key = customerId\n override val attributes = Attributes()\n .with(\"extraAttribute\", extraAttribute)\n override val returnType = PaymentConfiguration::class\n}\n//wisp-feature/wisp.feature/JsonFeatureFlag/returnType
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-json-feature-flag/return-type/#returntype","title":"returnType","text":"[jvm]\\ abstract val returnType: Class<out T>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/","title":"LegacyFeatureFlags - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/#legacyfeatureflags","title":"LegacyFeatureFlags","text":"interface LegacyFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/#inheritors","title":"Inheritors","text":"FeatureFlags"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Boolean[jvm]abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): BooleanCalculates the value of a boolean feature flag for the given key and attributes. getDouble [jvm]open fun getDouble(feature: Feature, key: String): Double[jvm]abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): DoubleCalculates the value of a double feature flag for the given key and attributes. getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of an enumerated feature flag for the given key and attributes. getInt [jvm]open fun getInt(feature: Feature, key: String): Int[jvm]abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): IntCalculates the value of an integer feature flag for the given key and attributes. getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T[jvm]abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): TCalculates the value of a JSON feature flag for the given key and attributes. getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): String[jvm]abstract fun getJsonString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a JSON feature flag for the given key and attributes and returns it as a json string. getString [jvm]open fun getString(feature: Feature, key: String): String[jvm]abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): StringCalculates the value of a string feature flag for the given key and attributes. trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference[jvm]abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceRegisters a tracker for the value of a boolean feature flag for the given key and attributes. trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference[jvm]abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReferenceRegisters a tracker for the value of a double feature flag for the given key and attributes. trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of an enumerated feature flag for the given key and attributes. trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference[jvm]abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReferenceRegisters a tracker for the value of an integer feature flag for the given key and attributes. trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference[jvm]abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReferenceRegisters a tracker for the value of a JSON feature flag for the given key and attributes. trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference[jvm]abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReferenceRegisters a tracker for the value of a string feature flag for the given key and attributes."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ abstract fun getBoolean(feature: Feature, key: String, attributes: Attributes = Attributes()): Boolean
Calculates the value of a boolean feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-boolean/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getBoolean(feature: Feature, key: String): Boolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-double/","title":"getDouble - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ abstract fun getDouble(feature: Feature, key: String, attributes: Attributes = Attributes()): Double
Calculates the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-double/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getDouble(feature: Feature, key: String): Double
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/","title":"getEnum - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-int/","title":"getInt - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ abstract fun getInt(feature: Feature, key: String, attributes: Attributes = Attributes()): Int
Calculates the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-int/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getInt(feature: Feature, key: String): Int
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json-string/","title":"getJsonString - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getJsonString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ abstract fun getJsonString(feature: Feature, key: String, attributes: Attributes = Attributes()): String
Calculates the value of a JSON feature flag for the given key and attributes and returns it as a json string.
is registered with the impl.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json-string/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getJsonString(feature: Feature, key: String): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/","title":"getJson - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ abstract fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes()): T
Calculates the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-json/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-string/","title":"getString - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/getString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ abstract fun getString(feature: Feature, key: String, attributes: Attributes = Attributes()): String
Calculates the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/get-string/#see-also","title":"See also","text":"LegacyFeatureFlags.getEnum for param details[jvm]\\ open fun getString(feature: Feature, key: String): String
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackBoolean
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ abstract fun trackBoolean(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
Registers a tracker for the value of a boolean feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-boolean/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-double/","title":"trackDouble - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackDouble
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ abstract fun trackDouble(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Double) -> Unit): TrackerReference
Registers a tracker for the value of a double feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-double/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackEnum
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ abstract fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of an enumerated feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#return","title":"Return","text":"a reference to the registered tracker allowing to un-register it
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#parameters","title":"Parameters","text":"jvm
feature name of the feature flag to evaluate. key unique primary key for the entity the flag should be evaluated against. clazz the enum type. attributes additional attributes to provide to flag evaluation. tracker a tracker to be registered for processing of changed values"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-enum/#throws","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-int/","title":"trackInt - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackInt
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ abstract fun trackInt(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (Int) -> Unit): TrackerReference
Registers a tracker for the value of an integer feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-int/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/","title":"trackJson - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackJson
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ abstract fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes = Attributes(), executor: Executor, tracker: (T) -> Unit): TrackerReference
Registers a tracker for the value of a JSON feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/#parameters","title":"Parameters","text":"jvm
clazz the type to convert the JSON string into. It is expected that a Moshi type adapter is registered with the impl."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-json/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-string/","title":"trackString - Misk","text":"//wisp-feature/wisp.feature/LegacyFeatureFlags/trackString
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ abstract fun trackString(feature: Feature, key: String, attributes: Attributes = Attributes(), executor: Executor, tracker: (String) -> Unit): TrackerReference
Registers a tracker for the value of a string feature flag for the given key and attributes.
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-legacy-feature-flags/track-string/#see-also","title":"See also","text":"LegacyFeatureFlags.trackEnum for param details[jvm]\\ open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-string-feature-flag/","title":"StringFeatureFlag - Misk","text":"//wisp-feature/wisp.feature/StringFeatureFlag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-string-feature-flag/#stringfeatureflag","title":"StringFeatureFlag","text":"[jvm]\\ interface StringFeatureFlag : FeatureFlag<String>
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-string-feature-flag/#properties","title":"Properties","text":"Name Summary attributes [jvm]open val attributes: AttributesThe attributes of this feature flag, provided during flag evaluation feature [jvm]abstract val feature: FeatureFeature name of the feature flag key [jvm]abstract val key: StringUnique primary key for the entity the flag should be evaluated against."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/","title":"StrongFeatureFlags - Misk","text":"//wisp-feature/wisp.feature/StrongFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/#strongfeatureflags","title":"StrongFeatureFlags","text":"interface StrongFeatureFlags
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/#inheritors","title":"Inheritors","text":"FeatureFlags"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]abstract fun get(flag: BooleanFeatureFlag): BooleanCalculates the value of a boolean feature flag[jvm]abstract fun get(flag: DoubleFeatureFlag): DoubleCalculates the value of a double feature flag[jvm]abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): TCalculates the value of an enum feature flag[jvm]abstract fun get(flag: IntFeatureFlag): IntCalculates the value of an int feature flag[jvm]abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): TCalculates the value of a json feature flag[jvm]abstract fun get(flag: StringFeatureFlag): StringCalculates the value of a string feature flag"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/","title":"get - Misk","text":"//wisp-feature/wisp.feature/StrongFeatureFlags/get
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#get","title":"get","text":"[jvm]\\ abstract fun get(flag: BooleanFeatureFlag): Boolean
Calculates the value of a boolean feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: StringFeatureFlag): String
Calculates the value of a string feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_1","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_1","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: IntFeatureFlag): Int
Calculates the value of an int feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_2","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_2","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun get(flag: DoubleFeatureFlag): Double
Calculates the value of a double feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_3","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_3","title":"Throws","text":"RuntimeException if the service is unavailable.[jvm]\\ abstract fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
Calculates the value of an enum feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_4","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_4","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value.[jvm]\\ abstract fun <T : Any> get(flag: JsonFeatureFlag<T>): T
Calculates the value of a json feature flag
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#parameters_5","title":"Parameters","text":"jvm
flag the feature flag to evaluate"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-strong-feature-flags/get/#throws_5","title":"Throws","text":"RuntimeException if the service is unavailable. IllegalStateException if the flag is off with no default value."},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/","title":"TrackerReference - Misk","text":"//wisp-feature/wisp.feature/TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/#trackerreference","title":"TrackerReference","text":"[jvm]\\ interface TrackerReference
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/#functions","title":"Functions","text":"Name Summary unregister [jvm]abstract fun unregister()"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/unregister/","title":"unregister - Misk","text":"//wisp-feature/wisp.feature/TrackerReference/unregister
"},{"location":"0.x/wisp-feature/wisp-feature/wisp.feature/-tracker-reference/unregister/#unregister","title":"unregister","text":"[jvm]\\ abstract fun unregister()
"},{"location":"0.x/wisp-feature-testing/","title":"wisp-feature-testing - Misk","text":"//wisp-feature-testing
"},{"location":"0.x/wisp-feature-testing/#wisp-feature-testing","title":"wisp-feature-testing","text":""},{"location":"0.x/wisp-feature-testing/#packages","title":"Packages","text":"Name wisp.feature.testing"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/","title":"Package-level declarations - Misk","text":"//wisp-feature-testing/wisp.feature.testing
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/#types","title":"Types","text":"Name Summary FakeFeatureFlags [jvm]open class FakeFeatureFlags : FeatureFlags, LegacyFeatureFlags, DynamicConfig, StrongFeatureFlags, Configurable<FakeFeatureFlagsConfig> In-memory test implementation of FeatureFlags that allows flags to be overridden. FakeFeatureFlagsConfig [jvm]data class FakeFeatureFlagsConfig@JvmOverloadsconstructor(val featuresConfig: List<FeaturesConfig> = emptyList()) : Config FakeLegacyFeatureFlags [jvm]class FakeLegacyFeatureFlags : LegacyFeatureFlags, DynamicConfigIn-memory test implementation of FeatureFlags that allows flags to be overridden. FakeStrongFeatureFlags [jvm]class FakeStrongFeatureFlags : StrongFeatureFlagsIn-memory test implementation of FeatureFlags that allows for overriding strong feature flags FeaturesConfig [jvm]data class FeaturesConfig@JvmOverloadsconstructor(val featureName: String, val key: String? = null, val attributes: Attributes = Attributes(), val value: String, val type: String = \"String\")"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/","title":"FakeFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#fakefeatureflags","title":"FakeFeatureFlags","text":"[jvm]\\ open class FakeFeatureFlags : FeatureFlags, LegacyFeatureFlags, DynamicConfig, StrongFeatureFlags, Configurable<FakeFeatureFlagsConfig>
In-memory test implementation of FeatureFlags that allows flags to be overridden.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#constructors","title":"Constructors","text":"FakeFeatureFlags [jvm]constructor(moshi: Moshi = defaultKotlinMoshi)Preferred constructor for Wisp"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#properties","title":"Properties","text":"Name Summary legacyFeatureFlags [jvm]val legacyFeatureFlags: FakeLegacyFeatureFlags strongFeatureFlags [jvm]val strongFeatureFlags: FakeStrongFeatureFlags"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/#functions","title":"Functions","text":"Name Summary configure [jvm]open override fun configure(config: FakeFeatureFlagsConfig)Configures the feature flags values from supplied config. get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String getBoolean [jvm]open override fun getBoolean(feature: Feature): Booleanopen override fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getConfigClass [jvm]open override fun getConfigClass(): KClass<FakeFeatureFlagsConfig> getDouble [jvm]open override fun getDouble(feature: Feature): Doubleopen override fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open override fun getInt(feature: Feature): Intopen override fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open override fun <T> getJson(feature: Feature, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getJsonString [jvm]open override fun getJsonString(feature: Feature): Stringopen override fun getJsonString(feature: Feature, key: String): Stringopen override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String getString [jvm]open override fun getString(feature: Feature): Stringopen override fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String override [jvm]@JvmOverloadsinline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags@JvmOverloadsinline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlagsfun <T> override(feature: Feature, value: T)fun override(feature: Feature, value: Boolean)fun override(feature: Feature, value: Double)fun override(feature: Feature, value: Enum<*>)fun override(feature: Feature, value: Int)fun override(feature: Feature, value: String)fun <T> override(feature: Feature, value: T, clazz: Class<T>) overrideAny [jvm]@JvmOverloadsfun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags overrideJson [jvm]inline fun <T> overrideJson(feature: Feature, value: T) overrideJsonString [jvm]fun overrideJsonString(feature: Feature, json: String) overrideKey [jvm]fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)@JvmOverloadsfun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes) overrideKeyJson [jvm]@JvmOverloadsinline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes) overrideKeyJsonString [jvm]@JvmOverloadsfun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes) reset [jvm]fun reset() trackBoolean [jvm]open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-fake-feature-flags/","title":"FakeFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/FakeFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-fake-feature-flags/#fakefeatureflags","title":"FakeFeatureFlags","text":"[jvm]\\ constructor(moshi: Moshi = defaultKotlinMoshi)
Preferred constructor for Wisp
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/configure/","title":"configure - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/configure
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/configure/#configure","title":"configure","text":"[jvm]\\ open override fun configure(config: FakeFeatureFlagsConfig)
Configures the feature flags values from supplied config.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/get-config-class/","title":"getConfigClass - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/getConfigClass
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/get-config-class/#getconfigclass","title":"getConfigClass","text":"[jvm]\\ open override fun getConfigClass(): KClass<FakeFeatureFlagsConfig>
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/legacy-feature-flags/","title":"legacyFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/legacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/legacy-feature-flags/#legacyfeatureflags","title":"legacyFeatureFlags","text":"[jvm]\\ val legacyFeatureFlags: FakeLegacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-any/","title":"overrideAny - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideAny
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-any/#overrideany","title":"overrideAny","text":"[jvm]\\
@JvmOverloads
fun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json-string/","title":"overrideJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json-string/#overridejsonstring","title":"overrideJsonString","text":"[jvm]\\ fun overrideJsonString(feature: Feature, json: String)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json/","title":"overrideJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-json/#overridejson","title":"overrideJson","text":"[jvm]\\ inline fun <T> overrideJson(feature: Feature, value: T)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json-string/","title":"overrideKeyJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideKeyJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json-string/#overridekeyjsonstring","title":"overrideKeyJsonString","text":"[jvm]\\
@JvmOverloads
fun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json/","title":"overrideKeyJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideKeyJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key-json/#overridekeyjson","title":"overrideKeyJson","text":"[jvm]\\
@JvmOverloads
inline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key/","title":"overrideKey - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/overrideKey
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override-key/#overridekey","title":"overrideKey","text":"[jvm]\\
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)
fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)
@JvmOverloads
fun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override/","title":"override - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/override
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/override/#override","title":"override","text":"[jvm]\\
@JvmOverloads
inline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
@JvmOverloads
inline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeFeatureFlags
fun override(feature: Feature, value: Boolean)
fun override(feature: Feature, value: Double)
fun override(feature: Feature, value: Int)
fun override(feature: Feature, value: String)
fun override(feature: Feature, value: Enum<*>)
fun <T> override(feature: Feature, value: T)
fun <T> override(feature: Feature, value: T, clazz: Class<T>)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/reset/","title":"reset - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/reset
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/reset/#reset","title":"reset","text":"[jvm]\\ fun reset()
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/strong-feature-flags/","title":"strongFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/strongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/strong-feature-flags/#strongfeatureflags","title":"strongFeatureFlags","text":"[jvm]\\ val strongFeatureFlags: FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/","title":"Companion - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/#properties","title":"Properties","text":"Name Summary defaultAttributes [jvm]val defaultAttributes: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/-k-e-y/","title":"KEY - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/Companion/KEY
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/default-attributes/","title":"defaultAttributes - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlags/Companion/defaultAttributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags/-companion/default-attributes/#defaultattributes","title":"defaultAttributes","text":"[jvm]\\ val defaultAttributes: Attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/","title":"FakeFeatureFlagsConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlagsConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/#fakefeatureflagsconfig","title":"FakeFeatureFlagsConfig","text":"[jvm]\\ data class FakeFeatureFlagsConfig@JvmOverloadsconstructor(val featuresConfig: List<FeaturesConfig> = emptyList()) : Config
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/#constructors","title":"Constructors","text":"FakeFeatureFlagsConfig [jvm]@JvmOverloadsconstructor(featuresConfig: List<FeaturesConfig> = emptyList())"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/#properties","title":"Properties","text":"Name Summary featuresConfig [jvm]val featuresConfig: List<FeaturesConfig>"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/-fake-feature-flags-config/","title":"FakeFeatureFlagsConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlagsConfig/FakeFeatureFlagsConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/-fake-feature-flags-config/#fakefeatureflagsconfig","title":"FakeFeatureFlagsConfig","text":"[jvm]\\
@JvmOverloads
constructor(featuresConfig: List<FeaturesConfig> = emptyList())
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/features-config/","title":"featuresConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeFeatureFlagsConfig/featuresConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-feature-flags-config/features-config/#featuresconfig","title":"featuresConfig","text":"[jvm]\\ val featuresConfig: List<FeaturesConfig>
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/","title":"FakeLegacyFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#fakelegacyfeatureflags","title":"FakeLegacyFeatureFlags","text":"[jvm]\\ class FakeLegacyFeatureFlags : LegacyFeatureFlags, DynamicConfig
In-memory test implementation of FeatureFlags that allows flags to be overridden.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#constructors","title":"Constructors","text":"FakeLegacyFeatureFlags [jvm]constructor(moshi: Moshi = defaultKotlinMoshi)Preferred constructor for Wisp"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#properties","title":"Properties","text":"Name Summary moshi [jvm]val moshi: () -> Moshi"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getDouble [jvm]open fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): Stringopen override fun getJsonString(feature: Feature): Stringopen override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String getString [jvm]open fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String override [jvm]fun <T> override(feature: Feature, value: T)fun override(feature: Feature, value: Boolean)fun override(feature: Feature, value: Double)fun override(feature: Feature, value: Enum<*>)fun override(feature: Feature, value: Int)fun override(feature: Feature, value: String)fun <T> override(feature: Feature, value: T, clazz: Class<T>) overrideJson [jvm]inline fun <T> overrideJson(feature: Feature, value: T) overrideJsonString [jvm]fun overrideJsonString(feature: Feature, json: String) overrideKey [jvm]fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)@JvmOverloadsfun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)@JvmOverloadsfun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)@JvmOverloadsfun <T, V> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes, mapper: (T) -> V?) overrideKeyJson [jvm]@JvmOverloadsinline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes) overrideKeyJsonString [jvm]@JvmOverloadsfun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes) reset [jvm]fun reset() trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-fake-legacy-feature-flags/","title":"FakeLegacyFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/FakeLegacyFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-fake-legacy-feature-flags/#fakelegacyfeatureflags","title":"FakeLegacyFeatureFlags","text":"[jvm]\\ constructor(moshi: Moshi = defaultKotlinMoshi)
Preferred constructor for Wisp
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getBoolean
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean
open override fun getBoolean(feature: Feature): Boolean
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-double/","title":"getDouble - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getDouble
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double
open override fun getDouble(feature: Feature): Double
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-enum/","title":"getEnum - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getEnum
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-int/","title":"getInt - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getInt
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature, key: String, attributes: Attributes): Int
open override fun getInt(feature: Feature): Int
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json-string/","title":"getJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ open override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String
open override fun getJsonString(feature: Feature): String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json/","title":"getJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
open override fun <T> getJson(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-string/","title":"getString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/getString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature, key: String, attributes: Attributes): String
open override fun getString(feature: Feature): String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/moshi/","title":"moshi - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/moshi
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/moshi/#moshi","title":"moshi","text":"[jvm]\\ val moshi: () -> Moshi
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json-string/","title":"overrideJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json-string/#overridejsonstring","title":"overrideJsonString","text":"[jvm]\\ fun overrideJsonString(feature: Feature, json: String)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json/","title":"overrideJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-json/#overridejson","title":"overrideJson","text":"[jvm]\\ inline fun <T> overrideJson(feature: Feature, value: T)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json-string/","title":"overrideKeyJsonString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideKeyJsonString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json-string/#overridekeyjsonstring","title":"overrideKeyJsonString","text":"[jvm]\\
@JvmOverloads
fun overrideKeyJsonString(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json/","title":"overrideKeyJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideKeyJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key-json/#overridekeyjson","title":"overrideKeyJson","text":"[jvm]\\
@JvmOverloads
inline fun <T> overrideKeyJson(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key/","title":"overrideKey - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/overrideKey
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override-key/#overridekey","title":"overrideKey","text":"[jvm]\\
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Boolean, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Double, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Int, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: String, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun overrideKey(feature: Feature, key: String, value: Enum<*>, attributes: Attributes = defaultAttributes)
fun <T> overrideKey(feature: Feature, key: String, value: T, clazz: Class<T>)
@JvmOverloads
fun <T> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes)
@JvmOverloads
fun <T, V> overrideKey(feature: Feature, key: String, value: T, attributes: Attributes = defaultAttributes, mapper: (T) -> V?)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override/","title":"override - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/override
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/override/#override","title":"override","text":"[jvm]\\ fun override(feature: Feature, value: Boolean)
fun override(feature: Feature, value: Double)
fun override(feature: Feature, value: Int)
fun override(feature: Feature, value: String)
fun override(feature: Feature, value: Enum<*>)
fun <T> override(feature: Feature, value: T)
fun <T> override(feature: Feature, value: T, clazz: Class<T>)
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/reset/","title":"reset - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/reset
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/reset/#reset","title":"reset","text":"[jvm]\\ fun reset()
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackBoolean
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-double/","title":"trackDouble - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackDouble
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference
open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackEnum
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-int/","title":"trackInt - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackInt
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference
open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-json/","title":"trackJson - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackJson
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-string/","title":"trackString - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/trackString
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference
open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/","title":"Companion - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/#properties","title":"Properties","text":"Name Summary defaultAttributes [jvm]val defaultAttributes: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/-k-e-y/","title":"KEY - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/Companion/KEY
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/default-attributes/","title":"defaultAttributes - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeLegacyFeatureFlags/Companion/defaultAttributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-legacy-feature-flags/-companion/default-attributes/#defaultattributes","title":"defaultAttributes","text":"[jvm]\\ val defaultAttributes: Attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/","title":"FakeStrongFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/#fakestrongfeatureflags","title":"FakeStrongFeatureFlags","text":"[jvm]\\ class FakeStrongFeatureFlags : StrongFeatureFlags
In-memory test implementation of FeatureFlags that allows for overriding strong feature flags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/#constructors","title":"Constructors","text":"FakeStrongFeatureFlags [jvm]constructor()"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String override [jvm]@JvmOverloadsinline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags@JvmOverloadsinline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags overrideAny [jvm]@JvmOverloadsfun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlagsGeneric flag override function. reset [jvm]fun reset(): FakeStrongFeatureFlags"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/-fake-strong-feature-flags/","title":"FakeStrongFeatureFlags - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/-fake-strong-feature-flags/#fakestrongfeatureflags","title":"FakeStrongFeatureFlags","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/get/","title":"get - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/get
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/get/#get","title":"get","text":"[jvm]\\ open override fun get(flag: BooleanFeatureFlag): Boolean
open override fun get(flag: StringFeatureFlag): String
open override fun get(flag: IntFeatureFlag): Int
open override fun get(flag: DoubleFeatureFlag): Double
open override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
open override fun <T : Any> get(flag: JsonFeatureFlag<T>): T
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override-any/","title":"overrideAny - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/overrideAny
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override-any/#overrideany","title":"overrideAny","text":"[jvm]\\
@JvmOverloads
fun <T : Any, Flag : FeatureFlag<in T>> overrideAny(clazz: Class<out FeatureFlag<T>>, value: T, matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
Generic flag override function.
Prefer override instead for a more convenient interface.
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override/","title":"override - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/override
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/override/#override","title":"override","text":"[jvm]\\
@JvmOverloads
inline fun <Flag : BooleanFeatureFlag> override(value: Boolean, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : StringFeatureFlag> override(value: String, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : IntFeatureFlag> override(value: Int, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : DoubleFeatureFlag> override(value: Double, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : JsonFeatureFlag<T>, T : Any> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
@JvmOverloads
inline fun <Flag : EnumFeatureFlag<T>, T : Enum<T>> override(value: T, noinline matcher: (Flag) -> Boolean = { _ -> true }): FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/reset/","title":"reset - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FakeStrongFeatureFlags/reset
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-fake-strong-feature-flags/reset/#reset","title":"reset","text":"[jvm]\\ fun reset(): FakeStrongFeatureFlags
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/","title":"FeaturesConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/#featuresconfig","title":"FeaturesConfig","text":"[jvm]\\ data class FeaturesConfig@JvmOverloadsconstructor(val featureName: String, val key: String? = null, val attributes: Attributes = Attributes(), val value: String, val type: String = \"String\")
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/#constructors","title":"Constructors","text":"FeaturesConfig [jvm]@JvmOverloadsconstructor(featureName: String, key: String? = null, attributes: Attributes = Attributes(), value: String, type: String = \"String\")"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/#properties","title":"Properties","text":"Name Summary attributes [jvm]val attributes: Attributes featureName [jvm]val featureName: String key [jvm]val key: String? = null type [jvm]val type: String value [jvm]val value: String"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/-features-config/","title":"FeaturesConfig - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/FeaturesConfig
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/-features-config/#featuresconfig","title":"FeaturesConfig","text":"[jvm]\\
@JvmOverloads
constructor(featureName: String, key: String? = null, attributes: Attributes = Attributes(), value: String, type: String = \"String\")
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/attributes/","title":"attributes - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/attributes/#attributes","title":"attributes","text":"[jvm]\\ val attributes: Attributes
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/feature-name/","title":"featureName - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/featureName
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/feature-name/#featurename","title":"featureName","text":"[jvm]\\ val featureName: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/key/","title":"key - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/key
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/key/#key","title":"key","text":"[jvm]\\ val key: String? = null
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/type/","title":"type - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/type
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/type/#type","title":"type","text":"[jvm]\\ val type: String
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/value/","title":"value - Misk","text":"//wisp-feature-testing/wisp.feature.testing/FeaturesConfig/value
"},{"location":"0.x/wisp-feature-testing/wisp-feature-testing/wisp.feature.testing/-features-config/value/#value","title":"value","text":"[jvm]\\ val value: String
"},{"location":"0.x/wisp-launchdarkly/","title":"wisp-launchdarkly - Misk","text":"//wisp-launchdarkly
"},{"location":"0.x/wisp-launchdarkly/#wisp-launchdarkly","title":"wisp-launchdarkly","text":""},{"location":"0.x/wisp-launchdarkly/#packages","title":"Packages","text":"Name wisp.launchdarkly"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/","title":"Package-level declarations - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/#types","title":"Types","text":"Name Summary LaunchDarklyClient [jvm]object LaunchDarklyClient LaunchDarklyClientMetrics [jvm]class LaunchDarklyClientMetrics(meterRegistry: MeterRegistry) LaunchDarklyConfig [jvm]data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val ssl: HttpClientSSLConfig? = null, val offline: Boolean = false, val event_capacity: Int = DEFAULT_CAPACITY) : Config LaunchDarklyDynamicConfig [jvm]class LaunchDarklyDynamicConfig(featureFlags: FeatureFlags) : DynamicConfig LaunchDarklyFeatureFlags [jvm]class LaunchDarklyFeatureFlags@JvmOverloadsconstructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry) : FeatureFlagsImplementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation."},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/","title":"LaunchDarklyClient - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClient
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/#launchdarklyclient","title":"LaunchDarklyClient","text":"[jvm]\\ object LaunchDarklyClient
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/#functions","title":"Functions","text":"Name Summary createLaunchDarklyClient [jvm]fun createLaunchDarklyClient(config: LaunchDarklyConfig, sslLoader: SslLoader, sslContextFactory: SslContextFactory, resourceLoader: ResourceLoader): LDClientInterfaceCreates the LaunchDarkly client interface with the supplied config"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/create-launch-darkly-client/","title":"createLaunchDarklyClient - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClient/createLaunchDarklyClient
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client/create-launch-darkly-client/#createlaunchdarklyclient","title":"createLaunchDarklyClient","text":"[jvm]\\ fun createLaunchDarklyClient(config: LaunchDarklyConfig, sslLoader: SslLoader, sslContextFactory: SslContextFactory, resourceLoader: ResourceLoader): LDClientInterface
Creates the LaunchDarkly client interface with the supplied config
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/","title":"LaunchDarklyClientMetrics - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#launchdarklyclientmetrics","title":"LaunchDarklyClientMetrics","text":"[jvm]\\ class LaunchDarklyClientMetrics(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#constructors","title":"Constructors","text":"LaunchDarklyClientMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/#functions","title":"Functions","text":"Name Summary onInitFailure [jvm]fun onInitFailure() onInitSuccess [jvm]fun onInitSuccess(duration: Long)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-launch-darkly-client-metrics/","title":"LaunchDarklyClientMetrics - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/LaunchDarklyClientMetrics
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-launch-darkly-client-metrics/#launchdarklyclientmetrics","title":"LaunchDarklyClientMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-failure/","title":"onInitFailure - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/onInitFailure
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-failure/#oninitfailure","title":"onInitFailure","text":"[jvm]\\ fun onInitFailure()
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-success/","title":"onInitSuccess - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/onInitSuccess
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/on-init-success/#oninitsuccess","title":"onInitSuccess","text":"[jvm]\\ fun onInitSuccess(duration: Long)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/","title":"Companion - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/#properties","title":"Properties","text":"Name Summary FAILED_COUNTER_NAME [jvm]const val FAILED_COUNTER_NAME: String INITIALIZATION_DURATION_NAME [jvm]const val INITIALIZATION_DURATION_NAME: String SUCCESS_COUNTER_NAME [jvm]const val SUCCESS_COUNTER_NAME: String"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/","title":"FAILED_COUNTER_NAME - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion/FAILED_COUNTER_NAME
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/#failed_counter_name","title":"FAILED_COUNTER_NAME","text":"[jvm]\\ const val FAILED_COUNTER_NAME: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-i-n-i-t-i-a-l-i-z-a-t-i-o-n_-d-u-r-a-t-i-o-n_-n-a-m-e/","title":"INITIALIZATION_DURATION_NAME - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion/INITIALIZATION_DURATION_NAME
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-i-n-i-t-i-a-l-i-z-a-t-i-o-n_-d-u-r-a-t-i-o-n_-n-a-m-e/#initialization_duration_name","title":"INITIALIZATION_DURATION_NAME","text":"[jvm]\\ const val INITIALIZATION_DURATION_NAME: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/","title":"SUCCESS_COUNTER_NAME - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyClientMetrics/Companion/SUCCESS_COUNTER_NAME
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-client-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/#success_counter_name","title":"SUCCESS_COUNTER_NAME","text":"[jvm]\\ const val SUCCESS_COUNTER_NAME: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\ data class LaunchDarklyConfig@JvmOverloadsconstructor(val sdk_key: String, val base_uri: String, val ssl: HttpClientSSLConfig? = null, val offline: Boolean = false, val event_capacity: Int = DEFAULT_CAPACITY) : Config
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/#constructors","title":"Constructors","text":"LaunchDarklyConfig [jvm]@JvmOverloadsconstructor(sdk_key: String, base_uri: String, ssl: HttpClientSSLConfig? = null, offline: Boolean = false, event_capacity: Int = DEFAULT_CAPACITY)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/#properties","title":"Properties","text":"Name Summary base_uri [jvm]val base_uri: String event_capacity [jvm]val event_capacity: Int offline [jvm]val offline: Boolean = false sdk_key [jvm]val sdk_key: String ssl [jvm]val ssl: HttpClientSSLConfig? = null"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/-launch-darkly-config/","title":"LaunchDarklyConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/LaunchDarklyConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/-launch-darkly-config/#launchdarklyconfig","title":"LaunchDarklyConfig","text":"[jvm]\\
@JvmOverloads
constructor(sdk_key: String, base_uri: String, ssl: HttpClientSSLConfig? = null, offline: Boolean = false, event_capacity: Int = DEFAULT_CAPACITY)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/base_uri/","title":"base_uri - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/base_uri
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/base_uri/#base_uri","title":"base_uri","text":"[jvm]\\ val base_uri: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/event_capacity/","title":"event_capacity - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/event_capacity
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/event_capacity/#event_capacity","title":"event_capacity","text":"[jvm]\\ val event_capacity: Int
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/offline/","title":"offline - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/offline
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/offline/#offline","title":"offline","text":"[jvm]\\ val offline: Boolean = false
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/sdk_key/","title":"sdk_key - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/sdk_key
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/sdk_key/#sdk_key","title":"sdk_key","text":"[jvm]\\ val sdk_key: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/ssl/","title":"ssl - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyConfig/ssl
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-config/ssl/#ssl","title":"ssl","text":"[jvm]\\ val ssl: HttpClientSSLConfig? = null
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\ class LaunchDarklyDynamicConfig(featureFlags: FeatureFlags) : DynamicConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#constructors","title":"Constructors","text":"LaunchDarklyDynamicConfig [jvm]constructor(featureFlags: FeatureFlags)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/#functions","title":"Functions","text":"Name Summary getBoolean [jvm]open override fun getBoolean(feature: Feature): Boolean getDouble [jvm]open override fun getDouble(feature: Feature): Double getEnum [jvm]open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T getInt [jvm]open override fun getInt(feature: Feature): Int getJson [jvm]open override fun <T> getJson(feature: Feature, clazz: Class<T>): T getJsonString [jvm]open override fun getJsonString(feature: Feature): String getString [jvm]open override fun getString(feature: Feature): String trackBoolean [jvm]open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/","title":"LaunchDarklyDynamicConfig - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/LaunchDarklyDynamicConfig
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-launch-darkly-dynamic-config/#launchdarklydynamicconfig","title":"LaunchDarklyDynamicConfig","text":"[jvm]\\ constructor(featureFlags: FeatureFlags)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-boolean/","title":"getBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature): Boolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-double/","title":"getDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature): Double
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-enum/","title":"getEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-int/","title":"getInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature): Int
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json-string/","title":"getJsonString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getJsonString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ open override fun getJsonString(feature: Feature): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json/","title":"getJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, clazz: Class<T>): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-string/","title":"getString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/getString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-double/","title":"trackDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-enum/","title":"trackEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-int/","title":"trackInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-json/","title":"trackJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-string/","title":"trackString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/trackString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/","title":"Companion - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/#properties","title":"Properties","text":"Name Summary ATTRIBUTES [jvm]val ATTRIBUTES: Attributes KEY [jvm]const val KEY: String"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/","title":"ATTRIBUTES - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/Companion/ATTRIBUTES
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-a-t-t-r-i-b-u-t-e-s/#attributes","title":"ATTRIBUTES","text":"[jvm]\\ val ATTRIBUTES: Attributes
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/","title":"KEY - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyDynamicConfig/Companion/KEY
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-dynamic-config/-companion/-k-e-y/#key","title":"KEY","text":"[jvm]\\ const val KEY: String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\ class LaunchDarklyFeatureFlags@JvmOverloadsconstructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry) : FeatureFlags
Implementation of FeatureFlags using LaunchDarkly\u2019s Java SDK. See https://docs.launchdarkly.com/docs/java-sdk-reference documentation.
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#constructors","title":"Constructors","text":"LaunchDarklyFeatureFlags [jvm]@JvmOverloadsconstructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/#functions","title":"Functions","text":"Name Summary get [jvm]open override fun get(flag: BooleanFeatureFlag): Booleanopen override fun get(flag: DoubleFeatureFlag): Doubleopen override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): Topen override fun get(flag: IntFeatureFlag): Intopen override fun <T : Any> get(flag: JsonFeatureFlag<T>): Topen override fun get(flag: StringFeatureFlag): String getBoolean [jvm]open fun getBoolean(feature: Feature, key: String): Booleanopen override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean getDouble [jvm]open fun getDouble(feature: Feature, key: String): Doubleopen override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double getEnum [jvm]open fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getInt [jvm]open fun getInt(feature: Feature, key: String): Intopen override fun getInt(feature: Feature, key: String, attributes: Attributes): Int getJson [jvm]open fun <T> getJson(feature: Feature, key: String, clazz: Class<T>): Topen override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T getJsonString [jvm]open fun getJsonString(feature: Feature, key: String): Stringopen override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String getString [jvm]open fun getString(feature: Feature, key: String): Stringopen override fun getString(feature: Feature, key: String, attributes: Attributes): String shutDown [jvm]fun shutDown() startUp [jvm]fun startUp(): LaunchDarklyFeatureFlags trackBoolean [jvm]open fun trackBoolean(feature: Feature, key: String, executor: Executor, tracker: (Boolean) -> Unit): TrackerReferenceopen override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference trackDouble [jvm]open fun trackDouble(feature: Feature, key: String, executor: Executor, tracker: (Double) -> Unit): TrackerReferenceopen override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference trackEnum [jvm]open fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackInt [jvm]open fun trackInt(feature: Feature, key: String, executor: Executor, tracker: (Int) -> Unit): TrackerReferenceopen override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference trackJson [jvm]open fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, executor: Executor, tracker: (T) -> Unit): TrackerReferenceopen override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference trackString [jvm]open fun trackString(feature: Feature, key: String, executor: Executor, tracker: (String) -> Unit): TrackerReferenceopen override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/","title":"LaunchDarklyFeatureFlags - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/LaunchDarklyFeatureFlags
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-launch-darkly-feature-flags/#launchdarklyfeatureflags","title":"LaunchDarklyFeatureFlags","text":"[jvm]\\
@JvmOverloads
constructor(ldClient: Lazy<LDClientInterface>, moshi: Moshi, meterRegistry: MeterRegistry = Metrics.globalRegistry)
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-boolean/","title":"getBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-boolean/#getboolean","title":"getBoolean","text":"[jvm]\\ open override fun getBoolean(feature: Feature, key: String, attributes: Attributes): Boolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-double/","title":"getDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-double/#getdouble","title":"getDouble","text":"[jvm]\\ open override fun getDouble(feature: Feature, key: String, attributes: Attributes): Double
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-enum/","title":"getEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-enum/#getenum","title":"getEnum","text":"[jvm]\\ open override fun <T : Enum<T>> getEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-int/","title":"getInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-int/#getint","title":"getInt","text":"[jvm]\\ open override fun getInt(feature: Feature, key: String, attributes: Attributes): Int
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json-string/","title":"getJsonString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getJsonString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json-string/#getjsonstring","title":"getJsonString","text":"[jvm]\\ open override fun getJsonString(feature: Feature, key: String, attributes: Attributes): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json/","title":"getJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-json/#getjson","title":"getJson","text":"[jvm]\\ open override fun <T> getJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-string/","title":"getString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/getString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get-string/#getstring","title":"getString","text":"[jvm]\\ open override fun getString(feature: Feature, key: String, attributes: Attributes): String
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get/","title":"get - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/get
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/get/#get","title":"get","text":"[jvm]\\ open override fun get(flag: BooleanFeatureFlag): Boolean
open override fun get(flag: StringFeatureFlag): String
open override fun get(flag: IntFeatureFlag): Int
open override fun get(flag: DoubleFeatureFlag): Double
open override fun <T : Enum<T>> get(flag: EnumFeatureFlag<T>): T
open override fun <T : Any> get(flag: JsonFeatureFlag<T>): T
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/shut-down/","title":"shutDown - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/shutDown
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/start-up/","title":"startUp - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/startUp
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/start-up/#startup","title":"startUp","text":"[jvm]\\ fun startUp(): LaunchDarklyFeatureFlags
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-boolean/","title":"trackBoolean - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackBoolean
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-boolean/#trackboolean","title":"trackBoolean","text":"[jvm]\\ open override fun trackBoolean(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Boolean) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-double/","title":"trackDouble - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackDouble
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-double/#trackdouble","title":"trackDouble","text":"[jvm]\\ open override fun trackDouble(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Double) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-enum/","title":"trackEnum - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackEnum
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-enum/#trackenum","title":"trackEnum","text":"[jvm]\\ open override fun <T : Enum<T>> trackEnum(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-int/","title":"trackInt - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackInt
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-int/#trackint","title":"trackInt","text":"[jvm]\\ open override fun trackInt(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (Int) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-json/","title":"trackJson - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackJson
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-json/#trackjson","title":"trackJson","text":"[jvm]\\ open override fun <T> trackJson(feature: Feature, key: String, clazz: Class<T>, attributes: Attributes, executor: Executor, tracker: (T) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-string/","title":"trackString - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/trackString
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/track-string/#trackstring","title":"trackString","text":"[jvm]\\ open override fun trackString(feature: Feature, key: String, attributes: Attributes, executor: Executor, tracker: (String) -> Unit): TrackerReference
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/","title":"Companion - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/#properties","title":"Properties","text":"Name Summary logger [jvm]val logger: KLogger"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/logger/","title":"logger - Misk","text":"//wisp-launchdarkly/wisp.launchdarkly/LaunchDarklyFeatureFlags/Companion/logger
"},{"location":"0.x/wisp-launchdarkly/wisp-launchdarkly/wisp.launchdarkly/-launch-darkly-feature-flags/-companion/logger/#logger","title":"logger","text":"[jvm]\\ val logger: KLogger
"},{"location":"0.x/wisp-lease/","title":"wisp-lease - Misk","text":"//wisp-lease
"},{"location":"0.x/wisp-lease/#wisp-lease","title":"wisp-lease","text":""},{"location":"0.x/wisp-lease/#packages","title":"Packages","text":"Name wisp.lease wisp.lease.pool"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/","title":"Package-level declarations - Misk","text":"//wisp-lease/wisp.lease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/#types","title":"Types","text":"Name Summary AutoCloseableLease [jvm]class AutoCloseableLease(lease: Lease) : Lease, AutoCloseableConverts a lease into an AutoCloseable resource. Lease [jvm]interface LeaseA Lease is a cluster-wide time-based lock on a given resource. Leases are retrieved via LeaseManager.requestLease. LeaseManager [jvm]interface LeaseManager"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/#functions","title":"Functions","text":"Name Summary acquireOrNull [jvm]fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?Attempts to acquire an AutoCloseableLease."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/acquire-or-null/","title":"acquireOrNull - Misk","text":"//wisp-lease/wisp.lease/acquireOrNull
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/acquire-or-null/#acquireornull","title":"acquireOrNull","text":"[jvm]\\ fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?
Attempts to acquire an AutoCloseableLease.
Use like
leaseManager.acquireOrNull(\"some-lease\")?.use { lease ->\n // Do something with the lease.\n}\n//wisp-lease/wisp.lease/AutoCloseableLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#autocloseablelease","title":"AutoCloseableLease","text":"[jvm]\\ class AutoCloseableLease(lease: Lease) : Lease, AutoCloseable
Converts a lease into an AutoCloseable resource.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#constructors","title":"Constructors","text":"AutoCloseableLease [jvm]constructor(lease: Lease)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): BooleanAttempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified. addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener)Registers a listener that is called on lease state changes. checkHeld [jvm]open override fun checkHeld(): Boolean close [jvm]open override fun close() release [jvm]open override fun release(): BooleanRelease the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/-auto-closeable-lease/","title":"AutoCloseableLease - Misk","text":"//wisp-lease/wisp.lease/AutoCloseableLease/AutoCloseableLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/-auto-closeable-lease/#autocloseablelease","title":"AutoCloseableLease","text":"[jvm]\\ constructor(lease: Lease)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/close/","title":"close - Misk","text":"//wisp-lease/wisp.lease/AutoCloseableLease/close
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-auto-closeable-lease/close/#close","title":"close","text":"[jvm]\\ open override fun close()
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/","title":"Lease - Misk","text":"//wisp-lease/wisp.lease/Lease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#lease","title":"Lease","text":"interface Lease
A Lease is a cluster-wide time-based lock on a given resource. Leases are retrieved via LeaseManager.requestLease.
It should be assumed that calls to checkHeld, acquire and release could invoke remote calls, so consider usage carefully.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#inheritors","title":"Inheritors","text":"AutoCloseableLease PoolLease"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#types","title":"Types","text":"Name Summary StateChangeListener [jvm]interface StateChangeListener"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#properties","title":"Properties","text":"Name Summary name [jvm]abstract val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]abstract fun acquire(): BooleanAttempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified. addListener [jvm]abstract fun addListener(listener: Lease.StateChangeListener)Registers a listener that is called on lease state changes. checkHeld [jvm]abstract fun checkHeld(): Boolean release [jvm]abstract fun release(): BooleanRelease the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/acquire/","title":"acquire - Misk","text":"//wisp-lease/wisp.lease/Lease/acquire
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ abstract fun acquire(): Boolean
Attempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/acquire/#return","title":"Return","text":"true if this process acquires the lease.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/add-listener/","title":"addListener - Misk","text":"//wisp-lease/wisp.lease/Lease/addListener
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/add-listener/#addlistener","title":"addListener","text":"[jvm]\\ abstract fun addListener(listener: Lease.StateChangeListener)
Registers a listener that is called on lease state changes.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/check-held/","title":"checkHeld - Misk","text":"//wisp-lease/wisp.lease/Lease/checkHeld
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ abstract fun checkHeld(): Boolean
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/check-held/#return","title":"Return","text":"true if the lease is owned by this process instance.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/name/","title":"name - Misk","text":"//wisp-lease/wisp.lease/Lease/name
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/name/#name","title":"name","text":"[jvm]\\ abstract val name: String
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/release/","title":"release - Misk","text":"//wisp-lease/wisp.lease/Lease/release
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/release/#release","title":"release","text":"[jvm]\\ abstract fun release(): Boolean
Release the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/","title":"StateChangeListener - Misk","text":"//wisp-lease/wisp.lease/Lease/StateChangeListener
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/#statechangelistener","title":"StateChangeListener","text":"[jvm]\\ interface StateChangeListener
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/#functions","title":"Functions","text":"Name Summary afterAcquire [jvm]abstract fun afterAcquire(lease: Lease)Called immediately after the lease is acquired. Also called immediately if the lease is already owned by this process instance when the listener is registered. beforeRelease [jvm]abstract fun beforeRelease(lease: Lease)Called immediately before the lease is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/after-acquire/","title":"afterAcquire - Misk","text":"//wisp-lease/wisp.lease/Lease/StateChangeListener/afterAcquire
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/after-acquire/#afteracquire","title":"afterAcquire","text":"[jvm]\\ abstract fun afterAcquire(lease: Lease)
Called immediately after the lease is acquired. Also called immediately if the lease is already owned by this process instance when the listener is registered.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/after-acquire/#parameters","title":"Parameters","text":"jvm
lease the lease that is acquired"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/before-release/","title":"beforeRelease - Misk","text":"//wisp-lease/wisp.lease/Lease/StateChangeListener/beforeRelease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/before-release/#beforerelease","title":"beforeRelease","text":"[jvm]\\ abstract fun beforeRelease(lease: Lease)
Called immediately before the lease is released.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease/-state-change-listener/before-release/#parameters","title":"Parameters","text":"jvm
lease the lease that is released"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/","title":"LeaseManager - Misk","text":"//wisp-lease/wisp.lease/LeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/#leasemanager","title":"LeaseManager","text":"interface LeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/#inheritors","title":"Inheritors","text":"PoolLeaseManager"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/#functions","title":"Functions","text":"Name Summary acquireOrNull [jvm]fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?Attempts to acquire an AutoCloseableLease. releaseAll [jvm]open fun releaseAll() requestLease [jvm]abstract fun requestLease(name: String): LeaseRegisters interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/release-all/","title":"releaseAll - Misk","text":"//wisp-lease/wisp.lease/LeaseManager/releaseAll
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ open fun releaseAll()
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/request-lease/","title":"requestLease - Misk","text":"//wisp-lease/wisp.lease/LeaseManager/requestLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease/-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ abstract fun requestLease(name: String): Lease
Registers interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/","title":"Package-level declarations - Misk","text":"//wisp-lease/wisp.lease.pool
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/#types","title":"Types","text":"Name Summary PoolLease [jvm]class PoolLease(delegateLease: Lease, poolLeaseManager: PoolLeaseManager) : Lease PoolLeaseConfig [jvm]data class PoolLeaseConfig(val name: String, val leaseNames: List<String>) PoolLeaseManager [jvm]class PoolLeaseManager(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>) : LeaseManagerA LeaseManager that ensures that leases that are in the same lease pool are acquired on different instances. It requires a delegate LeaseManager to handle the Lease implementation."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/","title":"PoolLease - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#poollease","title":"PoolLease","text":"[jvm]\\ class PoolLease(delegateLease: Lease, poolLeaseManager: PoolLeaseManager) : Lease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#constructors","title":"Constructors","text":"PoolLease [jvm]constructor(delegateLease: Lease, poolLeaseManager: PoolLeaseManager)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): BooleanAttempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified. addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener)Registers a listener that is called on lease state changes. checkHeld [jvm]open override fun checkHeld(): BooleanCan always use the delegate\u2019s result release [jvm]open override fun release(): BooleanRelease the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released."},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/-pool-lease/","title":"PoolLease - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/PoolLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/-pool-lease/#poollease","title":"PoolLease","text":"[jvm]\\ constructor(delegateLease: Lease, poolLeaseManager: PoolLeaseManager)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/acquire/","title":"acquire - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/acquire
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Boolean
Attempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/acquire/#return","title":"Return","text":"true if this process acquires the lease.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/check-held/","title":"checkHeld - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/checkHeld
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ open override fun checkHeld(): Boolean
Can always use the delegate\u2019s result
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/release/","title":"release - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLease/release
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease/release/#release","title":"release","text":"[jvm]\\ open override fun release(): Boolean
Release the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/","title":"PoolLeaseConfig - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/#poolleaseconfig","title":"PoolLeaseConfig","text":"[jvm]\\ data class PoolLeaseConfig(val name: String, val leaseNames: List<String>)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/#constructors","title":"Constructors","text":"PoolLeaseConfig [jvm]constructor(name: String, leaseNames: List<String>)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/#properties","title":"Properties","text":"Name Summary leaseNames [jvm]val leaseNames: List<String> name [jvm]val name: String"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/-pool-lease-config/","title":"PoolLeaseConfig - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig/PoolLeaseConfig
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/-pool-lease-config/#poolleaseconfig","title":"PoolLeaseConfig","text":"[jvm]\\ constructor(name: String, leaseNames: List<String>)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/lease-names/","title":"leaseNames - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig/leaseNames
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/lease-names/#leasenames","title":"leaseNames","text":"[jvm]\\ val leaseNames: List<String>
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/name/","title":"name - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseConfig/name
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-config/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/","title":"PoolLeaseManager - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/#poolleasemanager","title":"PoolLeaseManager","text":"[jvm]\\ class PoolLeaseManager(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>) : LeaseManager
A LeaseManager that ensures that leases that are in the same lease pool are acquired on different instances. It requires a delegate LeaseManager to handle the Lease implementation.
This lease acquisition restriction is applied when Deployment.isReal is true.
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/#constructors","title":"Constructors","text":"PoolLeaseManager [jvm]constructor(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>)"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/#functions","title":"Functions","text":"Name Summary acquireOrNull [jvm]fun LeaseManager.acquireOrNull(name: String): AutoCloseableLease?Attempts to acquire an AutoCloseableLease. releaseAll [jvm]open override fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): LeaseRegisters interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/-pool-lease-manager/","title":"PoolLeaseManager - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager/PoolLeaseManager
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/-pool-lease-manager/#poolleasemanager","title":"PoolLeaseManager","text":"[jvm]\\ constructor(delegateLeaseManager: LeaseManager, deployment: Deployment, poolConfig: List<PoolLeaseConfig>)
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/release-all/","title":"releaseAll - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager/releaseAll
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ open override fun releaseAll()
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/request-lease/","title":"requestLease - Misk","text":"//wisp-lease/wisp.lease.pool/PoolLeaseManager/requestLease
"},{"location":"0.x/wisp-lease/wisp-lease/wisp.lease.pool/-pool-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ open override fun requestLease(name: String): Lease
Registers interest in the lease with the given name. Service instances should register their interest in leases as soon as they know about them; this gives the process an opportunity to notify the underlying cluster system that it is interested in the lease, or to setup other background tasks to acquire the lease if necessary. Note that registering interest in a lease doesn\u2019t necessarily mean that this service instance will attempt to acquire the lease; many clustering systems will only try to acquire leases for resources that they think they should own based on some consistent hashing system
"},{"location":"0.x/wisp-lease-testing/","title":"wisp-lease-testing - Misk","text":"//wisp-lease-testing
"},{"location":"0.x/wisp-lease-testing/#wisp-lease-testing","title":"wisp-lease-testing","text":""},{"location":"0.x/wisp-lease-testing/#packages","title":"Packages","text":"Name wisp.lease"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/","title":"Package-level declarations - Misk","text":"//wisp-lease-testing/wisp.lease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/#types","title":"Types","text":"Name Summary FakeLease [jvm]class FakeLease(val name: String, manager: FakeLeaseManager) : Lease FakeLeaseManager [jvm]open class FakeLeaseManager : LeaseManagerA FakeLeaseManager provides explicit control over leases for the purposes of testing. By default, a fake lease is considered held, but it can be explicitly marked as not held if desired"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/","title":"FakeLease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#fakelease","title":"FakeLease","text":"[jvm]\\ class FakeLease(val name: String, manager: FakeLeaseManager) : Lease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#constructors","title":"Constructors","text":"FakeLease [jvm]constructor(name: String, manager: FakeLeaseManager)"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#properties","title":"Properties","text":"Name Summary name [jvm]open override val name: String"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/#functions","title":"Functions","text":"Name Summary acquire [jvm]open override fun acquire(): Boolean addListener [jvm]open override fun addListener(listener: Lease.StateChangeListener) checkHeld [jvm]open override fun checkHeld(): Boolean notifyAfterAcquire [jvm]fun notifyAfterAcquire() notifyBeforeRelease [jvm]fun notifyBeforeRelease() release [jvm]open override fun release(): BooleanRelease the lease. This will return true if released. Note that it will return false if the lease was not held."},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/-fake-lease/","title":"FakeLease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/FakeLease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/-fake-lease/#fakelease","title":"FakeLease","text":"[jvm]\\ constructor(name: String, manager: FakeLeaseManager)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/acquire/","title":"acquire - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/acquire
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/acquire/#acquire","title":"acquire","text":"[jvm]\\ open override fun acquire(): Boolean
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/acquire/#return","title":"Return","text":"true if this process acquires the lease.
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/add-listener/","title":"addListener - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/addListener
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/add-listener/#addlistener","title":"addListener","text":"[jvm]\\ open override fun addListener(listener: Lease.StateChangeListener)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/check-held/","title":"checkHeld - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/checkHeld
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/check-held/#checkheld","title":"checkHeld","text":"[jvm]\\ open override fun checkHeld(): Boolean
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/name/","title":"name - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/name
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/name/#name","title":"name","text":"[jvm]\\ open override val name: String
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-after-acquire/","title":"notifyAfterAcquire - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/notifyAfterAcquire
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-after-acquire/#notifyafteracquire","title":"notifyAfterAcquire","text":"[jvm]\\ fun notifyAfterAcquire()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-before-release/","title":"notifyBeforeRelease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/notifyBeforeRelease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/notify-before-release/#notifybeforerelease","title":"notifyBeforeRelease","text":"[jvm]\\ fun notifyBeforeRelease()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/release/","title":"release - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLease/release
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease/release/#release","title":"release","text":"[jvm]\\ open override fun release(): Boolean
Release the lease. This will return true if released. Note that it will return false if the lease was not held.
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\ open class FakeLeaseManager : LeaseManager
A FakeLeaseManager provides explicit control over leases for the purposes of testing. By default, a fake lease is considered held, but it can be explicitly marked as not held if desired
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/#constructors","title":"Constructors","text":"FakeLeaseManager [jvm]constructor()"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/#functions","title":"Functions","text":"Name Summary isLeaseHeld [jvm]fun isLeaseHeld(name: String): Boolean markLeaseHeld [jvm]fun markLeaseHeld(name: String) markLeaseHeldElsewhere [jvm]fun markLeaseHeldElsewhere(name: String) releaseAll [jvm]open override fun releaseAll() requestLease [jvm]open override fun requestLease(name: String): Lease"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/-fake-lease-manager/","title":"FakeLeaseManager - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/FakeLeaseManager
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/-fake-lease-manager/#fakeleasemanager","title":"FakeLeaseManager","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/is-lease-held/","title":"isLeaseHeld - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/isLeaseHeld
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/is-lease-held/#isleaseheld","title":"isLeaseHeld","text":"[jvm]\\ fun isLeaseHeld(name: String): Boolean
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held-elsewhere/","title":"markLeaseHeldElsewhere - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/markLeaseHeldElsewhere
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held-elsewhere/#markleaseheldelsewhere","title":"markLeaseHeldElsewhere","text":"[jvm]\\ fun markLeaseHeldElsewhere(name: String)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held/","title":"markLeaseHeld - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/markLeaseHeld
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/mark-lease-held/#markleaseheld","title":"markLeaseHeld","text":"[jvm]\\ fun markLeaseHeld(name: String)
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/release-all/","title":"releaseAll - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/releaseAll
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/release-all/#releaseall","title":"releaseAll","text":"[jvm]\\ open override fun releaseAll()
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/request-lease/","title":"requestLease - Misk","text":"//wisp-lease-testing/wisp.lease/FakeLeaseManager/requestLease
"},{"location":"0.x/wisp-lease-testing/wisp-lease-testing/wisp.lease/-fake-lease-manager/request-lease/#requestlease","title":"requestLease","text":"[jvm]\\ open override fun requestLease(name: String): Lease
"},{"location":"0.x/wisp-logging/","title":"wisp-logging - Misk","text":"//wisp-logging
"},{"location":"0.x/wisp-logging/#wisp-logging","title":"wisp-logging","text":""},{"location":"0.x/wisp-logging/#packages","title":"Packages","text":"Name wisp.logging"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/","title":"Package-level declarations - Misk","text":"//wisp-logging/wisp.logging
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/#types","title":"Types","text":"Name Summary Copyable [jvm]interface Copyable<out T : Copyable<T>> SampledLogger [jvm]open class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger Tag [jvm]typealias Tag = Pair<String, Any?> TaggedLogger [jvm]@ExperimentalMiskApiabstract class TaggedLogger<L : Any, out R : TaggedLogger<L, R>, Copyable<R>>(kLogger: KLogger, tags: Set<Tag>) : KLogger, Copyable<R> This is a logging class to help apply and remove MDC context tags from within calls in service code."},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/#functions","title":"Functions","text":"Name Summary debug [jvm]fun KLogger.debug(vararg tags: Tag, message: () -> Any?)fun KLogger.debug(th: Throwable, vararg tags: Tag, message: () -> Any?) error [jvm]fun KLogger.error(vararg tags: Tag, message: () -> Any?)fun KLogger.error(th: Throwable, vararg tags: Tag, message: () -> Any?) getLogger [jvm]inline fun <T> getLogger(): KLogger info [jvm]fun KLogger.info(vararg tags: Tag, message: () -> Any?)fun KLogger.info(th: Throwable, vararg tags: Tag, message: () -> Any?) log [jvm]fun KLogger.log(level: Level, vararg tags: Tag, message: () -> Any?)fun KLogger.log(level: Level, th: Throwable, vararg tags: Tag, message: () -> Any?) sampled [jvm]fun KLogger.sampled(sampler: Sampler = Sampler.rateLimiting(1L)): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton. trace [jvm]fun KLogger.trace(vararg tags: Tag, message: () -> Any?)fun KLogger.trace(th: Throwable, vararg tags: Tag, message: () -> Any?) warn [jvm]fun KLogger.warn(vararg tags: Tag, message: () -> Any?)fun KLogger.warn(th: Throwable, vararg tags: Tag, message: () -> Any?) withTags [jvm]fun withTags(vararg tags: Tag, f: () -> Unit)"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/debug/","title":"debug - Misk","text":"//wisp-logging/wisp.logging/debug
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/debug/#debug","title":"debug","text":"[jvm]\\ fun KLogger.debug(vararg tags: Tag, message: () -> Any?)
fun KLogger.debug(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/error/","title":"error - Misk","text":"//wisp-logging/wisp.logging/error
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/error/#error","title":"error","text":"[jvm]\\ fun KLogger.error(vararg tags: Tag, message: () -> Any?)
fun KLogger.error(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/get-logger/","title":"getLogger - Misk","text":"//wisp-logging/wisp.logging/getLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/get-logger/#getlogger","title":"getLogger","text":"[jvm]\\ inline fun <T> getLogger(): KLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/info/","title":"info - Misk","text":"//wisp-logging/wisp.logging/info
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/info/#info","title":"info","text":"[jvm]\\ fun KLogger.info(vararg tags: Tag, message: () -> Any?)
fun KLogger.info(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/log/","title":"log - Misk","text":"//wisp-logging/wisp.logging/log
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/log/#log","title":"log","text":"[jvm]\\ fun KLogger.log(level: Level, vararg tags: Tag, message: () -> Any?)
fun KLogger.log(level: Level, th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/sampled/","title":"sampled - Misk","text":"//wisp-logging/wisp.logging/sampled
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/sampled/#sampled","title":"sampled","text":"[jvm]\\ fun KLogger.sampled(sampler: Sampler = Sampler.rateLimiting(1L)): KLogger
Returns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton.
To use default sampler (rate limited to 1 log per second):
val logger = getLogger<MyClass>().sampled()\nTo get a rate limited logger:
val logger = getLogger<MyClass>().sampled((Sampler.rateLimiting(RATE_PER_SECOND))\nTo get a probabilistic sampler
val logger = getLogger<MyClass>().sampled(Sampler.percentage(PERCENTAGE_TO_ALLOW))\nwrapped logger instance
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/sampled/#parameters","title":"Parameters","text":"jvm
sampler Sampler to use to sample logs"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/trace/","title":"trace - Misk","text":"//wisp-logging/wisp.logging/trace
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/trace/#trace","title":"trace","text":"[jvm]\\ fun KLogger.trace(vararg tags: Tag, message: () -> Any?)
fun KLogger.trace(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/warn/","title":"warn - Misk","text":"//wisp-logging/wisp.logging/warn
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/warn/#warn","title":"warn","text":"[jvm]\\ fun KLogger.warn(vararg tags: Tag, message: () -> Any?)
fun KLogger.warn(th: Throwable, vararg tags: Tag, message: () -> Any?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/with-tags/","title":"withTags - Misk","text":"//wisp-logging/wisp.logging/withTags
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/with-tags/#withtags","title":"withTags","text":"[jvm]\\ fun withTags(vararg tags: Tag, f: () -> Unit)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/","title":"Copyable - Misk","text":"//wisp-logging/wisp.logging/Copyable
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/#copyable","title":"Copyable","text":"interface Copyable<out T : Copyable<T>>
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/#inheritors","title":"Inheritors","text":"TaggedLogger"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/#functions","title":"Functions","text":"Name Summary copyWithNewTags [jvm]abstract fun copyWithNewTags(newTags: Set<Tag>): T"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/copy-with-new-tags/","title":"copyWithNewTags - Misk","text":"//wisp-logging/wisp.logging/Copyable/copyWithNewTags
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-copyable/copy-with-new-tags/#copywithnewtags","title":"copyWithNewTags","text":"[jvm]\\ abstract fun copyWithNewTags(newTags: Set<Tag>): T
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/","title":"SampledLogger - Misk","text":"//wisp-logging/wisp.logging/SampledLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ open class SampledLogger(val underlyingLogger: KLogger, sampler: Sampler) : KLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#constructors","title":"Constructors","text":"SampledLogger [jvm]constructor(underlyingLogger: KLogger, sampler: Sampler)"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#properties","title":"Properties","text":"Name Summary underlyingLogger [jvm]open override val underlyingLogger: KLogger"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/#functions","title":"Functions","text":"Name Summary atDebug [jvm]@CheckReturnValueopen fun atDebug(): LoggingEventBuilder atError [jvm]@CheckReturnValueopen fun atError(): LoggingEventBuilder atInfo [jvm]@CheckReturnValueopen fun atInfo(): LoggingEventBuilder atLevel [jvm]@CheckReturnValueopen fun atLevel(p0: Level): LoggingEventBuilder atTrace [jvm]@CheckReturnValueopen fun atTrace(): LoggingEventBuilder atWarn [jvm]@CheckReturnValueopen fun atWarn(): LoggingEventBuilder catching [jvm]open override fun <T : Throwable> catching(throwable: T) debug [jvm]open override fun debug(msg: () -> Any?)open override fun debug(msg: String?)open override fun debug(format: String?, arg: Any?)open override fun debug(format: String?, vararg arguments: Any?)open override fun debug(msg: String?, t: Throwable?)open override fun debug(t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: () -> Any?)open override fun debug(marker: Marker?, msg: String?)open override fun debug(format: String?, arg1: Any?, arg2: Any?)open override fun debug(marker: Marker?, format: String?, arg: Any?)open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)open override fun debug(marker: Marker?, msg: String?, t: Throwable?)open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) debug [jvm]fun KLogger.debug(vararg tags: Tag, message: () -> Any?)fun KLogger.debug(th: Throwable, vararg tags: Tag, message: () -> Any?) entry [jvm]open override fun entry(vararg argArray: Any?) error [jvm]open override fun error(msg: () -> Any?)open override fun error(msg: String?)open override fun error(format: String?, arg: Any?)open override fun error(format: String?, vararg arguments: Any?)open override fun error(msg: String?, t: Throwable?)open override fun error(t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, msg: () -> Any?)open override fun error(marker: Marker?, msg: String?)open override fun error(format: String?, arg1: Any?, arg2: Any?)open override fun error(marker: Marker?, format: String?, arg: Any?)open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)open override fun error(marker: Marker?, msg: String?, t: Throwable?)open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) error [jvm]fun KLogger.error(vararg tags: Tag, message: () -> Any?)fun KLogger.error(th: Throwable, vararg tags: Tag, message: () -> Any?) exit [jvm]open override fun exit()open override fun <T> exit(result: T): T getName [jvm]open override fun getName(): String info [jvm]open override fun info(msg: () -> Any?)open override fun info(msg: String?)open override fun info(format: String?, arg: Any?)open override fun info(format: String?, vararg arguments: Any?)open override fun info(msg: String?, t: Throwable?)open override fun info(t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, msg: () -> Any?)open override fun info(marker: Marker?, msg: String?)open override fun info(format: String?, arg1: Any?, arg2: Any?)open override fun info(marker: Marker?, format: String?, arg: Any?)open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)open override fun info(marker: Marker?, msg: String?, t: Throwable?)open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) info [jvm]fun KLogger.info(vararg tags: Tag, message: () -> Any?)fun KLogger.info(th: Throwable, vararg tags: Tag, message: () -> Any?) isDebugEnabled [jvm]open override fun isDebugEnabled(): Booleanopen override fun isDebugEnabled(p0: Marker): Boolean isEnabledForLevel [jvm]open fun isEnabledForLevel(p0: Level): Boolean isErrorEnabled [jvm]open override fun isErrorEnabled(): Booleanopen override fun isErrorEnabled(p0: Marker): Boolean isInfoEnabled [jvm]open override fun isInfoEnabled(): Booleanopen override fun isInfoEnabled(p0: Marker): Boolean isTraceEnabled [jvm]open override fun isTraceEnabled(): Booleanopen override fun isTraceEnabled(p0: Marker): Boolean isWarnEnabled [jvm]open override fun isWarnEnabled(): Booleanopen override fun isWarnEnabled(p0: Marker): Boolean log [jvm]fun KLogger.log(level: Level, vararg tags: Tag, message: () -> Any?)fun KLogger.log(level: Level, th: Throwable, vararg tags: Tag, message: () -> Any?) makeLoggingEventBuilder [jvm]open fun makeLoggingEventBuilder(p0: Level): LoggingEventBuilder sampled [jvm]fun KLogger.sampled(sampler: Sampler = Sampler.rateLimiting(1L)): KLoggerReturns a logger that samples logs. This logger MUST be instantiated statically, in a companion object or as a Singleton. throwing [jvm]open override fun <T : Throwable> throwing(throwable: T): T trace [jvm]open override fun trace(msg: () -> Any?)open override fun trace(msg: String?)open override fun trace(format: String?, arg: Any?)open override fun trace(format: String?, vararg arguments: Any?)open override fun trace(msg: String?, t: Throwable?)open override fun trace(t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: () -> Any?)open override fun trace(marker: Marker?, msg: String?)open override fun trace(format: String?, arg1: Any?, arg2: Any?)open override fun trace(marker: Marker?, format: String?, arg: Any?)open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)open override fun trace(marker: Marker?, msg: String?, t: Throwable?)open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) trace [jvm]fun KLogger.trace(vararg tags: Tag, message: () -> Any?)fun KLogger.trace(th: Throwable, vararg tags: Tag, message: () -> Any?) warn [jvm]open override fun warn(msg: () -> Any?)open override fun warn(msg: String?)open override fun warn(format: String?, arg: Any?)open override fun warn(format: String?, vararg arguments: Any?)open override fun warn(msg: String?, t: Throwable?)open override fun warn(t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: () -> Any?)open override fun warn(marker: Marker?, msg: String?)open override fun warn(format: String?, arg1: Any?, arg2: Any?)open override fun warn(marker: Marker?, format: String?, arg: Any?)open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)open override fun warn(marker: Marker?, msg: String?, t: Throwable?)open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?) warn [jvm]fun KLogger.warn(vararg tags: Tag, message: () -> Any?)fun KLogger.warn(th: Throwable, vararg tags: Tag, message: () -> Any?)"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/-sampled-logger/","title":"SampledLogger - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/SampledLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/-sampled-logger/#sampledlogger","title":"SampledLogger","text":"[jvm]\\ constructor(underlyingLogger: KLogger, sampler: Sampler)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/debug/","title":"debug - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/debug
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/debug/#debug","title":"debug","text":"[jvm]\\ open override fun debug(msg: () -> Any?)
open override fun debug(t: Throwable?, msg: () -> Any?)
open override fun debug(marker: Marker?, msg: () -> Any?)
open override fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun debug(msg: String?)
open override fun debug(format: String?, arg: Any?)
open override fun debug(format: String?, arg1: Any?, arg2: Any?)
open override fun debug(format: String?, vararg arguments: Any?)
open override fun debug(msg: String?, t: Throwable?)
open override fun debug(marker: Marker?, msg: String?)
open override fun debug(marker: Marker?, format: String?, arg: Any?)
open override fun debug(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun debug(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun debug(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/error/","title":"error - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/error
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/error/#error","title":"error","text":"[jvm]\\ open override fun error(msg: () -> Any?)
open override fun error(t: Throwable?, msg: () -> Any?)
open override fun error(marker: Marker?, msg: () -> Any?)
open override fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun error(msg: String?)
open override fun error(format: String?, arg: Any?)
open override fun error(format: String?, arg1: Any?, arg2: Any?)
open override fun error(format: String?, vararg arguments: Any?)
open override fun error(msg: String?, t: Throwable?)
open override fun error(marker: Marker?, msg: String?)
open override fun error(marker: Marker?, format: String?, arg: Any?)
open override fun error(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun error(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun error(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/info/","title":"info - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/info
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/info/#info","title":"info","text":"[jvm]\\ open override fun info(msg: () -> Any?)
open override fun info(t: Throwable?, msg: () -> Any?)
open override fun info(marker: Marker?, msg: () -> Any?)
open override fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun info(msg: String?)
open override fun info(format: String?, arg: Any?)
open override fun info(format: String?, arg1: Any?, arg2: Any?)
open override fun info(format: String?, vararg arguments: Any?)
open override fun info(msg: String?, t: Throwable?)
open override fun info(marker: Marker?, msg: String?)
open override fun info(marker: Marker?, format: String?, arg: Any?)
open override fun info(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun info(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun info(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/trace/","title":"trace - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/trace
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/trace/#trace","title":"trace","text":"[jvm]\\ open override fun trace(msg: () -> Any?)
open override fun trace(t: Throwable?, msg: () -> Any?)
open override fun trace(marker: Marker?, msg: () -> Any?)
open override fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun trace(msg: String?)
open override fun trace(format: String?, arg: Any?)
open override fun trace(format: String?, arg1: Any?, arg2: Any?)
open override fun trace(format: String?, vararg arguments: Any?)
open override fun trace(msg: String?, t: Throwable?)
open override fun trace(marker: Marker?, msg: String?)
open override fun trace(marker: Marker?, format: String?, arg: Any?)
open override fun trace(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun trace(marker: Marker?, format: String?, vararg argArray: Any?)
open override fun trace(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/underlying-logger/","title":"underlyingLogger - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/underlyingLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/underlying-logger/#underlyinglogger","title":"underlyingLogger","text":"[jvm]\\ open override val underlyingLogger: KLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/warn/","title":"warn - Misk","text":"//wisp-logging/wisp.logging/SampledLogger/warn
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-sampled-logger/warn/#warn","title":"warn","text":"[jvm]\\ open override fun warn(msg: () -> Any?)
open override fun warn(t: Throwable?, msg: () -> Any?)
open override fun warn(marker: Marker?, msg: () -> Any?)
open override fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)
open override fun warn(msg: String?)
open override fun warn(format: String?, arg: Any?)
open override fun warn(format: String?, vararg arguments: Any?)
open override fun warn(format: String?, arg1: Any?, arg2: Any?)
open override fun warn(msg: String?, t: Throwable?)
open override fun warn(marker: Marker?, msg: String?)
open override fun warn(marker: Marker?, format: String?, arg: Any?)
open override fun warn(marker: Marker?, format: String?, arg1: Any?, arg2: Any?)
open override fun warn(marker: Marker?, format: String?, vararg arguments: Any?)
open override fun warn(marker: Marker?, msg: String?, t: Throwable?)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tag/","title":"Tag - Misk","text":"//wisp-logging/wisp.logging/Tag
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tag/#tag","title":"Tag","text":"[jvm]\\ typealias Tag = Pair<String, Any?>
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/","title":"TaggedLogger - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/#taggedlogger","title":"TaggedLogger","text":"[jvm]\\ @ExperimentalMiskApi
abstract class TaggedLogger<L : Any, out R : TaggedLogger<L, R>, Copyable<R>>(kLogger: KLogger, tags: Set<Tag>) : KLogger, Copyable<R>
This is a logging class to help apply and remove MDC context tags from within calls in service code.
In particular, it solves the problem with searching logs using the MDC context tags where an exception caught and thrown by misk doesn\u2019t include the MDC tags and doesn\u2019t show up in the search. Using this will mean exceptions will be visible in the sequence of logs relating to a tag. See the logging example below for usage and the logging output.
Usage:
First set up a logger class with relevant MDC functions for the code base:
data class MyServiceLogger<T: Any>(\n val loggerClass: KClass<T>,\n val tags: Set<Tag> = emptySet()\n): TaggedLogger<T, MyServiceLogger<T>>(loggerClass, tags) {\n fun processValue(value: String?) = tag(\"process_value\" to value)\n\n override fun copyWithNewTags(newTags: Set<Tag>): MyServiceLogger<T>\n = this.copy(tags = newTags)\n}\nCreate a global helper function to return the above class Can be called from companion objects or regular classes - will find correct logger
fun <T : Any> KClass<T>.getTaggedLogger(): MyServiceLogger<T> {\n return MyServiceLogger(this)\n}\nThen to use the tagged logger for example:
class ServiceAction (private val webClient: WebClient): WebAction {\n\n @Post(\"/api/resource\")\n fun executeWebAction(@RequestBody request: ServiceActionRequest) {\n logger\n .processValue(request.process_value)\n .asContext() {\n logger.info() { \"Received request\" }\n doSomething()\n }\n }\n\n private fun doSomething() {\n logger.info() { \"Start Process\" }\n\n client.someWebRequest() // Client throws exception to be caught and logged by misk framework\n\n logger.info() { \"Done\" }\n }\n\n companion object {\n val logger = this::class.getTaggedLogger()\n }\n}\nLogging result:
Log MDC context: [process_value: PV_123] Log message: \"Received request\"\nLog MDC context: [process_value: PV_123] Log message: \"Start Process\"\nLog MDC context: [process_value: PV_123] Log message: \"unexpected error dispatching to ServiceAction\" // This log would not normally include the MDC context\n//wisp-logging/wisp.logging/TaggedLogger/TaggedLogger
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-tagged-logger/#taggedlogger","title":"TaggedLogger","text":"[jvm]\\ constructor(loggerClass: KClass<L>, tags: Set<Tag>)
constructor(kLogger: KLogger, tags: Set<Tag>)
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/as-context/","title":"asContext - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/asContext
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/as-context/#ascontext","title":"asContext","text":"[jvm]\\ fun <T> asContext(f: () -> T): T
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/tag/","title":"tag - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/tag
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/tag/#tag","title":"tag","text":"[jvm]\\ fun tag(vararg newTags: Tag): R
fun tag(newTags: Collection<Tag>): R
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/","title":"Companion - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/Companion
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/#functions","title":"Functions","text":"Name Summary popThreadLocalMdcContext [jvm]fun popThreadLocalMdcContext(): Set<Tag>"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/pop-thread-local-mdc-context/","title":"popThreadLocalMdcContext - Misk","text":"//wisp-logging/wisp.logging/TaggedLogger/Companion/popThreadLocalMdcContext
"},{"location":"0.x/wisp-logging/wisp-logging/wisp.logging/-tagged-logger/-companion/pop-thread-local-mdc-context/#popthreadlocalmdccontext","title":"popThreadLocalMdcContext","text":"[jvm]\\ fun popThreadLocalMdcContext(): Set<Tag>
"},{"location":"0.x/wisp-logging-testing/","title":"wisp-logging-testing - Misk","text":"//wisp-logging-testing
"},{"location":"0.x/wisp-logging-testing/#wisp-logging-testing","title":"wisp-logging-testing","text":""},{"location":"0.x/wisp-logging-testing/#packages","title":"Packages","text":"Name org.assertj.core.api wisp.logging"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/","title":"Package-level declarations - Misk","text":"//wisp-logging-testing/org.assertj.core.api
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/#functions","title":"Functions","text":"Name Summary assertOrdering [jvm]fun <A : Comparable<A>> assertOrdering(vararg values: A) containsExactly [jvm]inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE> isEqualToAsJson [jvm]fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/assert-ordering/","title":"assertOrdering - Misk","text":"//wisp-logging-testing/org.assertj.core.api/assertOrdering
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/assert-ordering/#assertordering","title":"assertOrdering","text":"[jvm]\\ fun <A : Comparable<A>> assertOrdering(vararg values: A)
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/contains-exactly/","title":"containsExactly - Misk","text":"//wisp-logging-testing/org.assertj.core.api/containsExactly
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/contains-exactly/#containsexactly","title":"containsExactly","text":"[jvm]\\ inline fun <KEY, VALUE> MapAssert<KEY, VALUE>.containsExactly(vararg p: Pair<KEY, VALUE>): MapAssert<KEY, VALUE>
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/is-equal-to-as-json/","title":"isEqualToAsJson - Misk","text":"//wisp-logging-testing/org.assertj.core.api/isEqualToAsJson
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/org.assertj.core.api/is-equal-to-as-json/#isequaltoasjson","title":"isEqualToAsJson","text":"[jvm]\\ fun <ACTUAL : CharSequence> AbstractCharSequenceAssert<, ACTUAL>.isEqualToAsJson(expected: CharSequence): AbstractCharSequenceAssert<, ACTUAL>
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/","title":"Package-level declarations - Misk","text":"//wisp-logging-testing/wisp.logging
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/#types","title":"Types","text":"Name Summary LogCollector [jvm]interface LogCollectorCollects log messages, so they may be asserted on for testing. WispQueuedLogCollector [jvm]class WispQueuedLogCollector : LogCollector"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/","title":"LogCollector - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/#logcollector","title":"LogCollector","text":"interface LogCollector
Collects log messages, so they may be asserted on for testing.
Use the optional parameters of takeMessages to constrain which log messages are returned.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/#inheritors","title":"Inheritors","text":"WispQueuedLogCollector"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/#functions","title":"Functions","text":"Name Summary takeEvent [jvm]abstract fun takeEvent(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): ILoggingEventWaits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.[jvm]abstract fun takeEvent(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): ILoggingEventTake the first matching event, optionally leaving unmatched logs in this collector. takeEvents [jvm]abstract fun takeEvents(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<ILoggingEvent>Removes all currently-collected log events and returns those that match the requested criteria.[jvm]abstract fun takeEvents(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<ILoggingEvent>Takes all matching events, optionally leaving unmatched logs in this collector. takeMessage [jvm]abstract fun takeMessage(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): StringWaits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.[jvm]abstract fun takeMessage(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): StringTakes the first matching message, optionally leaving unmatched logs in this collector. takeMessages [jvm]abstract fun takeMessages(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<String>Removes all currently-collected log messages and returns those that match the requested criteria.[jvm]abstract fun takeMessages(loggerClass: KClass<>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<String>Takes all matching messages, optionally leaving unmatched logs in this collector."},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-event/","title":"takeEvent - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeEvent
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-event/#takeevent","title":"takeEvent","text":"[jvm]\\ abstract fun takeEvent(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): ILoggingEvent
Waits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.
[jvm]\\ abstract fun takeEvent(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): ILoggingEvent
Take the first matching event, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-events/","title":"takeEvents - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeEvents
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-events/#takeevents","title":"takeEvents","text":"[jvm]\\ abstract fun takeEvents(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<ILoggingEvent>
Removes all currently-collected log events and returns those that match the requested criteria.
[jvm]\\ abstract fun takeEvents(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<ILoggingEvent>
Takes all matching events, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-message/","title":"takeMessage - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeMessage
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-message/#takemessage","title":"takeMessage","text":"[jvm]\\ abstract fun takeMessage(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): String
Waits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.
[jvm]\\ abstract fun takeMessage(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): String
Takes the first matching message, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-messages/","title":"takeMessages - Misk","text":"//wisp-logging-testing/wisp.logging/LogCollector/takeMessages
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-log-collector/take-messages/#takemessages","title":"takeMessages","text":"[jvm]\\ abstract fun takeMessages(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null): List<String>
Removes all currently-collected log messages and returns those that match the requested criteria.
[jvm]\\ abstract fun takeMessages(loggerClass: KClass<*>? = null, minLevel: Level = Level.INFO, pattern: Regex? = null, consumeUnmatchedLogs: Boolean = false): List<String>
Takes all matching messages, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/","title":"WispQueuedLogCollector - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/#wispqueuedlogcollector","title":"WispQueuedLogCollector","text":"[jvm]\\ class WispQueuedLogCollector : LogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/#constructors","title":"Constructors","text":"WispQueuedLogCollector [jvm]constructor()"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/#functions","title":"Functions","text":"Name Summary shutDown [jvm]fun shutDown() startUp [jvm]fun startUp() takeEvent [jvm]open override fun takeEvent(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): ILoggingEventWaits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.[jvm]open override fun takeEvent(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): ILoggingEventTake the first matching event, optionally leaving unmatched logs in this collector. takeEvents [jvm]open override fun takeEvents(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): List<ILoggingEvent>Removes all currently-collected log events and returns those that match the requested criteria.[jvm]open override fun takeEvents(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<ILoggingEvent>Takes all matching events, optionally leaving unmatched logs in this collector. takeMessage [jvm]open override fun takeMessage(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): StringWaits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.[jvm]open override fun takeMessage(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): StringTakes the first matching message, optionally leaving unmatched logs in this collector. takeMessages [jvm]open override fun takeMessages(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?): List<String>Removes all currently-collected log messages and returns those that match the requested criteria.[jvm]open override fun takeMessages(loggerClass: KClass<>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<String>Takes all matching messages, optionally leaving unmatched logs in this collector."},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/-wisp-queued-log-collector/","title":"WispQueuedLogCollector - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/WispQueuedLogCollector
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/-wisp-queued-log-collector/#wispqueuedlogcollector","title":"WispQueuedLogCollector","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/shut-down/","title":"shutDown - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/shutDown
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/start-up/","title":"startUp - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/startUp
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/start-up/#startup","title":"startUp","text":"[jvm]\\ fun startUp()
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-event/","title":"takeEvent - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeEvent
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-event/#takeevent","title":"takeEvent","text":"[jvm]\\ open override fun takeEvent(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): ILoggingEvent
Waits until a matching event is logged, and returns it. The returned event and all preceding events are also removed.
[jvm]\\ open override fun takeEvent(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): ILoggingEvent
Take the first matching event, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-events/","title":"takeEvents - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeEvents
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-events/#takeevents","title":"takeEvents","text":"[jvm]\\ open override fun takeEvents(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): List<ILoggingEvent>
Removes all currently-collected log events and returns those that match the requested criteria.
[jvm]\\ open override fun takeEvents(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<ILoggingEvent>
Takes all matching events, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-message/","title":"takeMessage - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeMessage
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-message/#takemessage","title":"takeMessage","text":"[jvm]\\ open override fun takeMessage(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): String
Waits until a matching event is logged, and returns its message. The returned event and all preceding events are also removed.
[jvm]\\ open override fun takeMessage(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): String
Takes the first matching message, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-messages/","title":"takeMessages - Misk","text":"//wisp-logging-testing/wisp.logging/WispQueuedLogCollector/takeMessages
"},{"location":"0.x/wisp-logging-testing/wisp-logging-testing/wisp.logging/-wisp-queued-log-collector/take-messages/#takemessages","title":"takeMessages","text":"[jvm]\\ open override fun takeMessages(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?): List<String>
Removes all currently-collected log messages and returns those that match the requested criteria.
[jvm]\\ open override fun takeMessages(loggerClass: KClass<*>?, minLevel: Level, pattern: Regex?, consumeUnmatchedLogs: Boolean): List<String>
Takes all matching messages, optionally leaving unmatched logs in this collector.
"},{"location":"0.x/wisp-moshi/","title":"wisp-moshi - Misk","text":"//wisp-moshi
"},{"location":"0.x/wisp-moshi/#wisp-moshi","title":"wisp-moshi","text":""},{"location":"0.x/wisp-moshi/#packages","title":"Packages","text":"Name wisp.moshi"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/","title":"Package-level declarations - Misk","text":"//wisp-moshi/wisp.moshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/#properties","title":"Properties","text":"Name Summary defaultKotlinMoshi [jvm]val defaultKotlinMoshi: MoshiDefault build for Moshi using the Kotlin JSON adapter"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/#functions","title":"Functions","text":"Name Summary adapter [jvm]inline fun <T> Moshi.adapter(): JsonAdapter<T> buildMoshi [jvm]@JvmOverloadsfun buildMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any> = emptyList()): Moshi"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/adapter/","title":"adapter - Misk","text":"//wisp-moshi/wisp.moshi/adapter
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/adapter/#adapter","title":"adapter","text":"[jvm]\\ inline fun <T> Moshi.adapter(): JsonAdapter<T>
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/build-moshi/","title":"buildMoshi - Misk","text":"//wisp-moshi/wisp.moshi/buildMoshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/build-moshi/#buildmoshi","title":"buildMoshi","text":"[jvm]\\
@JvmOverloads
fun buildMoshi(jsonAdapters: List<Any>, jsonLastAdapters: List<Any> = emptyList()): Moshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/default-kotlin-moshi/","title":"defaultKotlinMoshi - Misk","text":"//wisp-moshi/wisp.moshi/defaultKotlinMoshi
"},{"location":"0.x/wisp-moshi/wisp-moshi/wisp.moshi/default-kotlin-moshi/#defaultkotlinmoshi","title":"defaultKotlinMoshi","text":"[jvm]\\ val defaultKotlinMoshi: Moshi
Default build for Moshi using the Kotlin JSON adapter
"},{"location":"0.x/wisp-rate-limiting/","title":"wisp-rate-limiting - Misk","text":"//wisp-rate-limiting
"},{"location":"0.x/wisp-rate-limiting/#wisp-rate-limiting","title":"wisp-rate-limiting","text":""},{"location":"0.x/wisp-rate-limiting/#packages","title":"Packages","text":"Name wisp.ratelimiting"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/","title":"Package-level declarations - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/#types","title":"Types","text":"Name Summary RateLimitConfiguration [jvm]interface RateLimitConfigurationThe rate limit configuration applied to a rate limit bucket RateLimiter [jvm]interface RateLimiterAn interface for acquiring and releasing rate limit tokens RateLimiterMetrics [jvm]class RateLimiterMetrics(meterRegistry: MeterRegistry) RateLimitPruner [jvm]interface RateLimitPrunerA standard interface for pruning expired rate limits RateLimitPrunerMetrics [jvm]class RateLimitPrunerMetrics(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/","title":"RateLimitConfiguration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/#ratelimitconfiguration","title":"RateLimitConfiguration","text":"[jvm]\\ interface RateLimitConfiguration
The rate limit configuration applied to a rate limit bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/#properties","title":"Properties","text":"Name Summary capacity [jvm]abstract val capacity: LongThe maximum number of tokens that can accumulate in the bucket name [jvm]abstract val name: StringA name identifying the configuration, e.g. \"OriginationFileProcessing\" for a rate limit configuration governing the rate at which origination files can be processed refillAmount [jvm]abstract val refillAmount: LongThe amount of tokens added back to the limit bucket every refillPeriod refillPeriod [jvm]abstract val refillPeriod: DurationThe period of time over which refillAmount tokens are added back to the bucket"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/capacity/","title":"capacity - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/capacity
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/capacity/#capacity","title":"capacity","text":"[jvm]\\ abstract val capacity: Long
The maximum number of tokens that can accumulate in the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/name/","title":"name - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/name
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/name/#name","title":"name","text":"[jvm]\\ abstract val name: String
A name identifying the configuration, e.g. \"OriginationFileProcessing\" for a rate limit configuration governing the rate at which origination files can be processed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-amount/","title":"refillAmount - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/refillAmount
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-amount/#refillamount","title":"refillAmount","text":"[jvm]\\ abstract val refillAmount: Long
The amount of tokens added back to the limit bucket every refillPeriod
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-period/","title":"refillPeriod - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitConfiguration/refillPeriod
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-configuration/refill-period/#refillperiod","title":"refillPeriod","text":"[jvm]\\ abstract val refillPeriod: Duration
The period of time over which refillAmount tokens are added back to the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/","title":"RateLimitPruner - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPruner
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/#ratelimitpruner","title":"RateLimitPruner","text":"[jvm]\\ interface RateLimitPruner
A standard interface for pruning expired rate limits
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/#functions","title":"Functions","text":"Name Summary prune [jvm]abstract fun prune()"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/prune/","title":"prune - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPruner/prune
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner/prune/#prune","title":"prune","text":"[jvm]\\ abstract fun prune()
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/","title":"RateLimitPrunerMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#ratelimitprunermetrics","title":"RateLimitPrunerMetrics","text":"[jvm]\\ class RateLimitPrunerMetrics(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#constructors","title":"Constructors","text":"RateLimitPrunerMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/#properties","title":"Properties","text":"Name Summary bucketsPruned [jvm]val bucketsPruned: Counter pruningDuration [jvm]val pruningDuration: DistributionSummary"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-rate-limit-pruner-metrics/","title":"RateLimitPrunerMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/RateLimitPrunerMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-rate-limit-pruner-metrics/#ratelimitprunermetrics","title":"RateLimitPrunerMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/buckets-pruned/","title":"bucketsPruned - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/bucketsPruned
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/buckets-pruned/#bucketspruned","title":"bucketsPruned","text":"[jvm]\\ val bucketsPruned: Counter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/pruning-duration/","title":"pruningDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/pruningDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/pruning-duration/#pruningduration","title":"pruningDuration","text":"[jvm]\\ val pruningDuration: DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/","title":"Companion - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/#properties","title":"Properties","text":"Name Summary PRUNED_BUCKETS_COUNTER_NAME [jvm]const val PRUNED_BUCKETS_COUNTER_NAME: String PRUNING_DURATION [jvm]const val PRUNING_DURATION: String"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-e-d_-b-u-c-k-e-t-s_-c-o-u-n-t-e-r_-n-a-m-e/","title":"PRUNED_BUCKETS_COUNTER_NAME - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/Companion/PRUNED_BUCKETS_COUNTER_NAME
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-e-d_-b-u-c-k-e-t-s_-c-o-u-n-t-e-r_-n-a-m-e/#pruned_buckets_counter_name","title":"PRUNED_BUCKETS_COUNTER_NAME","text":"[jvm]\\ const val PRUNED_BUCKETS_COUNTER_NAME: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-i-n-g_-d-u-r-a-t-i-o-n/","title":"PRUNING_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimitPrunerMetrics/Companion/PRUNING_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limit-pruner-metrics/-companion/-p-r-u-n-i-n-g_-d-u-r-a-t-i-o-n/#pruning_duration","title":"PRUNING_DURATION","text":"[jvm]\\ const val PRUNING_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/","title":"RateLimiter - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\ interface RateLimiter
An interface for acquiring and releasing rate limit tokens
Terms:
key - a unique identifier for the entity or operation being rate limitedbucket - a container for rate limit tokens applied to a specific keytoken - a unit of rate limit capacity. When we go to perform a rate limited operation, we attempt to consume a token from the bucket. If successful, we can perform the operation.See also: https://en.wikipedia.org/wiki/Token_bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/#types","title":"Types","text":"Name Summary ConsumptionData [jvm]data class ConsumptionData(val didConsume: Boolean, val remaining: Long, val resetTime: Instant) ExecutionResult [jvm]data class ExecutionResult<T>(val result: T?, val consumptionData: RateLimiter.ConsumptionData) TestConsumptionResult [jvm]data class TestConsumptionResult(val couldHaveConsumed: Boolean, val remaining: Long, val resetTime: Instant)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/#functions","title":"Functions","text":"Name Summary availableTokens [jvm]abstract fun availableTokens(key: String, configuration: RateLimitConfiguration): LongReturns how many tokens remain in the bucket. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime. consumeToken [jvm]abstract fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.ConsumptionDataConsumes amount tokens from the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation. releaseToken [jvm]abstract fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1)Releases amount tokens back to the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation. resetBucket [jvm]abstract fun resetBucket(key: String, configuration: RateLimitConfiguration)Resets the bucket back to its maximum capacity testConsumptionAttempt [jvm]abstract fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.TestConsumptionResultThis tests whether amount tokens are available in the bucket associated with the given key. It is essentially a dry run of consumeToken. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime. withToken [jvm]open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>Executes the given function if a token is available This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/available-tokens/","title":"availableTokens - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/availableTokens
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/available-tokens/#availabletokens","title":"availableTokens","text":"[jvm]\\ abstract fun availableTokens(key: String, configuration: RateLimitConfiguration): Long
Returns how many tokens remain in the bucket. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/consume-token/","title":"consumeToken - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/consumeToken
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/consume-token/#consumetoken","title":"consumeToken","text":"[jvm]\\ abstract fun consumeToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.ConsumptionData
Consumes amount tokens from the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/release-token/","title":"releaseToken - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/releaseToken
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/release-token/#releasetoken","title":"releaseToken","text":"[jvm]\\ abstract fun releaseToken(key: String, configuration: RateLimitConfiguration, amount: Long = 1)
Releases amount tokens back to the bucket associated with the given key This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/reset-bucket/","title":"resetBucket - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/resetBucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/reset-bucket/#resetbucket","title":"resetBucket","text":"[jvm]\\ abstract fun resetBucket(key: String, configuration: RateLimitConfiguration)
Resets the bucket back to its maximum capacity
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/test-consumption-attempt/","title":"testConsumptionAttempt - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/testConsumptionAttempt
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/test-consumption-attempt/#testconsumptionattempt","title":"testConsumptionAttempt","text":"[jvm]\\ abstract fun testConsumptionAttempt(key: String, configuration: RateLimitConfiguration, amount: Long = 1): RateLimiter.TestConsumptionResult
This tests whether amount tokens are available in the bucket associated with the given key. It is essentially a dry run of consumeToken. Note that this data may be stale when it comes back, as time has elapsed and other pods could have taken tokens in the meantime.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/with-token/","title":"withToken - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/withToken
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/with-token/#withtoken","title":"withToken","text":"[jvm]\\ open fun <T> withToken(key: String, configuration: RateLimitConfiguration, f: () -> T): RateLimiter.ExecutionResult<T>
Executes the given function if a token is available This will raise any exception thrown by the bucket4j proxy manager implementation, e.g. subclasses of JedisException when using the Jedis implementation.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/","title":"ConsumptionData - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/#consumptiondata","title":"ConsumptionData","text":"[jvm]\\ data class ConsumptionData(val didConsume: Boolean, val remaining: Long, val resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/#constructors","title":"Constructors","text":"ConsumptionData [jvm]constructor(didConsume: Boolean, remaining: Long, resetTime: Instant)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/#properties","title":"Properties","text":"Name Summary didConsume [jvm]val didConsume: BooleanWhether a token was consumed remaining [jvm]val remaining: LongCount of tokens remaining in the bucket resetTime [jvm]val resetTime: InstantThe time at which the bucket will be reset."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/-consumption-data/","title":"ConsumptionData - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/ConsumptionData
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/-consumption-data/#consumptiondata","title":"ConsumptionData","text":"[jvm]\\ constructor(didConsume: Boolean, remaining: Long, resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/did-consume/","title":"didConsume - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/didConsume
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/did-consume/#didconsume","title":"didConsume","text":"[jvm]\\ val didConsume: Boolean
Whether a token was consumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/remaining/","title":"remaining - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/remaining
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/remaining/#remaining","title":"remaining","text":"[jvm]\\ val remaining: Long
Count of tokens remaining in the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/reset-time/","title":"resetTime - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ConsumptionData/resetTime
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-consumption-data/reset-time/#resettime","title":"resetTime","text":"[jvm]\\ val resetTime: Instant
The time at which the bucket will be reset.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/","title":"ExecutionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/#executionresult","title":"ExecutionResult","text":"[jvm]\\ data class ExecutionResult<T>(val result: T?, val consumptionData: RateLimiter.ConsumptionData)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/#constructors","title":"Constructors","text":"ExecutionResult [jvm]constructor(result: T?, consumptionData: RateLimiter.ConsumptionData)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/#properties","title":"Properties","text":"Name Summary consumptionData [jvm]val consumptionData: RateLimiter.ConsumptionDatatrue if a token was consumed, false otherwise result [jvm]val result: T?The result of the execution if a token was consumed, null otherwise"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/-execution-result/","title":"ExecutionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult/ExecutionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/-execution-result/#executionresult","title":"ExecutionResult","text":"[jvm]\\ constructor(result: T?, consumptionData: RateLimiter.ConsumptionData)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/consumption-data/","title":"consumptionData - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult/consumptionData
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/consumption-data/#consumptiondata","title":"consumptionData","text":"[jvm]\\ val consumptionData: RateLimiter.ConsumptionData
true if a token was consumed, false otherwise
//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/ExecutionResult/result
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-execution-result/result/#result","title":"result","text":"[jvm]\\ val result: T?
The result of the execution if a token was consumed, null otherwise
//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/#testconsumptionresult","title":"TestConsumptionResult","text":"[jvm]\\ data class TestConsumptionResult(val couldHaveConsumed: Boolean, val remaining: Long, val resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/#constructors","title":"Constructors","text":"TestConsumptionResult [jvm]constructor(couldHaveConsumed: Boolean, remaining: Long, resetTime: Instant)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/#properties","title":"Properties","text":"Name Summary couldHaveConsumed [jvm]val couldHaveConsumed: BooleanWhether a token could have been consumed remaining [jvm]val remaining: LongCount of tokens remaining in the bucket Note - this is the actual amount remaining, not the amount that would be remaining if the test consumption had been a real consumption resetTime [jvm]val resetTime: InstantThe time at which the bucket will be reset."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/-test-consumption-result/","title":"TestConsumptionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/TestConsumptionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/-test-consumption-result/#testconsumptionresult","title":"TestConsumptionResult","text":"[jvm]\\ constructor(couldHaveConsumed: Boolean, remaining: Long, resetTime: Instant)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/could-have-consumed/","title":"couldHaveConsumed - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/couldHaveConsumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/could-have-consumed/#couldhaveconsumed","title":"couldHaveConsumed","text":"[jvm]\\ val couldHaveConsumed: Boolean
Whether a token could have been consumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/remaining/","title":"remaining - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/remaining
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/remaining/#remaining","title":"remaining","text":"[jvm]\\ val remaining: Long
Count of tokens remaining in the bucket Note - this is the actual amount remaining, not the amount that would be remaining if the test consumption had been a real consumption
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/reset-time/","title":"resetTime - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiter/TestConsumptionResult/resetTime
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter/-test-consumption-result/reset-time/#resettime","title":"resetTime","text":"[jvm]\\ val resetTime: Instant
The time at which the bucket will be reset.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/","title":"RateLimiterMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#ratelimitermetrics","title":"RateLimiterMetrics","text":"[jvm]\\ class RateLimiterMetrics(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#constructors","title":"Constructors","text":"RateLimiterMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion ConsumptionResult [jvm]enum ConsumptionResult : Enum<RateLimiterMetrics.ConsumptionResult>"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/#functions","title":"Functions","text":"Name Summary consumptionAttempts [jvm]fun consumptionAttempts(configuration: RateLimitConfiguration, consumptionResult: RateLimiterMetrics.ConsumptionResult): Counter limitAvailabilityDuration [jvm]fun limitAvailabilityDuration(configuration: RateLimitConfiguration): DistributionSummary limitConsumptionDuration [jvm]fun limitConsumptionDuration(configuration: RateLimitConfiguration): DistributionSummary limitReleaseDuration [jvm]fun limitReleaseDuration(configuration: RateLimitConfiguration): DistributionSummary limitResetDuration [jvm]fun limitResetDuration(configuration: RateLimitConfiguration): DistributionSummary limitTestDuration [jvm]fun limitTestDuration(configuration: RateLimitConfiguration): DistributionSummary tokensConsumed [jvm]fun tokensConsumed(configuration: RateLimitConfiguration): Counter"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-rate-limiter-metrics/","title":"RateLimiterMetrics - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/RateLimiterMetrics
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-rate-limiter-metrics/#ratelimitermetrics","title":"RateLimiterMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/consumption-attempts/","title":"consumptionAttempts - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/consumptionAttempts
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/consumption-attempts/#consumptionattempts","title":"consumptionAttempts","text":"[jvm]\\ fun consumptionAttempts(configuration: RateLimitConfiguration, consumptionResult: RateLimiterMetrics.ConsumptionResult): Counter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-availability-duration/","title":"limitAvailabilityDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitAvailabilityDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-availability-duration/#limitavailabilityduration","title":"limitAvailabilityDuration","text":"[jvm]\\ fun limitAvailabilityDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-consumption-duration/","title":"limitConsumptionDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitConsumptionDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-consumption-duration/#limitconsumptionduration","title":"limitConsumptionDuration","text":"[jvm]\\ fun limitConsumptionDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-release-duration/","title":"limitReleaseDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitReleaseDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-release-duration/#limitreleaseduration","title":"limitReleaseDuration","text":"[jvm]\\ fun limitReleaseDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-reset-duration/","title":"limitResetDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitResetDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-reset-duration/#limitresetduration","title":"limitResetDuration","text":"[jvm]\\ fun limitResetDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-test-duration/","title":"limitTestDuration - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/limitTestDuration
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/limit-test-duration/#limittestduration","title":"limitTestDuration","text":"[jvm]\\ fun limitTestDuration(configuration: RateLimitConfiguration): DistributionSummary
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/tokens-consumed/","title":"tokensConsumed - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/tokensConsumed
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/tokens-consumed/#tokensconsumed","title":"tokensConsumed","text":"[jvm]\\ fun tokensConsumed(configuration: RateLimitConfiguration): Counter
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/","title":"Companion - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/#properties","title":"Properties","text":"Name Summary ATTEMPT_COUNTER_NAME [jvm]const val ATTEMPT_COUNTER_NAME: String LIMIT_AVAILABILITY_DURATION [jvm]const val LIMIT_AVAILABILITY_DURATION: String LIMIT_CONSUMPTION_DURATION [jvm]const val LIMIT_CONSUMPTION_DURATION: String LIMIT_RELEASE_DURATION [jvm]const val LIMIT_RELEASE_DURATION: String LIMIT_RESET_DURATION [jvm]const val LIMIT_RESET_DURATION: String LIMIT_TEST_DURATION [jvm]const val LIMIT_TEST_DURATION: String RATE_LIMIT_TAG [jvm]const val RATE_LIMIT_TAG: String RESULT_TAG [jvm]const val RESULT_TAG: String TOTAL_CONSUMED_COUNTER_NAME [jvm]const val TOTAL_CONSUMED_COUNTER_NAME: String"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-a-t-t-e-m-p-t_-c-o-u-n-t-e-r_-n-a-m-e/","title":"ATTEMPT_COUNTER_NAME - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/ATTEMPT_COUNTER_NAME
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-a-t-t-e-m-p-t_-c-o-u-n-t-e-r_-n-a-m-e/#attempt_counter_name","title":"ATTEMPT_COUNTER_NAME","text":"[jvm]\\ const val ATTEMPT_COUNTER_NAME: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-a-v-a-i-l-a-b-i-l-i-t-y_-d-u-r-a-t-i-o-n/","title":"LIMIT_AVAILABILITY_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_AVAILABILITY_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-a-v-a-i-l-a-b-i-l-i-t-y_-d-u-r-a-t-i-o-n/#limit_availability_duration","title":"LIMIT_AVAILABILITY_DURATION","text":"[jvm]\\ const val LIMIT_AVAILABILITY_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-c-o-n-s-u-m-p-t-i-o-n_-d-u-r-a-t-i-o-n/","title":"LIMIT_CONSUMPTION_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_CONSUMPTION_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-c-o-n-s-u-m-p-t-i-o-n_-d-u-r-a-t-i-o-n/#limit_consumption_duration","title":"LIMIT_CONSUMPTION_DURATION","text":"[jvm]\\ const val LIMIT_CONSUMPTION_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-l-e-a-s-e_-d-u-r-a-t-i-o-n/","title":"LIMIT_RELEASE_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_RELEASE_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-l-e-a-s-e_-d-u-r-a-t-i-o-n/#limit_release_duration","title":"LIMIT_RELEASE_DURATION","text":"[jvm]\\ const val LIMIT_RELEASE_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-s-e-t_-d-u-r-a-t-i-o-n/","title":"LIMIT_RESET_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_RESET_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-r-e-s-e-t_-d-u-r-a-t-i-o-n/#limit_reset_duration","title":"LIMIT_RESET_DURATION","text":"[jvm]\\ const val LIMIT_RESET_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-t-e-s-t_-d-u-r-a-t-i-o-n/","title":"LIMIT_TEST_DURATION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/LIMIT_TEST_DURATION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-l-i-m-i-t_-t-e-s-t_-d-u-r-a-t-i-o-n/#limit_test_duration","title":"LIMIT_TEST_DURATION","text":"[jvm]\\ const val LIMIT_TEST_DURATION: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-a-t-e_-l-i-m-i-t_-t-a-g/","title":"RATE_LIMIT_TAG - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/RATE_LIMIT_TAG
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-a-t-e_-l-i-m-i-t_-t-a-g/#rate_limit_tag","title":"RATE_LIMIT_TAG","text":"[jvm]\\ const val RATE_LIMIT_TAG: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-e-s-u-l-t_-t-a-g/","title":"RESULT_TAG - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/RESULT_TAG
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-r-e-s-u-l-t_-t-a-g/#result_tag","title":"RESULT_TAG","text":"[jvm]\\ const val RESULT_TAG: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-t-o-t-a-l_-c-o-n-s-u-m-e-d_-c-o-u-n-t-e-r_-n-a-m-e/","title":"TOTAL_CONSUMED_COUNTER_NAME - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/Companion/TOTAL_CONSUMED_COUNTER_NAME
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-companion/-t-o-t-a-l_-c-o-n-s-u-m-e-d_-c-o-u-n-t-e-r_-n-a-m-e/#total_consumed_counter_name","title":"TOTAL_CONSUMED_COUNTER_NAME","text":"[jvm]\\ const val TOTAL_CONSUMED_COUNTER_NAME: String
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/","title":"ConsumptionResult - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#consumptionresult","title":"ConsumptionResult","text":"[jvm]\\ enum ConsumptionResult : Enum<RateLimiterMetrics.ConsumptionResult>
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#entries","title":"Entries","text":"SUCCESS [jvm]SUCCESSA token was consumed successfully REJECTED [jvm]REJECTEDThere were insufficient tokens in the bucket EXCEPTION [jvm]EXCEPTIONAn exception was thrown while attempting to consume a token"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<RateLimiterMetrics.ConsumptionResult>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/#functions","title":"Functions","text":"Name Summary valueOf [jvm]fun valueOf(value: String): RateLimiterMetrics.ConsumptionResultReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<RateLimiterMetrics.ConsumptionResult>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/entries/","title":"entries - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/entries
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<RateLimiterMetrics.ConsumptionResult>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/value-of/","title":"valueOf - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/valueOf
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): RateLimiterMetrics.ConsumptionResult
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/values/","title":"values - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/values
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<RateLimiterMetrics.ConsumptionResult>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-e-x-c-e-p-t-i-o-n/","title":"EXCEPTION - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/EXCEPTION
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-e-x-c-e-p-t-i-o-n/#exception","title":"EXCEPTION","text":"[jvm]\\ EXCEPTION
An exception was thrown while attempting to consume a token
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-e-x-c-e-p-t-i-o-n/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-r-e-j-e-c-t-e-d/","title":"REJECTED - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/REJECTED
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-r-e-j-e-c-t-e-d/#rejected","title":"REJECTED","text":"[jvm]\\ REJECTED
There were insufficient tokens in the bucket
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-r-e-j-e-c-t-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-s-u-c-c-e-s-s/","title":"SUCCESS - Misk","text":"//wisp-rate-limiting/wisp.ratelimiting/RateLimiterMetrics/ConsumptionResult/SUCCESS
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-s-u-c-c-e-s-s/#success","title":"SUCCESS","text":"[jvm]\\ SUCCESS
A token was consumed successfully
"},{"location":"0.x/wisp-rate-limiting/wisp-rate-limiting/wisp.ratelimiting/-rate-limiter-metrics/-consumption-result/-s-u-c-c-e-s-s/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-resource-loader/","title":"wisp-resource-loader - Misk","text":"//wisp-resource-loader
"},{"location":"0.x/wisp-resource-loader/#wisp-resource-loader","title":"wisp-resource-loader","text":""},{"location":"0.x/wisp-resource-loader/#packages","title":"Packages","text":"Name wisp.resources"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/","title":"Package-level declarations - Misk","text":"//wisp-resource-loader/wisp.resources
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/#types","title":"Types","text":"Name Summary ClasspathResourceLoaderBackend [jvm]object ClasspathResourceLoaderBackend : ResourceLoader.BackendRead-only resources that are fetched from either the deployed .jar file or the local filesystem. EnvironmentResourceLoaderBackend [jvm]object EnvironmentResourceLoaderBackend : ResourceLoader.BackendRead-only resources that are fetched from environment variables. FilesystemLoaderBackend [jvm]object FilesystemLoaderBackend : ResourceLoader.BackendRead-only resources that are fetched from the local filesystem using absolute paths. MemoryResourceLoaderBackend [jvm]class MemoryResourceLoaderBackend : ResourceLoader.BackendRead-write resources stored only in memory. Most useful for testing. It is possible to have multiple instances of this backend. ResourceLoader [jvm]open class ResourceLoader(backends: Map<String, ResourceLoader.Backend>)ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source."},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/","title":"ClasspathResourceLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/#classpathresourceloaderbackend","title":"ClasspathResourceLoaderBackend","text":"[jvm]\\ object ClasspathResourceLoaderBackend : ResourceLoader.Backend
Read-only resources that are fetched from either the deployed .jar file or the local filesystem.
This uses the scheme classpath:.
//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/list/#list","title":"list","text":"[jvm]\\ open override fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/ClasspathResourceLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-classpath-resource-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/","title":"EnvironmentResourceLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/#environmentresourceloaderbackend","title":"EnvironmentResourceLoaderBackend","text":"[jvm]\\ object EnvironmentResourceLoaderBackend : ResourceLoader.Backend
Read-only resources that are fetched from environment variables.
This uses the scheme environment:.
//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/check-path/","title":"checkPath - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/checkPath
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/check-path/#checkpath","title":"checkPath","text":"[jvm]\\ open override fun checkPath(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/list/#list","title":"list","text":"[jvm]\\ open override fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/EnvironmentResourceLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-environment-resource-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/","title":"FilesystemLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/#filesystemloaderbackend","title":"FilesystemLoaderBackend","text":"[jvm]\\ object FilesystemLoaderBackend : ResourceLoader.Backend
Read-only resources that are fetched from the local filesystem using absolute paths.
This uses the scheme filesystem:.
//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/list/#list","title":"list","text":"[jvm]\\ open override fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open override fun unwatch(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/FilesystemLoaderBackend/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-filesystem-loader-backend/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(path: String, resourceChangedListener: (address: String) -> Unit)
For changes to the file that have been done externally, since this is a read-only ResourceLoader.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/","title":"MemoryResourceLoaderBackend - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/#memoryresourceloaderbackend","title":"MemoryResourceLoaderBackend","text":"[jvm]\\ class MemoryResourceLoaderBackend : ResourceLoader.Backend
Read-write resources stored only in memory. Most useful for testing. It is possible to have multiple instances of this backend.
This uses the scheme memory:.
//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/MemoryResourceLoaderBackend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-memory-resource-loader-backend/#memoryresourceloaderbackend","title":"MemoryResourceLoaderBackend","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/all/","title":"all - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/all
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/all/#all","title":"all","text":"[jvm]\\ open override fun all(): Set<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/put/","title":"put - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/put
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/put/#put","title":"put","text":"[jvm]\\ open override fun put(path: String, data: ByteString)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/resource-changed/","title":"resourceChanged - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/resourceChanged
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/resource-changed/#resourcechanged","title":"resourceChanged","text":"[jvm]\\ fun resourceChanged(scheme: String, path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open override fun unwatch(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/watch/#watch","title":"watch","text":"[jvm]\\ open override fun watch(path: String, resourceChangedListener: (address: String) -> Unit)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/","title":"Companion - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/#properties","title":"Properties","text":"Name Summary SCHEME [jvm]const val SCHEME: String"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/-s-c-h-e-m-e/","title":"SCHEME - Misk","text":"//wisp-resource-loader/wisp.resources/MemoryResourceLoaderBackend/Companion/SCHEME
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-memory-resource-loader-backend/-companion/-s-c-h-e-m-e/#scheme","title":"SCHEME","text":"[jvm]\\ const val SCHEME: String
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/","title":"ResourceLoader - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\ open class ResourceLoader(backends: Map<String, ResourceLoader.Backend>)
ResourceLoader is a testable API for loading resources from the classpath, from the filesystem, from memory, or from another Backend source.
Resource addresses have a scheme name, a colon, and an absolute filesystem-like path: classpath:/migrations/v1.sql. Schemes identify backends classpath: or memory:. Paths start with a slash and have any number of segments.
Classpath resources use the scheme classpath:. The backend reads data from the src/main/resources of the project\u2019s modules and the contents of all library .jar files. Classpath resources are read-only.
Filesystem resources use the scheme filesystem:. The backend reads data from the host machine\u2019s local filesystem. It is read-only and does not support list.
Memory resources use the scheme memory:. The backend starts empty and is populated by calls to put.
Other backends are permitted. They should be registered with a MapBinder with the backend scheme like classpath: as the key.
address as bytes, or null if no such resource exists. Note that this method reads the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently. copyTo [jvm]fun copyTo(root: String, dir: Path)Copies all resources with root as a prefix to the directory dir. exists [jvm]fun exists(address: String): BooleanReturns true if a resource at address exists. list [jvm]fun list(address: String): List<String>Returns the full path of the resources that are immediate children of address. open [jvm]fun open(address: String): BufferedSource?Return a buffered source for address, or null if no such resource exists. put [jvm]fun put(address: String, utf8: String)Writes a resource as UTF-8. Throws if the backend is readonly.[jvm]fun put(address: String, data: ByteString)Writes a resource. Throws if the backend is readonly. requireBytes [jvm]fun requireBytes(address: String): ByteStringLike bytes, but throws IllegalStateException if the resource is missing. requireUtf8 [jvm]fun requireUtf8(address: String): StringLike utf8, but throws IllegalStateException if the resource is missing. unwatch [jvm]fun unwatch(address: String) utf8 [jvm]fun utf8(address: String): String?Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently. walk [jvm]fun walk(address: String): List<String> watch [jvm]fun watch(address: String, resourceChangedListener: (address: String) -> Unit)"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-resource-loader/","title":"ResourceLoader - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/ResourceLoader
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-resource-loader/#resourceloader","title":"ResourceLoader","text":"[jvm]\\ constructor(backends: Map<String, ResourceLoader.Backend>)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/bytes/","title":"bytes - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/bytes
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/bytes/#bytes","title":"bytes","text":"[jvm]\\ fun bytes(address: String): ByteString?
Return the contents of address as bytes, or null if no such resource exists. Note that this method reads the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently.
//wisp-resource-loader/wisp.resources/ResourceLoader/copyTo
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/copy-to/#copyto","title":"copyTo","text":"[jvm]\\ fun copyTo(root: String, dir: Path)
Copies all resources with root as a prefix to the directory dir.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/exists/#exists","title":"exists","text":"[jvm]\\ fun exists(address: String): Boolean
Returns true if a resource at address exists.
//wisp-resource-loader/wisp.resources/ResourceLoader/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/list/#list","title":"list","text":"[jvm]\\ fun list(address: String): List<String>
Returns the full path of the resources that are immediate children of address.
//wisp-resource-loader/wisp.resources/ResourceLoader/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/open/#open","title":"open","text":"[jvm]\\ fun open(address: String): BufferedSource?
Return a buffered source for address, or null if no such resource exists.
//wisp-resource-loader/wisp.resources/ResourceLoader/put
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/put/#put","title":"put","text":"[jvm]\\ fun put(address: String, utf8: String)
Writes a resource as UTF-8. Throws if the backend is readonly.
[jvm]\\ fun put(address: String, data: ByteString)
Writes a resource. Throws if the backend is readonly.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-bytes/","title":"requireBytes - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/requireBytes
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-bytes/#requirebytes","title":"requireBytes","text":"[jvm]\\ fun requireBytes(address: String): ByteString
Like bytes, but throws IllegalStateException if the resource is missing.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-utf8/","title":"requireUtf8 - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/requireUtf8
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/require-utf8/#requireutf8","title":"requireUtf8","text":"[jvm]\\ fun requireUtf8(address: String): String
Like utf8, but throws IllegalStateException if the resource is missing.
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ fun unwatch(address: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/utf8/","title":"utf8 - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/utf8
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/utf8/#utf8","title":"utf8","text":"[jvm]\\ fun utf8(address: String): String?
Return the contents of address as a string, or null if no such resource exists. Note that this method decodes the resource on every use. It is the caller\u2019s responsibility to cache the result if it is to be loaded frequently.
//wisp-resource-loader/wisp.resources/ResourceLoader/walk
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/walk/#walk","title":"walk","text":"[jvm]\\ fun walk(address: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/watch/#watch","title":"watch","text":"[jvm]\\ fun watch(address: String, resourceChangedListener: (address: String) -> Unit)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/","title":"Backend - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#backend","title":"Backend","text":"abstract class Backend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#inheritors","title":"Inheritors","text":"ClasspathResourceLoaderBackend EnvironmentResourceLoaderBackend FilesystemLoaderBackend MemoryResourceLoaderBackend"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#constructors","title":"Constructors","text":"Backend [jvm]constructor()"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/#functions","title":"Functions","text":"Name Summary all [jvm]open fun all(): Set<String> checkPath [jvm]open fun checkPath(path: String) exists [jvm]abstract fun exists(path: String): Boolean list [jvm]open fun list(path: String): List<String> open [jvm]abstract fun open(path: String): BufferedSource? put [jvm]open fun put(path: String, data: ByteString) unwatch [jvm]open fun unwatch(path: String) watch [jvm]open fun watch(path: String, resourceChangedListener: (address: String) -> Unit)"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/-backend/","title":"Backend - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/Backend
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/-backend/#backend","title":"Backend","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/all/","title":"all - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/all
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/all/#all","title":"all","text":"[jvm]\\ open fun all(): Set<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/check-path/","title":"checkPath - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/checkPath
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/check-path/#checkpath","title":"checkPath","text":"[jvm]\\ open fun checkPath(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/exists
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/exists/#exists","title":"exists","text":"[jvm]\\ abstract fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/list/","title":"list - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/list
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/list/#list","title":"list","text":"[jvm]\\ open fun list(path: String): List<String>
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/open/","title":"open - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/open
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/open/#open","title":"open","text":"[jvm]\\ abstract fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/put/","title":"put - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/put
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/put/#put","title":"put","text":"[jvm]\\ open fun put(path: String, data: ByteString)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/unwatch/","title":"unwatch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/unwatch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/unwatch/#unwatch","title":"unwatch","text":"[jvm]\\ open fun unwatch(path: String)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/watch/","title":"watch - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Backend/watch
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-backend/watch/#watch","title":"watch","text":"[jvm]\\ open fun watch(path: String, resourceChangedListener: (address: String) -> Unit)
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/","title":"Companion - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/#properties","title":"Properties","text":"Name Summary SYSTEM [jvm]val SYSTEM: ResourceLoader"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/-s-y-s-t-e-m/","title":"SYSTEM - Misk","text":"//wisp-resource-loader/wisp.resources/ResourceLoader/Companion/SYSTEM
"},{"location":"0.x/wisp-resource-loader/wisp-resource-loader/wisp.resources/-resource-loader/-companion/-s-y-s-t-e-m/#system","title":"SYSTEM","text":"[jvm]\\ val SYSTEM: ResourceLoader
"},{"location":"0.x/wisp-resource-loader-testing/","title":"wisp-resource-loader-testing - Misk","text":"//wisp-resource-loader-testing
"},{"location":"0.x/wisp-resource-loader-testing/#wisp-resource-loader-testing","title":"wisp-resource-loader-testing","text":""},{"location":"0.x/wisp-resource-loader-testing/#packages","title":"Packages","text":"Name wisp.resources"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/","title":"Package-level declarations - Misk","text":"//wisp-resource-loader-testing/wisp.resources
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/#types","title":"Types","text":"Name Summary FakeFilesystemLoaderBackend [jvm]class FakeFilesystemLoaderBackend(files: Map<String, String>) : ResourceLoader.BackendA fake FilesystemLoaderBackend that loads file contents from an in-memory map. The map can be populated by adding to the ForFakeFiles map."},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/","title":"FakeFilesystemLoaderBackend - Misk","text":"//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/#fakefilesystemloaderbackend","title":"FakeFilesystemLoaderBackend","text":"[jvm]\\ class FakeFilesystemLoaderBackend(files: Map<String, String>) : ResourceLoader.Backend
A fake FilesystemLoaderBackend that loads file contents from an in-memory map. The map can be populated by adding to the ForFakeFiles map.
newMapBinder<String, String>(ForFakeFiles::class).addBinding(\"/etc/foo.txt\").toInstance(\"hello!\")\n//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend/FakeFilesystemLoaderBackend
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/-fake-filesystem-loader-backend/#fakefilesystemloaderbackend","title":"FakeFilesystemLoaderBackend","text":"[jvm]\\ constructor(files: Map<String, String>)
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/exists/","title":"exists - Misk","text":"//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend/exists
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/exists/#exists","title":"exists","text":"[jvm]\\ open override fun exists(path: String): Boolean
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/open/","title":"open - Misk","text":"//wisp-resource-loader-testing/wisp.resources/FakeFilesystemLoaderBackend/open
"},{"location":"0.x/wisp-resource-loader-testing/wisp-resource-loader-testing/wisp.resources/-fake-filesystem-loader-backend/open/#open","title":"open","text":"[jvm]\\ open override fun open(path: String): BufferedSource?
"},{"location":"0.x/wisp-sampling/","title":"wisp-sampling - Misk","text":"//wisp-sampling
"},{"location":"0.x/wisp-sampling/#wisp-sampling","title":"wisp-sampling","text":""},{"location":"0.x/wisp-sampling/#packages","title":"Packages","text":"Name wisp.sampling"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/","title":"Package-level declarations - Misk","text":"//wisp-sampling/wisp.sampling
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/#types","title":"Types","text":"Name Summary AlwaysSampler [jvm]class AlwaysSampler : Sampler PercentageSampler [jvm]class PercentageSampler(samplePercentage: Int, random: () -> Int) : Sampler RateLimiter [jvm]class RateLimiter@JvmOverloadsconstructor(var permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)A deterministic testable rate limiter that uses two variables: RateLimitingSampler [jvm]class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler Sampler [jvm]interface SamplerA Sampler is used to \"sample\" whether an action is allowed to occur or not. Sleeper [jvm]interface SleeperAbstraction forThread.sleep() that allows for testing. Ticker [jvm]interface TickerAbstraction for System.nanoTime() that allows for testing."},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/","title":"AlwaysSampler - Misk","text":"//wisp-sampling/wisp.sampling/AlwaysSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\ class AlwaysSampler : Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/#constructors","title":"Constructors","text":"AlwaysSampler [jvm]constructor()"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanTests if a sample is allowed or not"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/-always-sampler/","title":"AlwaysSampler - Misk","text":"//wisp-sampling/wisp.sampling/AlwaysSampler/AlwaysSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/-always-sampler/#alwayssampler","title":"AlwaysSampler","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/sample/","title":"sample - Misk","text":"//wisp-sampling/wisp.sampling/AlwaysSampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-always-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/PercentageSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/#percentagesampler","title":"PercentageSampler","text":"[jvm]\\ class PercentageSampler(samplePercentage: Int, random: () -> Int) : Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/#constructors","title":"Constructors","text":"PercentageSampler [jvm]constructor(samplePercentage: Int, random: () -> Int)"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanTests if a sample is allowed or not"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/-percentage-sampler/","title":"PercentageSampler - Misk","text":"//wisp-sampling/wisp.sampling/PercentageSampler/PercentageSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/-percentage-sampler/#percentagesampler","title":"PercentageSampler","text":"[jvm]\\ constructor(samplePercentage: Int, random: () -> Int)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/sample/","title":"sample - Misk","text":"//wisp-sampling/wisp.sampling/PercentageSampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-percentage-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/RateLimiter
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\ class RateLimiter@JvmOverloadsconstructor(var permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)
A deterministic testable rate limiter that uses two variables:
The implementation tracks a future timestamp that permits are consumed until.
This class is similar to Guava\u2019s rate limiter. Unlike Guava\u2019s rate limiter this class is testable by application code using the rate limiter. It also has very predictable behavior because its internal mechanisms are simpler than Guava\u2019s.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#constructors","title":"Constructors","text":"RateLimiter [jvm]@JvmOverloadsconstructor(permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#properties","title":"Properties","text":"Name Summary permitsPerSecond [jvm]@Volatilevar permitsPerSecond: Long"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/#functions","title":"Functions","text":"Name Summary getPermitsRemaining [jvm]fun getPermitsRemaining(unit: TimeUnit, timeout: Long): LongReturns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit. tryAcquire [jvm]fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): BooleanAttempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available."},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/-rate-limiter/","title":"RateLimiter - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/RateLimiter
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/-rate-limiter/#ratelimiter","title":"RateLimiter","text":"[jvm]\\
@JvmOverloads
constructor(permitsPerSecond: Long, ticker: Ticker = Ticker.DEFAULT, sleeper: Sleeper = Sleeper.DEFAULT)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/get-permits-remaining/","title":"getPermitsRemaining - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/getPermitsRemaining
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/get-permits-remaining/#getpermitsremaining","title":"getPermitsRemaining","text":"[jvm]\\ fun getPermitsRemaining(unit: TimeUnit, timeout: Long): Long
Returns the maximum number of permits that could have been acquired by a call to tryAcquire, assuming the caller passed the same timeout and unit.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/permits-per-second/","title":"permitsPerSecond - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/permitsPerSecond
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/permits-per-second/#permitspersecond","title":"permitsPerSecond","text":"[jvm]\\
@Volatile
var permitsPerSecond: Long
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/try-acquire/","title":"tryAcquire - Misk","text":"//wisp-sampling/wisp.sampling/RateLimiter/tryAcquire
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiter/try-acquire/#tryacquire","title":"tryAcquire","text":"[jvm]\\ fun tryAcquire(permitCount: Long, timeout: Long, unit: TimeUnit): Boolean
Attempt to acquire permitCount permits, sleeping up to timeout if necessary for them to become available.
Returns true if permits were acquired.
This always returns false if you request more than 1 window size worth of permits. If you need many permits, shrink your batch size. This is intended to smooth out consumption of the resources guarded by this rate limiter.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//wisp-sampling/wisp.sampling/RateLimitingSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ class RateLimitingSampler(rateLimiter: RateLimiter) : Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/#constructors","title":"Constructors","text":"RateLimitingSampler [jvm]constructor(rateLimiter: RateLimiter)"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/#functions","title":"Functions","text":"Name Summary sample [jvm]open override fun sample(): BooleanTests if a sample is allowed or not"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/-rate-limiting-sampler/","title":"RateLimitingSampler - Misk","text":"//wisp-sampling/wisp.sampling/RateLimitingSampler/RateLimitingSampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/-rate-limiting-sampler/#ratelimitingsampler","title":"RateLimitingSampler","text":"[jvm]\\ constructor(rateLimiter: RateLimiter)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/sample/","title":"sample - Misk","text":"//wisp-sampling/wisp.sampling/RateLimitingSampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/sample/#sample","title":"sample","text":"[jvm]\\ open override fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-rate-limiting-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/Sampler
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/#sampler","title":"Sampler","text":"interface Sampler
A Sampler is used to \"sample\" whether an action is allowed to occur or not.
A common usage of the sampler would look like:
if (sampler.sample()) {\n performAction()\n}\nThe frequency at which sample returns true or false is based on the implementation\u2019s policy. For example, Sampler.always creates a Sampler that only returns true, while Sampler.percentage will only return true for a given percentage of samples. For a more complex example, Sampler.rateLimiting will limit the number of true samples to a given rate per second.
//wisp-sampling/wisp.sampling/Sampler/sample
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/sample/#sample","title":"sample","text":"[jvm]\\ abstract fun sample(): Boolean
Tests if a sample is allowed or not
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/sample/#return","title":"Return","text":"true if sample is allowed, otherwise false
//wisp-sampling/wisp.sampling/Sampler/Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/#functions","title":"Functions","text":"Name Summary always [jvm]fun always(): SamplerCreates a Sampler that always returns positive results. percentage [jvm]fun percentage(samplePercentage: Int): SamplerCreates a Sampler that limits positive results to a percentage chance. rateLimiting [jvm]fun rateLimiting(ratePerSecond: Long): SamplerCreates a Sampler that limits positive results to a limited rate per second."},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/always/","title":"always - Misk","text":"//wisp-sampling/wisp.sampling/Sampler/Companion/always
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/always/#always","title":"always","text":"[jvm]\\ fun always(): Sampler
Creates a Sampler that always returns positive results.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/always/#return","title":"Return","text":"always Sampler instance
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/","title":"percentage - Misk","text":"//wisp-sampling/wisp.sampling/Sampler/Companion/percentage
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/#percentage","title":"percentage","text":"[jvm]\\ fun percentage(samplePercentage: Int): Sampler
Creates a Sampler that limits positive results to a percentage chance.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/#return","title":"Return","text":"percentage Sampler instance
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/percentage/#parameters","title":"Parameters","text":"jvm
samplePercentage percentage chance of positive results"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/","title":"rateLimiting - Misk","text":"//wisp-sampling/wisp.sampling/Sampler/Companion/rateLimiting
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/#ratelimiting","title":"rateLimiting","text":"[jvm]\\ fun rateLimiting(ratePerSecond: Long): Sampler
Creates a Sampler that limits positive results to a limited rate per second.
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/#return","title":"Return","text":"rate limiting Sampler instance
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sampler/-companion/rate-limiting/#parameters","title":"Parameters","text":"jvm
ratePerSecond the number of positive results per second"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/","title":"Sleeper - Misk","text":"//wisp-sampling/wisp.sampling/Sleeper
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/#sleeper","title":"Sleeper","text":"[jvm]\\ interface Sleeper
Abstraction for Thread.sleep() that allows for testing.
//wisp-sampling/wisp.sampling/Sleeper/sleep
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/sleep/#sleep","title":"sleep","text":"[jvm]\\ abstract fun sleep(duration: Duration)
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/","title":"Companion - Misk","text":"//wisp-sampling/wisp.sampling/Sleeper/Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT [jvm]val DEFAULT: Sleeper"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/-d-e-f-a-u-l-t/","title":"DEFAULT - Misk","text":"//wisp-sampling/wisp.sampling/Sleeper/Companion/DEFAULT
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-sleeper/-companion/-d-e-f-a-u-l-t/#default","title":"DEFAULT","text":"[jvm]\\ val DEFAULT: Sleeper
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/","title":"Ticker - Misk","text":"//wisp-sampling/wisp.sampling/Ticker
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/#ticker","title":"Ticker","text":"[jvm]\\ interface Ticker
Abstraction for System.nanoTime() that allows for testing.
//wisp-sampling/wisp.sampling/Ticker/read
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/read/#read","title":"read","text":"[jvm]\\ abstract fun read(): Long
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/","title":"Companion - Misk","text":"//wisp-sampling/wisp.sampling/Ticker/Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/#properties","title":"Properties","text":"Name Summary DEFAULT [jvm]val DEFAULT: Ticker"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/-d-e-f-a-u-l-t/","title":"DEFAULT - Misk","text":"//wisp-sampling/wisp.sampling/Ticker/Companion/DEFAULT
"},{"location":"0.x/wisp-sampling/wisp-sampling/wisp.sampling/-ticker/-companion/-d-e-f-a-u-l-t/#default","title":"DEFAULT","text":"[jvm]\\ val DEFAULT: Ticker
"},{"location":"0.x/wisp-ssl/","title":"wisp-ssl - Misk","text":"//wisp-ssl
"},{"location":"0.x/wisp-ssl/#wisp-ssl","title":"wisp-ssl","text":""},{"location":"0.x/wisp-ssl/#packages","title":"Packages","text":"Name wisp.security.ssl"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/","title":"Package-level declarations - Misk","text":"//wisp-ssl/wisp.security.ssl
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#types","title":"Types","text":"Name Summary CertificateAndKey [jvm]data class CertificateAndKey(val certificate: X509Certificate, val privateKey: PrivateKey) CertStore [jvm]data class CertStore(val keyStore: KeyStore)A certificate and its private key. CertStoreConfig [jvm]data class CertStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS) PemComboFile [jvm]data class PemComboFile(val certificates: List<ByteString>, val privateRsaKeys: List<ByteString>, val privateKeys: List<ByteString>, val passphrase: String)A file containing a mix of PEM-encoded certificates and PEM-encoded private keys. Can be used both for trust stores (which certificate authorities a TLS client trusts) and also for TLS servers (which certificate chain a TLS server serves). SslContextFactory [jvm]open class SslContextFactory(sslLoader: SslLoader) SslLoader [jvm]open class SslLoader(resourceLoader: ResourceLoader)Loads keys and certificates from the file system. TrustStore [jvm]data class TrustStore(val keyStore: KeyStore)A set of trusted root certificates. TrustStoreConfig [jvm]data class TrustStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#properties","title":"Properties","text":"Name Summary onlyAlias [jvm]val KeyStore.onlyAlias: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/#functions","title":"Functions","text":"Name Summary aliasesOfType [jvm]inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String> getCertificateAndKey [jvm]fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey? getPrivateKey [jvm]fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKeyfun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey getX509Certificate [jvm]fun KeyStore.getX509Certificate(): X509Certificatefun KeyStore.getX509Certificate(alias: String): X509Certificate getX509CertificateChain [jvm]fun KeyStore.getX509CertificateChain(): Array<X509Certificate>fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/aliases-of-type/","title":"aliasesOfType - Misk","text":"//wisp-ssl/wisp.security.ssl/aliasesOfType
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/aliases-of-type/#aliasesoftype","title":"aliasesOfType","text":"[jvm]\\ fun KeyStore.aliasesOfType(entryClass: Class<out KeyStore.Entry>): List<String>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/aliases-of-type/#return","title":"Return","text":"all aliases present in the keystore of a given entry type.
[jvm]\\ inline fun <T : KeyStore.Entry> KeyStore.aliasesOfType(): List<String>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/","title":"getCertificateAndKey - Misk","text":"//wisp-ssl/wisp.security.ssl/getCertificateAndKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/#getcertificateandkey","title":"getCertificateAndKey","text":"[jvm]\\ fun KeyStore.getCertificateAndKey(alias: String, passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/#return","title":"Return","text":"the certificate and key pair for the given alias
[jvm]\\ fun KeyStore.getCertificateAndKey(passphrase: CharArray): CertificateAndKey?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-certificate-and-key/#return_1","title":"Return","text":"the one and only CertificateAndKey in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/","title":"getPrivateKey - Misk","text":"//wisp-ssl/wisp.security.ssl/getPrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/#getprivatekey","title":"getPrivateKey","text":"[jvm]\\ fun KeyStore.getPrivateKey(alias: String, passphrase: CharArray): PrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/#return","title":"Return","text":"the PrivateKey with the given alias
[jvm]\\ fun KeyStore.getPrivateKey(passphrase: CharArray): PrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-private-key/#return_1","title":"Return","text":"the one and only PrivateKey in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/","title":"getX509CertificateChain - Misk","text":"//wisp-ssl/wisp.security.ssl/getX509CertificateChain
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/#getx509certificatechain","title":"getX509CertificateChain","text":"[jvm]\\ fun KeyStore.getX509CertificateChain(alias: String): Array<X509Certificate>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/#return","title":"Return","text":"the X509Certificate chain with the provided alias
[jvm]\\ fun KeyStore.getX509CertificateChain(): Array<X509Certificate>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate-chain/#return_1","title":"Return","text":"the one and only X509Certificate chain in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/","title":"getX509Certificate - Misk","text":"//wisp-ssl/wisp.security.ssl/getX509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/#getx509certificate","title":"getX509Certificate","text":"[jvm]\\ fun KeyStore.getX509Certificate(alias: String): X509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/#return","title":"Return","text":"The X509Certificate with the provided alias
[jvm]\\ fun KeyStore.getX509Certificate(): X509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/get-x509-certificate/#return_1","title":"Return","text":"the one and only X509Certificate in the keystore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/only-alias/","title":"onlyAlias - Misk","text":"//wisp-ssl/wisp.security.ssl/onlyAlias
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/only-alias/#onlyalias","title":"onlyAlias","text":"[jvm]\\ val KeyStore.onlyAlias: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/only-alias/#return","title":"Return","text":"the only alias in the keystore, if the keystore only has a single entry
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/","title":"CertStore - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/#certstore","title":"CertStore","text":"[jvm]\\ data class CertStore(val keyStore: KeyStore)
A certificate and its private key.
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/#constructors","title":"Constructors","text":"CertStore [jvm]constructor(keyStore: KeyStore)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/#properties","title":"Properties","text":"Name Summary keyStore [jvm]val keyStore: KeyStore"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/-cert-store/","title":"CertStore - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStore/CertStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/-cert-store/#certstore","title":"CertStore","text":"[jvm]\\ constructor(keyStore: KeyStore)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/key-store/","title":"keyStore - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStore/keyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store/key-store/#keystore","title":"keyStore","text":"[jvm]\\ val keyStore: KeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\ data class CertStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/#constructors","title":"Constructors","text":"CertStoreConfig [jvm]@JvmOverloadsconstructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/-cert-store-config/","title":"CertStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/CertStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/-cert-store-config/#certstoreconfig","title":"CertStoreConfig","text":"[jvm]\\
@JvmOverloads
constructor(resource: String, passphrase: String? = null, format: String = SslLoader.FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/format/","title":"format - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/format
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/passphrase/","title":"passphrase - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/passphrase
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/resource/","title":"resource - Misk","text":"//wisp-ssl/wisp.security.ssl/CertStoreConfig/resource
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-cert-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/","title":"CertificateAndKey - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/#certificateandkey","title":"CertificateAndKey","text":"[jvm]\\ data class CertificateAndKey(val certificate: X509Certificate, val privateKey: PrivateKey)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/#constructors","title":"Constructors","text":"CertificateAndKey [jvm]constructor(certificate: X509Certificate, privateKey: PrivateKey)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/#properties","title":"Properties","text":"Name Summary certificate [jvm]val certificate: X509Certificate privateKey [jvm]val privateKey: PrivateKey"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/-certificate-and-key/","title":"CertificateAndKey - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey/CertificateAndKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/-certificate-and-key/#certificateandkey","title":"CertificateAndKey","text":"[jvm]\\ constructor(certificate: X509Certificate, privateKey: PrivateKey)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/certificate/","title":"certificate - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey/certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/certificate/#certificate","title":"certificate","text":"[jvm]\\ val certificate: X509Certificate
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/private-key/","title":"privateKey - Misk","text":"//wisp-ssl/wisp.security.ssl/CertificateAndKey/privateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-certificate-and-key/private-key/#privatekey","title":"privateKey","text":"[jvm]\\ val privateKey: PrivateKey
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/","title":"PemComboFile - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#pemcombofile","title":"PemComboFile","text":"[jvm]\\ data class PemComboFile(val certificates: List<ByteString>, val privateRsaKeys: List<ByteString>, val privateKeys: List<ByteString>, val passphrase: String)
A file containing a mix of PEM-encoded certificates and PEM-encoded private keys. Can be used both for trust stores (which certificate authorities a TLS client trusts) and also for TLS servers (which certificate chain a TLS server serves).
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#constructors","title":"Constructors","text":"PemComboFile [jvm]constructor(certificates: List<ByteString>, privateRsaKeys: List<ByteString>, privateKeys: List<ByteString>, passphrase: String)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#properties","title":"Properties","text":"Name Summary certificates [jvm]val certificates: List<ByteString> passphrase [jvm]val passphrase: String privateKeys [jvm]val privateKeys: List<ByteString> privateRsaKeys [jvm]val privateRsaKeys: List<ByteString>"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/#functions","title":"Functions","text":"Name Summary decodeCertificates [jvm]fun decodeCertificates(): List<Certificate> newEmptyKeyStore [jvm]fun newEmptyKeyStore(): KeyStore"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-pem-combo-file/","title":"PemComboFile - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/PemComboFile
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-pem-combo-file/#pemcombofile","title":"PemComboFile","text":"[jvm]\\ constructor(certificates: List<ByteString>, privateRsaKeys: List<ByteString>, privateKeys: List<ByteString>, passphrase: String)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/certificates/","title":"certificates - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/certificates
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/certificates/#certificates","title":"certificates","text":"[jvm]\\ val certificates: List<ByteString>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/decode-certificates/","title":"decodeCertificates - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/decodeCertificates
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/decode-certificates/#decodecertificates","title":"decodeCertificates","text":"[jvm]\\ fun decodeCertificates(): List<Certificate>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/new-empty-key-store/","title":"newEmptyKeyStore - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/newEmptyKeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/new-empty-key-store/#newemptykeystore","title":"newEmptyKeyStore","text":"[jvm]\\ fun newEmptyKeyStore(): KeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/passphrase/","title":"passphrase - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/passphrase
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-keys/","title":"privateKeys - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/privateKeys
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-keys/#privatekeys","title":"privateKeys","text":"[jvm]\\ val privateKeys: List<ByteString>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-rsa-keys/","title":"privateRsaKeys - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/privateRsaKeys
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/private-rsa-keys/#privatersakeys","title":"privateRsaKeys","text":"[jvm]\\ val privateRsaKeys: List<ByteString>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/","title":"Companion - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/#functions","title":"Functions","text":"Name Summary convertPKCS1toPKCS8 [jvm]fun convertPKCS1toPKCS8(pkcs1Key: ByteString): KeySpec parse [jvm]fun parse(certKeyComboSource: BufferedSource, passphrase: String? = null): PemComboFile"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/convert-p-k-c-s1to-p-k-c-s8/","title":"convertPKCS1toPKCS8 - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/Companion/convertPKCS1toPKCS8
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/convert-p-k-c-s1to-p-k-c-s8/#convertpkcs1topkcs8","title":"convertPKCS1toPKCS8","text":"[jvm]\\ fun convertPKCS1toPKCS8(pkcs1Key: ByteString): KeySpec
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/parse/","title":"parse - Misk","text":"//wisp-ssl/wisp.security.ssl/PemComboFile/Companion/parse
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-pem-combo-file/-companion/parse/#parse","title":"parse","text":"[jvm]\\ fun parse(certKeyComboSource: BufferedSource, passphrase: String? = null): PemComboFile
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\ open class SslContextFactory(sslLoader: SslLoader)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/#constructors","title":"Constructors","text":"SslContextFactory [jvm]constructor(sslLoader: SslLoader)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/#functions","title":"Functions","text":"Name Summary create [jvm]@JvmOverloadsfun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext@JvmOverloadsfun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext loadTrustManagers [jvm]fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/-ssl-context-factory/","title":"SslContextFactory - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory/SslContextFactory
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/-ssl-context-factory/#sslcontextfactory","title":"SslContextFactory","text":"[jvm]\\ constructor(sslLoader: SslLoader)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/create/","title":"create - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory/create
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/create/#create","title":"create","text":"[jvm]\\
@JvmOverloads
fun create(certStore: CertStoreConfig? = null, trustStore: TrustStoreConfig? = null): SSLContext
@JvmOverloads
fun create(certStore: CertStore?, pin: CharArray?, trustStore: TrustStore? = null): SSLContext
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/create/#return","title":"Return","text":"A new SSLContext for the given certstore and optional truststore config
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/load-trust-managers/","title":"loadTrustManagers - Misk","text":"//wisp-ssl/wisp.security.ssl/SslContextFactory/loadTrustManagers
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/load-trust-managers/#loadtrustmanagers","title":"loadTrustManagers","text":"[jvm]\\ fun loadTrustManagers(trustStore: KeyStore): Array<TrustManager>
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-context-factory/load-trust-managers/#return","title":"Return","text":"a set of TrustManagers based on the certificates in the given truststore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/","title":"SslLoader - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#sslloader","title":"SslLoader","text":"[jvm]\\ open class SslLoader(resourceLoader: ResourceLoader)
Loads keys and certificates from the file system.
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#constructors","title":"Constructors","text":"SslLoader [jvm]constructor(resourceLoader: ResourceLoader)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/#functions","title":"Functions","text":"Name Summary loadCertStore [jvm]fun loadCertStore(config: CertStoreConfig): CertStore?@JvmOverloadsfun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore? loadTrustStore [jvm]fun loadTrustStore(config: TrustStoreConfig): TrustStore?@JvmOverloadsfun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-ssl-loader/","title":"SslLoader - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/SslLoader
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-ssl-loader/#sslloader","title":"SslLoader","text":"[jvm]\\ constructor(resourceLoader: ResourceLoader)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-cert-store/","title":"loadCertStore - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/loadCertStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-cert-store/#loadcertstore","title":"loadCertStore","text":"[jvm]\\
@JvmOverloads
fun loadCertStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): CertStore?
fun loadCertStore(config: CertStoreConfig): CertStore?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-trust-store/","title":"loadTrustStore - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/loadTrustStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/load-trust-store/#loadtruststore","title":"loadTrustStore","text":"[jvm]\\
@JvmOverloads
fun loadTrustStore(path: String, format: String = FORMAT_PEM, passphrase: String? = null): TrustStore?
fun loadTrustStore(config: TrustStoreConfig): TrustStore?
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/","title":"Companion - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/#properties","title":"Properties","text":"Name Summary FORMAT_JCEKS [jvm]const val FORMAT_JCEKS: String FORMAT_JKS [jvm]const val FORMAT_JKS: String FORMAT_PEM [jvm]const val FORMAT_PEM: String FORMAT_PKCS12 [jvm]const val FORMAT_PKCS12: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/","title":"FORMAT_JCEKS - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_JCEKS
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-c-e-k-s/#format_jceks","title":"FORMAT_JCEKS","text":"[jvm]\\ const val FORMAT_JCEKS: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/","title":"FORMAT_JKS - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_JKS
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-j-k-s/#format_jks","title":"FORMAT_JKS","text":"[jvm]\\ const val FORMAT_JKS: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/","title":"FORMAT_PEM - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_PEM
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-e-m/#format_pem","title":"FORMAT_PEM","text":"[jvm]\\ const val FORMAT_PEM: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-k-c-s12/","title":"FORMAT_PKCS12 - Misk","text":"//wisp-ssl/wisp.security.ssl/SslLoader/Companion/FORMAT_PKCS12
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-ssl-loader/-companion/-f-o-r-m-a-t_-p-k-c-s12/#format_pkcs12","title":"FORMAT_PKCS12","text":"[jvm]\\ const val FORMAT_PKCS12: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/","title":"TrustStore - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/#truststore","title":"TrustStore","text":"[jvm]\\ data class TrustStore(val keyStore: KeyStore)
A set of trusted root certificates.
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/#constructors","title":"Constructors","text":"TrustStore [jvm]constructor(keyStore: KeyStore)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/#properties","title":"Properties","text":"Name Summary keyStore [jvm]val keyStore: KeyStore"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/-trust-store/","title":"TrustStore - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStore/TrustStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/-trust-store/#truststore","title":"TrustStore","text":"[jvm]\\ constructor(keyStore: KeyStore)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/key-store/","title":"keyStore - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStore/keyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store/key-store/#keystore","title":"keyStore","text":"[jvm]\\ val keyStore: KeyStore
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\ data class TrustStoreConfig@JvmOverloadsconstructor(val resource: String, val passphrase: String? = null, val format: String = FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/#constructors","title":"Constructors","text":"TrustStoreConfig [jvm]@JvmOverloadsconstructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/#properties","title":"Properties","text":"Name Summary format [jvm]val format: String passphrase [jvm]val passphrase: String? = null resource [jvm]val resource: String"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/-trust-store-config/","title":"TrustStoreConfig - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/TrustStoreConfig
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/-trust-store-config/#truststoreconfig","title":"TrustStoreConfig","text":"[jvm]\\
@JvmOverloads
constructor(resource: String, passphrase: String? = null, format: String = FORMAT_JCEKS)
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/format/","title":"format - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/format
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/format/#format","title":"format","text":"[jvm]\\ val format: String
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/passphrase/","title":"passphrase - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/passphrase
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/passphrase/#passphrase","title":"passphrase","text":"[jvm]\\ val passphrase: String? = null
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/resource/","title":"resource - Misk","text":"//wisp-ssl/wisp.security.ssl/TrustStoreConfig/resource
"},{"location":"0.x/wisp-ssl/wisp-ssl/wisp.security.ssl/-trust-store-config/resource/#resource","title":"resource","text":"[jvm]\\ val resource: String
"},{"location":"0.x/wisp-task/","title":"wisp-task - Misk","text":"//wisp-task
"},{"location":"0.x/wisp-task/#wisp-task","title":"wisp-task","text":""},{"location":"0.x/wisp-task/#packages","title":"Packages","text":"Name wisp.task wisp.task.exception"},{"location":"0.x/wisp-task/wisp-task/wisp.task/","title":"Package-level declarations - Misk","text":"//wisp-task/wisp.task
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-task/wisp-task/wisp.task/#types","title":"Types","text":"Name Summary RepeatedTask [jvm]class RepeatedTask@JvmOverloadsconstructor(val name: String, meterRegistry: MeterRegistry = Metrics.globalRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status)A RepeatedTask runs a repeated task at the user controlled rate. RepeatedTaskConfig [jvm]data class RepeatedTaskConfig@JvmOverloadsconstructor(val timeBetweenRunsMs: Long = 30000, val initialDelayMs: Long = 0, val defaultJitterMs: Long = 50, val defaultMaxDelayMs: Long = 60000) : Config RepeatedTaskManager [jvm]class RepeatedTaskManager@JvmOverloadsconstructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)Basic management of repeated tasks. RepeatedTaskMetrics [jvm]class RepeatedTaskMetrics(meterRegistry: MeterRegistry)Metrics for repeated tasks: Status [jvm]enum Status : Enum<Status> TaskConfig [jvm]open class TaskConfig : ConfigConfig to pass to the task. Extend this to pass in anything else your task may need."},{"location":"0.x/wisp-task/wisp-task/wisp.task/#properties","title":"Properties","text":"Name Summary defaultThrowableRetryPolicy [jvm]val defaultThrowableRetryPolicy: RetryPolicy<Throwable>By default, continue retrying"},{"location":"0.x/wisp-task/wisp-task/wisp.task/default-throwable-retry-policy/","title":"defaultThrowableRetryPolicy - Misk","text":"//wisp-task/wisp.task/defaultThrowableRetryPolicy
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/default-throwable-retry-policy/#defaultthrowableretrypolicy","title":"defaultThrowableRetryPolicy","text":"[jvm]\\ val defaultThrowableRetryPolicy: RetryPolicy<Throwable>
By default, continue retrying
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/","title":"RepeatedTask - Misk","text":"//wisp-task/wisp.task/RepeatedTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/#repeatedtask","title":"RepeatedTask","text":"[jvm]\\ class RepeatedTask@JvmOverloadsconstructor(val name: String, meterRegistry: MeterRegistry = Metrics.globalRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status)
A RepeatedTask runs a repeated task at the user controlled rate.
Tasks are called with a TaskConfig and are expected to return a Status or throw an exception. By default, the retry policy will try again if an exception is thrown and will apply a binaryExponentialBackoff using the supplied RepeatedTaskConfig. A Status.NO_WORK or Status.FAILED will be mapped to NoWorkForTaskException and FailedTaskException and thrown to apply the retry policy.
If the Status.NO_RESCHEDULE is returned, the RepeatedTask is shutdown.
Example usage:
val repeatedTask = RepeatedTask(\"task\") {\n // do task stuff...\n return Status.OK\n}\n\nrepeatedTask.startUp()\n//wisp-task/wisp.task/RepeatedTask/RepeatedTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/-repeated-task/#repeatedtask","title":"RepeatedTask","text":"[jvm]\\
@JvmOverloads
constructor(name: String, meterRegistry: MeterRegistry = Metrics.globalRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/is-running/","title":"isRunning - Misk","text":"//wisp-task/wisp.task/RepeatedTask/isRunning
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/is-running/#isrunning","title":"isRunning","text":"[jvm]\\ fun isRunning(): Boolean
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/name/","title":"name - Misk","text":"//wisp-task/wisp.task/RepeatedTask/name
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/shut-down/","title":"shutDown - Misk","text":"//wisp-task/wisp.task/RepeatedTask/shutDown
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/start-up/","title":"startUp - Misk","text":"//wisp-task/wisp.task/RepeatedTask/startUp
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/start-up/#startup","title":"startUp","text":"[jvm]\\ fun startUp()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/-companion/","title":"Companion - Misk","text":"//wisp-task/wisp.task/RepeatedTask/Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/","title":"RepeatedTaskConfig - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/#repeatedtaskconfig","title":"RepeatedTaskConfig","text":"[jvm]\\ data class RepeatedTaskConfig@JvmOverloadsconstructor(val timeBetweenRunsMs: Long = 30000, val initialDelayMs: Long = 0, val defaultJitterMs: Long = 50, val defaultMaxDelayMs: Long = 60000) : Config
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/#constructors","title":"Constructors","text":"RepeatedTaskConfig [jvm]@JvmOverloadsconstructor(timeBetweenRunsMs: Long = 30000, initialDelayMs: Long = 0, defaultJitterMs: Long = 50, defaultMaxDelayMs: Long = 60000)"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/#properties","title":"Properties","text":"Name Summary defaultJitterMs [jvm]val defaultJitterMs: Long = 50The default amount of jitter to use when scheduling backoffs. defaultMaxDelayMs [jvm]val defaultMaxDelayMs: Long = 60000The default maximum backoff time. initialDelayMs [jvm]val initialDelayMs: Long = 0Initial delay before starting the first task run, defaults to no delay, i.e. immediate start timeBetweenRunsMs [jvm]val timeBetweenRunsMs: Long = 30000Time between runs of tasks, set to 0 if immediately repeat task"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/-repeated-task-config/","title":"RepeatedTaskConfig - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/RepeatedTaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/-repeated-task-config/#repeatedtaskconfig","title":"RepeatedTaskConfig","text":"[jvm]\\
@JvmOverloads
constructor(timeBetweenRunsMs: Long = 30000, initialDelayMs: Long = 0, defaultJitterMs: Long = 50, defaultMaxDelayMs: Long = 60000)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-jitter-ms/","title":"defaultJitterMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/defaultJitterMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-jitter-ms/#defaultjitterms","title":"defaultJitterMs","text":"[jvm]\\ val defaultJitterMs: Long = 50
The default amount of jitter to use when scheduling backoffs.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-max-delay-ms/","title":"defaultMaxDelayMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/defaultMaxDelayMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/default-max-delay-ms/#defaultmaxdelayms","title":"defaultMaxDelayMs","text":"[jvm]\\ val defaultMaxDelayMs: Long = 60000
The default maximum backoff time.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/initial-delay-ms/","title":"initialDelayMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/initialDelayMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/initial-delay-ms/#initialdelayms","title":"initialDelayMs","text":"[jvm]\\ val initialDelayMs: Long = 0
Initial delay before starting the first task run, defaults to no delay, i.e. immediate start
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/time-between-runs-ms/","title":"timeBetweenRunsMs - Misk","text":"//wisp-task/wisp.task/RepeatedTaskConfig/timeBetweenRunsMs
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-config/time-between-runs-ms/#timebetweenrunsms","title":"timeBetweenRunsMs","text":"[jvm]\\ val timeBetweenRunsMs: Long = 30000
Time between runs of tasks, set to 0 if immediately repeat task
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/","title":"RepeatedTaskManager - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/#repeatedtaskmanager","title":"RepeatedTaskManager","text":"[jvm]\\ class RepeatedTaskManager@JvmOverloadsconstructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)
Basic management of repeated tasks.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/#constructors","title":"Constructors","text":"RepeatedTaskManager [jvm]@JvmOverloadsconstructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/#functions","title":"Functions","text":"Name Summary createTask [jvm]@JvmOverloadsfun createTask(name: String, meterRegistry: MeterRegistry = this.meterRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status): RepeatedTaskCreates the repeated task with the details supplied. If the repeated task already exists, a TaskAlreadyExistsException is thrown. getTask [jvm]fun getTask(taskName: String): RepeatedTask isTaskRunning [jvm]fun isTaskRunning(taskName: String): BooleanReturns true if a repeated task with the name supplied is running. If the task does not exist or is not running, return false. shutDown [jvm]fun shutDown() taskExists [jvm]fun taskExists(taskName: String): Boolean"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/-repeated-task-manager/","title":"RepeatedTaskManager - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/RepeatedTaskManager
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/-repeated-task-manager/#repeatedtaskmanager","title":"RepeatedTaskManager","text":"[jvm]\\
@JvmOverloads
constructor(meterRegistry: MeterRegistry = Metrics.globalRegistry)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/create-task/","title":"createTask - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/createTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/create-task/#createtask","title":"createTask","text":"[jvm]\\
@JvmOverloads
fun createTask(name: String, meterRegistry: MeterRegistry = this.meterRegistry, repeatedTaskConfig: RepeatedTaskConfig = RepeatedTaskConfig(), retryPolicy: suspend RetryFailure<Throwable>.() -> RetryInstruction = defaultThrowableRetryPolicy + binaryExponentialBackoff( base = repeatedTaskConfig.defaultJitterMs, max = repeatedTaskConfig.defaultMaxDelayMs ), taskConfig: TaskConfig = TaskConfig(), task: (name: String, taskConfig: TaskConfig) -> Status): RepeatedTask
Creates the repeated task with the details supplied. If the repeated task already exists, a TaskAlreadyExistsException is thrown.
Does not start the task.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/get-task/","title":"getTask - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/getTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/get-task/#gettask","title":"getTask","text":"[jvm]\\ fun getTask(taskName: String): RepeatedTask
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/is-task-running/","title":"isTaskRunning - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/isTaskRunning
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/is-task-running/#istaskrunning","title":"isTaskRunning","text":"[jvm]\\ fun isTaskRunning(taskName: String): Boolean
Returns true if a repeated task with the name supplied is running. If the task does not exist or is not running, return false.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/shut-down/","title":"shutDown - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/shutDown
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/shut-down/#shutdown","title":"shutDown","text":"[jvm]\\ fun shutDown()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/task-exists/","title":"taskExists - Misk","text":"//wisp-task/wisp.task/RepeatedTaskManager/taskExists
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-manager/task-exists/#taskexists","title":"taskExists","text":"[jvm]\\ fun taskExists(taskName: String): Boolean
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/","title":"RepeatedTaskMetrics - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/#repeatedtaskmetrics","title":"RepeatedTaskMetrics","text":"[jvm]\\ class RepeatedTaskMetrics(meterRegistry: MeterRegistry)
Metrics for repeated tasks:
Duration Success Count Failures Count Count of No Work Required
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/#constructors","title":"Constructors","text":"RepeatedTaskMetrics [jvm]constructor(meterRegistry: MeterRegistry)"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-repeated-task-metrics/","title":"RepeatedTaskMetrics - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/RepeatedTaskMetrics
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-repeated-task-metrics/#repeatedtaskmetrics","title":"RepeatedTaskMetrics","text":"[jvm]\\ constructor(meterRegistry: MeterRegistry)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/","title":"Companion - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/#properties","title":"Properties","text":"Name Summary DURATION_SUMMARY_NAME [jvm]const val DURATION_SUMMARY_NAME: String FAILED_COUNTER_NAME [jvm]const val FAILED_COUNTER_NAME: String NO_WORK_COUNTER_NAME [jvm]const val NO_WORK_COUNTER_NAME: String SUCCESS_COUNTER_NAME [jvm]const val SUCCESS_COUNTER_NAME: String"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-d-u-r-a-t-i-o-n_-s-u-m-m-a-r-y_-n-a-m-e/","title":"DURATION_SUMMARY_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/DURATION_SUMMARY_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-d-u-r-a-t-i-o-n_-s-u-m-m-a-r-y_-n-a-m-e/#duration_summary_name","title":"DURATION_SUMMARY_NAME","text":"[jvm]\\ const val DURATION_SUMMARY_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/","title":"FAILED_COUNTER_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/FAILED_COUNTER_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-f-a-i-l-e-d_-c-o-u-n-t-e-r_-n-a-m-e/#failed_counter_name","title":"FAILED_COUNTER_NAME","text":"[jvm]\\ const val FAILED_COUNTER_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-n-o_-w-o-r-k_-c-o-u-n-t-e-r_-n-a-m-e/","title":"NO_WORK_COUNTER_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/NO_WORK_COUNTER_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-n-o_-w-o-r-k_-c-o-u-n-t-e-r_-n-a-m-e/#no_work_counter_name","title":"NO_WORK_COUNTER_NAME","text":"[jvm]\\ const val NO_WORK_COUNTER_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/","title":"SUCCESS_COUNTER_NAME - Misk","text":"//wisp-task/wisp.task/RepeatedTaskMetrics/Companion/SUCCESS_COUNTER_NAME
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-repeated-task-metrics/-companion/-s-u-c-c-e-s-s_-c-o-u-n-t-e-r_-n-a-m-e/#success_counter_name","title":"SUCCESS_COUNTER_NAME","text":"[jvm]\\ const val SUCCESS_COUNTER_NAME: String
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/","title":"Status - Misk","text":"//wisp-task/wisp.task/Status
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#status","title":"Status","text":"[jvm]\\ enum Status : Enum<Status>
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#entries","title":"Entries","text":"OK [jvm]OKThe task completed successfully and processed work NO_WORK [jvm]NO_WORKThe task had no work to complete FAILED [jvm]FAILEDThe task resulted in an error NO_RESCHEDULE [jvm]NO_RESCHEDULEThe task should not be rescheduled"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#properties","title":"Properties","text":"Name Summary entries [jvm]val entries: EnumEntries<Status>Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared. name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored. valueOf [jvm]fun valueOf(value: String): StatusReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) values [jvm]fun values(): Array<Status>Returns an array containing the constants of this enum type, in the order they\u2019re declared."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/entries/","title":"entries - Misk","text":"//wisp-task/wisp.task/Status/entries
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/entries/#entries","title":"entries","text":"[jvm]\\ val entries: EnumEntries<Status>
Returns a representation of an immutable list of all enum entries, in the order they\u2019re declared.
This method may be used to iterate over the enum entries.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/metric-label/","title":"metricLabel - Misk","text":"//wisp-task/wisp.task/Status/metricLabel
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/metric-label/#metriclabel","title":"metricLabel","text":"[jvm]\\ fun metricLabel(): String
The metric label for the status. This is used instead of name() in case the code is refactored.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/value-of/","title":"valueOf - Misk","text":"//wisp-task/wisp.task/Status/valueOf
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/value-of/#valueof","title":"valueOf","text":"[jvm]\\ fun valueOf(value: String): Status
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/value-of/#throws","title":"Throws","text":"IllegalArgumentException if this enum type has no constant with the specified name"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/values/","title":"values - Misk","text":"//wisp-task/wisp.task/Status/values
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/values/#values","title":"values","text":"[jvm]\\ fun values(): Array<Status>
Returns an array containing the constants of this enum type, in the order they\u2019re declared.
This method may be used to iterate over the constants.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/","title":"FAILED - Misk","text":"//wisp-task/wisp.task/Status/FAILED
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/#failed","title":"FAILED","text":"[jvm]\\ FAILED
The task resulted in an error
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-f-a-i-l-e-d/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/","title":"NO_RESCHEDULE - Misk","text":"//wisp-task/wisp.task/Status/NO_RESCHEDULE
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#no_reschedule","title":"NO_RESCHEDULE","text":"[jvm]\\ NO_RESCHEDULE
The task should not be rescheduled
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-r-e-s-c-h-e-d-u-l-e/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/","title":"NO_WORK - Misk","text":"//wisp-task/wisp.task/Status/NO_WORK
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/#no_work","title":"NO_WORK","text":"[jvm]\\ NO_WORK
The task had no work to complete
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-n-o_-w-o-r-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/","title":"OK - Misk","text":"//wisp-task/wisp.task/Status/OK
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/#ok","title":"OK","text":"[jvm]\\ OK
The task completed successfully and processed work
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String ordinal [jvm]val ordinal: Int"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-status/-o-k/#functions","title":"Functions","text":"Name Summary metricLabel [jvm]fun metricLabel(): StringThe metric label for the status. This is used instead of name() in case the code is refactored."},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/","title":"TaskConfig - Misk","text":"//wisp-task/wisp.task/TaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/#taskconfig","title":"TaskConfig","text":"[jvm]\\ open class TaskConfig : Config
Config to pass to the task. Extend this to pass in anything else your task may need.
Note that this extends Config, so you can load your task\u2019s config if required.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/#constructors","title":"Constructors","text":"TaskConfig [jvm]constructor()"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/-task-config/","title":"TaskConfig - Misk","text":"//wisp-task/wisp.task/TaskConfig/TaskConfig
"},{"location":"0.x/wisp-task/wisp-task/wisp.task/-task-config/-task-config/#taskconfig","title":"TaskConfig","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/","title":"Package-level declarations - Misk","text":"//wisp-task/wisp.task.exception
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/#types","title":"Types","text":"Name Summary FailedTaskException [jvm]class FailedTaskException : ExceptionCan be thrown by a task to indicate it has failed. NoTaskFoundException [jvm]class NoTaskFoundException(taskName: String) : ExceptionThrown if an attempt to retrieve a non-existent RepeatedTask. NoWorkForTaskException [jvm]class NoWorkForTaskException : ExceptionCan be thrown by a task to indicate it has no work to do at this time. TaskAlreadyExistsException [jvm]class TaskAlreadyExistsException(taskName: String) : ExceptionThrown if an attempt to create a RepeatedTask that already exists with the name supplied."},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/","title":"FailedTaskException - Misk","text":"//wisp-task/wisp.task.exception/FailedTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#failedtaskexception","title":"FailedTaskException","text":"[jvm]\\ class FailedTaskException : Exception
Can be thrown by a task to indicate it has failed.
If a task returns Status.FAILED, it is mapped to this exception and thrown.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#constructors","title":"Constructors","text":"FailedTaskException [jvm]constructor()"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/-failed-task-exception/","title":"FailedTaskException - Misk","text":"//wisp-task/wisp.task.exception/FailedTaskException/FailedTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-failed-task-exception/-failed-task-exception/#failedtaskexception","title":"FailedTaskException","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/","title":"NoTaskFoundException - Misk","text":"//wisp-task/wisp.task.exception/NoTaskFoundException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#notaskfoundexception","title":"NoTaskFoundException","text":"[jvm]\\ class NoTaskFoundException(taskName: String) : Exception
Thrown if an attempt to retrieve a non-existent RepeatedTask.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#constructors","title":"Constructors","text":"NoTaskFoundException [jvm]constructor(taskName: String)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/-no-task-found-exception/","title":"NoTaskFoundException - Misk","text":"//wisp-task/wisp.task.exception/NoTaskFoundException/NoTaskFoundException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-task-found-exception/-no-task-found-exception/#notaskfoundexception","title":"NoTaskFoundException","text":"[jvm]\\ constructor(taskName: String)
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/","title":"NoWorkForTaskException - Misk","text":"//wisp-task/wisp.task.exception/NoWorkForTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#noworkfortaskexception","title":"NoWorkForTaskException","text":"[jvm]\\ class NoWorkForTaskException : Exception
Can be thrown by a task to indicate it has no work to do at this time.
If a task returns Status.NO_WORK, it is mapped to this exception and thrown.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#constructors","title":"Constructors","text":"NoWorkForTaskException [jvm]constructor()"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/-no-work-for-task-exception/","title":"NoWorkForTaskException - Misk","text":"//wisp-task/wisp.task.exception/NoWorkForTaskException/NoWorkForTaskException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-no-work-for-task-exception/-no-work-for-task-exception/#noworkfortaskexception","title":"NoWorkForTaskException","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/","title":"TaskAlreadyExistsException - Misk","text":"//wisp-task/wisp.task.exception/TaskAlreadyExistsException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#taskalreadyexistsexception","title":"TaskAlreadyExistsException","text":"[jvm]\\ class TaskAlreadyExistsException(taskName: String) : Exception
Thrown if an attempt to create a RepeatedTask that already exists with the name supplied.
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#constructors","title":"Constructors","text":"TaskAlreadyExistsException [jvm]constructor(taskName: String)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#properties","title":"Properties","text":"Name Summary cause [jvm]open val cause: Throwable? message [jvm]open val message: String?"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/#functions","title":"Functions","text":"Name Summary addSuppressed [jvm]fun addSuppressed(p0: Throwable) fillInStackTrace [jvm]open fun fillInStackTrace(): Throwable getLocalizedMessage [jvm]open fun getLocalizedMessage(): String getStackTrace [jvm]open fun getStackTrace(): Array<StackTraceElement> getSuppressed [jvm]fun getSuppressed(): Array<Throwable> initCause [jvm]open fun initCause(p0: Throwable): Throwable printStackTrace [jvm]open fun printStackTrace()open fun printStackTrace(p0: PrintStream)open fun printStackTrace(p0: PrintWriter) setStackTrace [jvm]open fun setStackTrace(p0: Array<StackTraceElement>)"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/-task-already-exists-exception/","title":"TaskAlreadyExistsException - Misk","text":"//wisp-task/wisp.task.exception/TaskAlreadyExistsException/TaskAlreadyExistsException
"},{"location":"0.x/wisp-task/wisp-task/wisp.task.exception/-task-already-exists-exception/-task-already-exists-exception/#taskalreadyexistsexception","title":"TaskAlreadyExistsException","text":"[jvm]\\ constructor(taskName: String)
"},{"location":"0.x/wisp-time-testing/","title":"wisp-time-testing - Misk","text":"//wisp-time-testing
"},{"location":"0.x/wisp-time-testing/#wisp-time-testing","title":"wisp-time-testing","text":""},{"location":"0.x/wisp-time-testing/#packages","title":"Packages","text":"Name wisp.time"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/","title":"Package-level declarations - Misk","text":"//wisp-time-testing/wisp.time
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/#types","title":"Types","text":"Name Summary FakeClock [jvm]open class FakeClock@JvmOverloadsconstructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\")) : Clock, TestFixtureControllable clock for testing."},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/","title":"FakeClock - Misk","text":"//wisp-time-testing/wisp.time/FakeClock
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\ open class FakeClock@JvmOverloadsconstructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\")) : Clock, TestFixture
Controllable clock for testing.
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#constructors","title":"Constructors","text":"FakeClock [jvm]@JvmOverloadsconstructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\"))"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#types","title":"Types","text":"Name Summary Companion [jvm]object Companion"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/#functions","title":"Functions","text":"Name Summary add [jvm]fun add(d: Duration): LongAdvance the clock by specified Duration.[jvm]fun add(p: Period): LongAdvance the clock by the specified Period. Note that unlike adding a Duration the exact amount that is added to the clock will depend on its current time and timezone. Not all days, months or years have the same length. See the documentation for Period.[jvm]fun add(n: Long, unit: TimeUnit): LongAdvance the clock by specified amountn of TimeUnit. equals [jvm]open operator override fun equals(other: Any?): Boolean getZone [jvm]open override fun getZone(): ZoneId hashCode [jvm]open override fun hashCode(): Int instant [jvm]open override fun instant(): Instant millis [jvm]open override fun millis(): Long reset [jvm]open override fun reset() setNow [jvm]fun setNow(instant: Instant)Set the clock to the specified Instant. withZone [jvm]open override fun withZone(zone: ZoneId): Clock"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-fake-clock/","title":"FakeClock - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/FakeClock
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-fake-clock/#fakeclock","title":"FakeClock","text":"[jvm]\\
@JvmOverloads
constructor(epochMillis: Long = initialValue.toEpochMilli(), zone: ZoneId = ZoneId.of(\"UTC\"))
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/add/","title":"add - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/add
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/add/#add","title":"add","text":"[jvm]\\ fun add(d: Duration): Long
Advance the clock by specified Duration.
[jvm]\\ fun add(p: Period): Long
Advance the clock by the specified Period. Note that unlike adding a Duration the exact amount that is added to the clock will depend on its current time and timezone. Not all days, months or years have the same length. See the documentation for Period.
[jvm]\\ fun add(n: Long, unit: TimeUnit): Long
Advance the clock by specified amount n of TimeUnit.
//wisp-time-testing/wisp.time/FakeClock/getZone
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/get-zone/#getzone","title":"getZone","text":"[jvm]\\ open override fun getZone(): ZoneId
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/instant/","title":"instant - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/instant
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/instant/#instant","title":"instant","text":"[jvm]\\ open override fun instant(): Instant
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/reset/","title":"reset - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/reset
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/reset/#reset","title":"reset","text":"[jvm]\\ open override fun reset()
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/set-now/","title":"setNow - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/setNow
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/set-now/#setnow","title":"setNow","text":"[jvm]\\ fun setNow(instant: Instant)
Set the clock to the specified Instant.
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/with-zone/","title":"withZone - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/withZone
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/with-zone/#withzone","title":"withZone","text":"[jvm]\\ open override fun withZone(zone: ZoneId): Clock
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-companion/","title":"Companion - Misk","text":"//wisp-time-testing/wisp.time/FakeClock/Companion
"},{"location":"0.x/wisp-time-testing/wisp-time-testing/wisp.time/-fake-clock/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-token/","title":"wisp-token - Misk","text":"//wisp-token
"},{"location":"0.x/wisp-token/#wisp-token","title":"wisp-token","text":""},{"location":"0.x/wisp-token/#packages","title":"Packages","text":"Name wisp.token"},{"location":"0.x/wisp-token/wisp-token/wisp.token/","title":"Package-level declarations - Misk","text":"//wisp-token/wisp.token
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-token/wisp-token/wisp.token/#types","title":"Types","text":"Name Summary RealTokenGenerator [jvm]class RealTokenGenerator : TokenGenerator TokenGenerator [jvm]interface TokenGeneratorGenerates an secure, unguessable, alphanumeric token for use as a universally unique ID. Tokens are encoded with a https://www.crockford.com/wrmg/base32.html. This alphabet contains a mix of lowercase characters and digits and is resistant to decoding errors; for example0, o, and \u2018O\u2019 are equivalent."},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//wisp-token/wisp.token/RealTokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\ class RealTokenGenerator : TokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/#constructors","title":"Constructors","text":"RealTokenGenerator [jvm]constructor()"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/-real-token-generator/","title":"RealTokenGenerator - Misk","text":"//wisp-token/wisp.token/RealTokenGenerator/RealTokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/-real-token-generator/#realtokengenerator","title":"RealTokenGenerator","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/generate/","title":"generate - Misk","text":"//wisp-token/wisp.token/RealTokenGenerator/generate
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-real-token-generator/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/","title":"TokenGenerator - Misk","text":"//wisp-token/wisp.token/TokenGenerator
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/#tokengenerator","title":"TokenGenerator","text":"interface TokenGenerator
Generates an secure, unguessable, alphanumeric token for use as a universally unique ID. Tokens are encoded with a https://www.crockford.com/wrmg/base32.html. This alphabet contains a mix of lowercase characters and digits and is resistant to decoding errors; for example 0, o, and \u2018O\u2019 are equivalent.
For strength similar to a random UUID (122 bits of entropy), most callers should use the default length of 25 characters (125 bits). Using fewer characters risks collision, which may be acceptable for some use-cases. There is no practical benefit to using more than 25 characters.
In production, staging, and development environments tokens are always created using SecureRandom. These are some sample production tokens:
75dsma7kscyvbgz7ea1yy3qe8\n3zg6svk9hcpvqyhej41tdkaa0\ngv7s8nkevt9d7aw2eb06g640e\na17f7h6t853kzdqpc29qa8mnw\nIn tests tokens are sequential and predictable. They are prefixed with an optional label that appears in the returned string and can be used as a namespace. It is okay to hardcode expected tokens in test cases! These are some sample testing tokens:
cst0mer000000000000000035\npayment000000000000000034\ncst0mer000000000000000036\npayment000000000000000035\n//wisp-token/wisp.token/TokenGenerator/generate
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/generate/#generate","title":"generate","text":"[jvm]\\ abstract fun generate(label: String? = null, length: Int = 25): String
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/","title":"Companion - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/#companion","title":"Companion","text":"[jvm]\\ object Companion
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/#properties","title":"Properties","text":"Name Summary CANONICALIZE_LENGTH_MAX [jvm]const val CANONICALIZE_LENGTH_MAX: Int = 25 CANONICALIZE_LENGTH_MIN [jvm]const val CANONICALIZE_LENGTH_MIN: Int = 4"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/#functions","title":"Functions","text":"Name Summary canonicalize [jvm]fun canonicalize(token: String): StringReturns a token semantically equal totoken but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted."},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-a-x/","title":"CANONICALIZE_LENGTH_MAX - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion/CANONICALIZE_LENGTH_MAX
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-a-x/#canonicalize_length_max","title":"CANONICALIZE_LENGTH_MAX","text":"[jvm]\\ const val CANONICALIZE_LENGTH_MAX: Int = 25
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-i-n/","title":"CANONICALIZE_LENGTH_MIN - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion/CANONICALIZE_LENGTH_MIN
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/-c-a-n-o-n-i-c-a-l-i-z-e_-l-e-n-g-t-h_-m-i-n/#canonicalize_length_min","title":"CANONICALIZE_LENGTH_MIN","text":"[jvm]\\ const val CANONICALIZE_LENGTH_MIN: Int = 4
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/canonicalize/","title":"canonicalize - Misk","text":"//wisp-token/wisp.token/TokenGenerator/Companion/canonicalize
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/canonicalize/#canonicalize","title":"canonicalize","text":"[jvm]\\ fun canonicalize(token: String): String
Returns a token semantically equal to token but using only characters from the Crockford Base32 alphabet. This maps visually similar characters like o to the corresponding encoding character like 0. Spaces are omitted.
Call this when accepting tokens that may have been transcribed by a user. It is not necessary to canonicalize tokens that haven\u2019t been manually entered; they will already be in canonical form.
"},{"location":"0.x/wisp-token/wisp-token/wisp.token/-token-generator/-companion/canonicalize/#throws","title":"Throws","text":"IllegalArgumentException iftoken contains a character that cannot be mapped and that is not a space."},{"location":"0.x/wisp-token-testing/","title":"wisp-token-testing - Misk","text":"//wisp-token-testing
"},{"location":"0.x/wisp-token-testing/#wisp-token-testing","title":"wisp-token-testing","text":""},{"location":"0.x/wisp-token-testing/#packages","title":"Packages","text":"Name wisp.token"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/","title":"Package-level declarations - Misk","text":"//wisp-token-testing/wisp.token
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/#types","title":"Types","text":"Name Summary FakeTokenGenerator [jvm]class FakeTokenGenerator : TokenGenerator"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//wisp-token-testing/wisp.token/FakeTokenGenerator
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\ class FakeTokenGenerator : TokenGenerator
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/#constructors","title":"Constructors","text":"FakeTokenGenerator [jvm]constructor()"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/#functions","title":"Functions","text":"Name Summary generate [jvm]open override fun generate(label: String?, length: Int): String"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/-fake-token-generator/","title":"FakeTokenGenerator - Misk","text":"//wisp-token-testing/wisp.token/FakeTokenGenerator/FakeTokenGenerator
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/-fake-token-generator/#faketokengenerator","title":"FakeTokenGenerator","text":"[jvm]\\ constructor()
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/generate/","title":"generate - Misk","text":"//wisp-token-testing/wisp.token/FakeTokenGenerator/generate
"},{"location":"0.x/wisp-token-testing/wisp-token-testing/wisp.token/-fake-token-generator/generate/#generate","title":"generate","text":"[jvm]\\ open override fun generate(label: String?, length: Int): String
"},{"location":"0.x/wisp-tracing/","title":"wisp-tracing - Misk","text":"//wisp-tracing
"},{"location":"0.x/wisp-tracing/#wisp-tracing","title":"wisp-tracing","text":""},{"location":"0.x/wisp-tracing/#packages","title":"Packages","text":"Name wisp.tracing"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/","title":"Package-level declarations - Misk","text":"//wisp-tracing/wisp.tracing
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/#package-level-declarations","title":"Package-level declarations","text":""},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/#types","title":"Types","text":"Name Summary SpanAndScope [jvm]data class SpanAndScope(val span: Span, val scope: Scope) Tag [jvm]data class Tag<T>(val name: String, val value: T)A Tag is a name-value pair which will be added to a Span. Only primitive types are supported like Booleans, Numbers, and Strings."},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/#functions","title":"Functions","text":"Name Summary setBaggageItems [jvm]fun Span.setBaggageItems(baggage: Map<String, Any>)Conveniently sets baggage items all at once. Baggage values come from Any.toString. setTag [jvm]fun Span.setTag(tag: Tag<*>) setTags [jvm]fun Span.setTags(tags: Collection<Tag<*>>)Conveniently set tags all at once. trace [jvm]fun <T> Tracer.trace(spanName: String, tags: Map<String, String> = mapOf(), f: () -> T): TTraces a function f, using a span called spanName, which is automatically finished when the function completes execution. traceWithNewRootSpan [jvm]fun <T> Tracer.traceWithNewRootSpan(spanName: String, tags: Map<String, String> = mapOf(), retainBaggage: Boolean = false, f: (Span) -> T): TLike traceWithSpan, but always starts a new independent (root) span. If you\u2019d like to continue propagating baggage that was set on the previous active span, set retainBaggage to true. traceWithSpan [jvm]fun <T> Tracer.traceWithSpan(spanName: String, tags: Map<String, String> = mapOf(), f: (Span) -> T): TLike trace, but exposes the new active Span to f. withNewScope [jvm]inline fun <T> Tracer.withNewScope(span: Span, crossinline f: () -> T): TInstruments a function f with a new scope. This is helpful if you need to create a new Scope for an existing Span, for example, if you are switching threads (since Scopes are not thread-safe)."},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-baggage-items/","title":"setBaggageItems - Misk","text":"//wisp-tracing/wisp.tracing/setBaggageItems
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-baggage-items/#setbaggageitems","title":"setBaggageItems","text":"[jvm]\\ fun Span.setBaggageItems(baggage: Map<String, Any>)
Conveniently sets baggage items all at once. Baggage values come from Any.toString.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tag/","title":"setTag - Misk","text":"//wisp-tracing/wisp.tracing/setTag
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tag/#settag","title":"setTag","text":"[jvm]\\ fun Span.setTag(tag: Tag<*>)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tags/","title":"setTags - Misk","text":"//wisp-tracing/wisp.tracing/setTags
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/set-tags/#settags","title":"setTags","text":"[jvm]\\ fun Span.setTags(tags: Collection<Tag<*>>)
Conveniently set tags all at once.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-new-root-span/","title":"traceWithNewRootSpan - Misk","text":"//wisp-tracing/wisp.tracing/traceWithNewRootSpan
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-new-root-span/#tracewithnewrootspan","title":"traceWithNewRootSpan","text":"[jvm]\\ fun <T> Tracer.traceWithNewRootSpan(spanName: String, tags: Map<String, String> = mapOf(), retainBaggage: Boolean = false, f: (Span) -> T): T
Like traceWithSpan, but always starts a new independent (root) span. If you\u2019d like to continue propagating baggage that was set on the previous active span, set retainBaggage to true.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-span/","title":"traceWithSpan - Misk","text":"//wisp-tracing/wisp.tracing/traceWithSpan
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace-with-span/#tracewithspan","title":"traceWithSpan","text":"[jvm]\\ fun <T> Tracer.traceWithSpan(spanName: String, tags: Map<String, String> = mapOf(), f: (Span) -> T): T
Like trace, but exposes the new active Span to f.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace/","title":"trace - Misk","text":"//wisp-tracing/wisp.tracing/trace
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/trace/#trace","title":"trace","text":"[jvm]\\ fun <T> Tracer.trace(spanName: String, tags: Map<String, String> = mapOf(), f: () -> T): T
Traces a function f, using a span called spanName, which is automatically finished when the function completes execution.
If a span is already active, the new span is made a child of the existing one. If you want to manipulate the Span (e.g. to attach baggage), use traceWithSpan instead.
If you want a new independent span, use traceWithNewRootSpan.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/with-new-scope/","title":"withNewScope - Misk","text":"//wisp-tracing/wisp.tracing/withNewScope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/with-new-scope/#withnewscope","title":"withNewScope","text":"[jvm]\\ inline fun <T> Tracer.withNewScope(span: Span, crossinline f: () -> T): T
Instruments a function f with a new scope. This is helpful if you need to create a new Scope for an existing Span, for example, if you are switching threads (since Scopes are not thread-safe).
tracer.traceWithSpan(\"thread-switching-span\") {\n ...\n thread {\n tracer.withNewScope(span) { ... }\n }\n}\n//wisp-tracing/wisp.tracing/SpanAndScope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/#spanandscope","title":"SpanAndScope","text":"[jvm]\\ data class SpanAndScope(val span: Span, val scope: Scope)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/#constructors","title":"Constructors","text":"SpanAndScope [jvm]constructor(span: Span, scope: Scope)"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/#properties","title":"Properties","text":"Name Summary scope [jvm]val scope: Scope span [jvm]val span: Span"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/-span-and-scope/","title":"SpanAndScope - Misk","text":"//wisp-tracing/wisp.tracing/SpanAndScope/SpanAndScope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/-span-and-scope/#spanandscope","title":"SpanAndScope","text":"[jvm]\\ constructor(span: Span, scope: Scope)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/scope/","title":"scope - Misk","text":"//wisp-tracing/wisp.tracing/SpanAndScope/scope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/scope/#scope","title":"scope","text":"[jvm]\\ val scope: Scope
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/span/","title":"span - Misk","text":"//wisp-tracing/wisp.tracing/SpanAndScope/span
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-span-and-scope/span/#span","title":"span","text":"[jvm]\\ val span: Span
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/","title":"Tag - Misk","text":"//wisp-tracing/wisp.tracing/Tag
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/#tag","title":"Tag","text":"[jvm]\\ data class Tag<T>(val name: String, val value: T)
A Tag is a name-value pair which will be added to a Span. Only primitive types are supported like Booleans, Numbers, and Strings.
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/#constructors","title":"Constructors","text":"Tag [jvm]constructor(name: String, value: T)"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/#properties","title":"Properties","text":"Name Summary name [jvm]val name: String value [jvm]val value: T"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/-tag/","title":"Tag - Misk","text":"//wisp-tracing/wisp.tracing/Tag/Tag
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/-tag/#tag","title":"Tag","text":"[jvm]\\ constructor(name: String, value: T)
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/name/","title":"name - Misk","text":"//wisp-tracing/wisp.tracing/Tag/name
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/name/#name","title":"name","text":"[jvm]\\ val name: String
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/value/","title":"value - Misk","text":"//wisp-tracing/wisp.tracing/Tag/value
"},{"location":"0.x/wisp-tracing/wisp-tracing/wisp.tracing/-tag/value/#value","title":"value","text":"[jvm]\\ val value: T
"},{"location":"internals/graceful-shutdown/","title":"Shutdown Management","text":"In any application it is important to shut down gracefully, to avoid dropping already accepted work or creating inconsistent state. Misk handles this through use of a special ReadyService and its Service Manager Module
Misk ensures a graceful shutdown by dividing services into those that ingest or create work (e.g. SQS, Cron, Jetty), and those that are needed to process work (e.g. JDBC, Redis). To ensure the work created by an incoming API request, SQS subscription, cron job, or other work producing service is handled correctly even during shutdown, these services need
Because Misk cannot know ahead of time which services an application might or might not need, we cannot create hard dependencies from these work producing services to the various services needed for work processing. Instead, we configure the work producing services to depend on - and services needed for work processing to be enhanced by - the ReadyService, a special service that does no work but exists only to orchestrate a graceful shutdown.
By having work producing services depend on the ReadyService and work processing services enhanced by it, Misk will guarantee that services startup as follows:
ReadyServiceAt shutdown time, we walk the dependency graph in reverse, shutting down services as follows:
ReadyServiceThis ensures services that are needed for work processing remain up until all ingested work has been processed.
"},{"location":"internals/graceful-shutdown/#notes","title":"Notes","text":"Services in Misk can depend on other services. We need to reconcile these dependencies to ensure an orderly application startup and shutdown.
In the Misk framework, a service represents a component that starts and stops in coordination with the application\u2019s lifecycle. Services in Misk are typically used to manage tasks such as database connections, HTTP servers, or other long-running processes. They ensure that resources are correctly initialized when the application starts and properly released when it stops. Misk uses Google\u2019s Guava ServiceManager to handle these services, allowing for graceful startup, shutdown, and dependency management between different services.
"},{"location":"internals/service-management/#dependencies","title":"Dependencies","text":"Suppose we have a DatabaseService and a MovieService, with the MovieService depending on the DatabaseService.
DatabaseService\n depended on by MovieService\nWhen you install a service via this module, start-up and shut-down of its dependencies are handled automatically, so that a service can only run when the services it depends on are running. In the example above, the MovieService doesn\u2019t enter the STARTING state until the DatabaseService has entered the RUNNING state. Conversely, the MovieService must enter the TERMINATED state before the DatabaseService enters the STOPPING state.
Dependencies can have their own dependencies, so there\u2019s an entire graph to manage of what starts and stops when.
"},{"location":"internals/service-management/#enhancements","title":"Enhancements","text":"Some services exist to enhance the behavior of another service.
For example, a DatabaseService may manage a generic connection to a MySQL database, and the SchemaMigrationService may create tables specific to the application.
We treat such enhancements as implementation details of the enhanced service: they depend on the service, but downstream dependencies like the MovieService don\u2019t need to know that they exist.
DatabaseService\n enhanced by SchemaMigrationService\n depended on by MovieService\nIn the above service graph we start the DatabaseService first, the SchemaMigrationService second, and finally the MovieService. The MovieService doesn\u2019t need to express a dependency on the SchemaMigrationService, that happens automatically for enhancements.
This is a symbolic service that\u2019s useful to define the relationship, generally, between services which process traffic (i.e. Jetty) and infrastructure services (i.e. persistence stores).
By having the former depend on ReadyService and the latter enhanced by ReadyService we can force, for example, JettyService to stop before our feature flag service without having to intertwine our dependency graph.
In general, infrastructure services should enhance ReadyService and application services should depend on ReadyService.
See more information here here.
"},{"location":"internals/service-management/#what-does-this-look-like","title":"What does this look like?","text":""},{"location":"internals/service-management/#configuration","title":"Configuration","text":"Instead of using the regular service multi-bindings you might be used to, in the configure block of a Guice [KAbstractModule], you would set up the above relationship as follows:
override fun configure() {\n install(ServiceModule<SchemaMigrationService())\n install(\n ServiceModule<DatabaseService>()\n .enhancedBy<SchemaMigrationService>()\n )\n install(\n ServiceModule<MoviesService>()\n .dependsOn<DatabaseService>()\n )\n}\nBindings are hooked up for a ServiceManager provider, which decorates the service with its dependencies and enhancements to defer its start up and shut down until its dependent services are ready.
This service will stall in the STARTING state until all upstream services are RUNNING. Symmetrically it stalls in the STOPPING state until all dependent services are TERMINATED.
ServiceModule classTo migrate from Misk Metrics v1 to v2, please apply the following openrewrite recipe:
type: specs.openrewrite.org/v1beta/recipe\nname: misk.metrics.Migrator\ndisplayName: Migrate Misk Metrics V1\ndescription: Migrate from Misk Metrics v1 to v2\nrecipeList:\n - org.openrewrite.java.ChangeMethodName:\n methodPattern: misk.metrics.Metrics histogram(..)\n newMethodName: legacyHistogram\n matchOverrides: true\n - org.openrewrite.java.ChangeType:\n oldFullyQualifiedTypeName: misk.metrics.Metrics\n newFullyQualifiedTypeName: misk.metrics.v2.Metrics\nWisp is a collection of Misk modules providing various features and utilities, including config, logging, feature flags and more, but notably implemented generally without the use of Guice Direct Injection.
"},{"location":"wisp/#modules","title":"Modules","text":"Modules that are named ending in \u201cTesting\u201d are for test code and should never be used or included in production code.
For AWS information from the environment, with easy means for overrides for testing. Currently supports AWS Region and Account ID information.
Also see wisp-deployment-testing for the FakeEnvironmentVariableLoader to use in tests to set Fake environment variables.
"},{"location":"wisp/wisp-aws-environment/#usage","title":"Usage","text":"By default, the AWS Region will be read from either \u201cREGION\u201d or \u201cAWS_REGION\u201d environment variables.
val awsRegion: AwsRegion = AwsEnvironment.awsRegion() \nBy default, the AWS Account ID will be read from the \u201cACCOUNT_ID\u201d environment variable.
val awsAccountId: AccountId = AwsEnvironment.awsAccountId()\nUsing your own custom environment variables
val awsRegion: AwsRegion = AwsEnvironment.awsRegion(environmentVariables = listOf(\"MY_REGION_ENV_VAR\"))\nval awsAccountId: AccountId = AwsEnvironment.awsAccountId(environmentVariable = \"MY_ACCOUNT_ID_ENV_VAR\")\nDefault fallback for the AWS Region if the environment variable(s) are not set
val awsRegion: AwsRegion = AwsEnvironment.awsRegion(defaultAwsRegion = \"us-west-2\") \nHTTP clients with support for Envoy.
"},{"location":"wisp/wisp-client/src/main/java/wisp/client/","title":"Index","text":"We include java classes here as they\u2019re direct copies from okhttp\u2019s samples. These were taken from https://github.com/square/okhttp/tree/main/samples/unixdomainMaps/src/main/java/okhttp3/unixdomainsockets .
"},{"location":"wisp/wisp-config/","title":"wisp-config","text":"wisp-config is a wrapper for the Hoplite config library.
Config precedence is in order of sources added for loading, so if you want an environment config file to override values in the default file, it has to be added first.
Note that config values from Environment Variables, System Properties and User Settings are always loaded first, see: https://github.com/sksamuel/hoplite#property-sources for details.
Secrets in config are automatically handled, see: https://github.com/sksamuel/hoplite#masked-values
Note that if you are passing configuration fragments within Wisp, your config class should implement Config.
"},{"location":"wisp/wisp-config/#usage","title":"Usage","text":"The following example will load the config in the 2 files located on the classpath into the user defined MyConfig class.
data class MyConfig(\n val foo: Foo,\n val baz: String\n) : Config\n\ndata class Foo(\n val enabled: Boolean,\n val bar: Int\n)\n\nval configSources = listOf(\n ConfigSource(\"classpath:/myapp-config.yaml\"),\n ConfigSource(\"classpath:/myapp-defaults.yml\")\n)\nval myConfig : MyConfig = WispConfig.builder()\n .addWispConfigSources(configSources)\n .build()\n .loadConfigOrThrow<MyConfig>()\nAssume myapp-defaults.yml contains:
foo:\n enabled: true\n bar: 72\nbaz: \"abc\"\nAnd myapp-config.yaml contains:
foo:\n enabled: false\nThen the loaded MyConfig from the example above would be equivalent to:
val myConfig : MyConfig = MyConfig(\n foo = Foo(\n enabled = false,\n bar = 72\n ),\n baz = \"abc\"\n)\nCreate, start and stop containers for use in tests.
"},{"location":"wisp/wisp-containers-testing/#usage","title":"Usage","text":"The following example creates the \u201calpine\u201d container, starts and stops it.
val container = Container {\n withImage(\"alpine\")\n withName(\"alpine\")\n}\n\nval composer = Composer(\"alpine\", container)\ncomposer.start()\nassertTrue(composer.running.get())\ncomposer.stop()\nassertFalse(composer.running.get())\nThe following example composes Kafka and Zookeeper containers for testing. Kafka is exposed to the jUnit test via 127.0.0.1:9102. In this example, Zookeeper is not exposed to the test.
val zkContainer = Container {\n withImage(\"confluentinc/cp-zookeeper\")\n withName(\"zookeeper\")\n withEnv(\"ZOOKEEPER_CLIENT_PORT=2181\")\n}\nval kafka = Container {\n withImage(\"confluentinc/cp-kafka\")\n withName(\"kafka\")\n withExposedPorts(ExposedPort.tcp(port))\n withPortBindings(\n Ports().apply {\n bind(ExposedPort.tcp(9102), Ports.Binding.bindPort(9102))\n }\n )\n withEnv(\n \"KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181\",\n \"KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9102\"\n )\n}\nval composer = Composer(\"e-kafka\", zkContainer, kafka)\ncomposer.start()\nThis module provides information about the applications deployment and environment.
Deployment contains information on where the application is deployed, that is, in Production, Staging, Testing or Development environments.
Deployments can be created manually, or by examining an environment variable (default environment variable is ENVIRONMENT).
Also see wisp-deployment-testing for the FakeEnvironmentVariableLoader to use in tests to set Fake environment variables.
"},{"location":"wisp/wisp-deployment/#usage","title":"Usage","text":"The following manually creates a production Deployment
val deployment: Deployment = Deployment(\n \"My Deployment Name\",\n isProduction = true,\n isStaging = false,\n isTest = false,\n isLocalDevelopment = false\n)\nThere are 4 preset deployments: PRODUCTION, STAGING, TESTING and DEVELOPMENT. One of these will be returned if creating a deployment from the environment variable, with a default of DEVELOPMENT if the environment variable is not set.
val deployment: Deployment = Deployment.getDeploymentFromEnvironmentVariable()\n\nif (deployment.isProduction) {\n // this path will be executed\n}\n\nif (deployment.isDevelopment) {\n // this path will not be executed\n}\nFor testing, to set a specific Deployment, you can either create it manually, or override the environment variable using a FakeEnvironmentVariableLoader.
val environmentVariableLoader: FakeEnvironmentVariableLoader = \n FakeEnvironmentVariableLoader(mutableMapOf(\"ENVIRONMENT\" to \"Staging\"))\n\nval deployment = getDeploymentFromEnvironmentVariable(\n environmentVariableLoader = environmentVariableLoader\n)\n\nif (deployment.isStaging) {\n // this path will be executed\n}\nThis module provides a FakeEnvironmentVariableLoader as an implementation of the EnvironmentVariableLoader to use in tests to set Fake environment variables. Ideally, you should not use this package in any production code, but for test purposes only.
Also see wisp-deployment.
"},{"location":"wisp/wisp-deployment-testing/#usage","title":"Usage","text":"val environmentVariableLoader: FakeEnvironmentVariableLoader = \n FakeEnvironmentVariableLoader(\n mutableMapOf(\n \"ENVIRONMENT\" to \"Staging\",\n \"FOO\" to \"Bar\"\n )\n )\n\nval deployment = getDeploymentFromEnvironmentVariable(\n environmentVariableLoader = environmentVariableLoader\n)\n\nif (deployment.isStaging) {\n // this path will be executed\n}\n\n// foo will be \"Bar\"\nval foo = environmentVariableLoader.getEnvironmentVariable(\"FOO\")\n\n// Unknown env var will throw IllegalStateException\nval unknown = environmentVariableLoader.getEnvironmentVariable(\"Unknown\")\n\n// Unknown env var with a fallback value will return fallback instead of throwing IllegalStateException\nval unknownWithDefaultFallback = environmentVariableLoader.getEnvironmentVariable(\"UNKNOWN\", \"FALLBACK\") // \"FALLBACK\"\nFeatureFlags ....
See wisp-launchdarkly for more an implementation of FeatureFlags using LaunchDarkly.
See wisp-feature-testing for details on a Fake implementation for use in tests.
"},{"location":"wisp/wisp-feature/#usage-strongly-typed","title":"Usage - Strongly Typed","text":""},{"location":"wisp/wisp-feature/#basic-usage","title":"Basic Usage","text":"Step 1: Define your feature flag in Launch Darkly
Step 2: Define the flag in your code:
data class MissleButtonShouldBeEnabled(\n // Put the launch darkly key and attributes here, use real types!\n val customerId: String,\n val region: Region,\n val cardBin: CardBIN,\n) : BooleanFeatureFlag { // Also available: String, Double, Int, Enum, Json\n // `feature` needs to match the feature name in LaunchDarkly\n override val feature = Feature(\"missle-button-should-be-enabled\")\n\n // `key` should be the field you want to use as the LaunchDarkly key\n override val key = customerId\n\n // `attributes` should contain all the other fields, except for `key`. \n //\n // If using LaunchDarkly, these will be sent as custom attributes.\n override val attributes = Attributes()\n .with(\"cardBin\", cardBin.toString()) // `with` supports `String` and `Number`\n .with(\"region\", region.toString())\n}\nStep 3: Use your flag (MissleButtonShouldBeEnabled) with a wisp-feature client (i.e. wisp-launchdarkly or wisp-feature-testing):
val featureFlags: FeatureFlags = ??? // see `wisp-launchdarkly` or `wisp-feature-testing` for how to get `featureFlags`\n\n// `get`s return type depends on the flag type, in this case it's `Boolean`\nval enableMissleButton = featureFlags.get(\n MissileButtonShouldBeEnabled(\n customerId = \"customer-1234\",\n region = Region.Australia,\n cardBin = CardBIN(\"451213\")\n )\n)\n\n// ... do things with `enableMissleButton`\ndata class DomainObject(val name: String, val age: Int)\n\ndata class FeatureFlagThatReturnsJson(\n // Put launch darkly key and attributes here, same as usual. \n val customerId: String,\n val region: Region\n) : JsonFeatureFlag<DomainObject> {\n // `feature` needs to match the feature name in LaunchDarkly\n override val feature = Feature(\"missle-button-should-be-enabled\")\n\n // `key` should be the field you want to use as the LaunchDarkly key\n override val key = customerId\n\n // `attributes` should contain all the other fields, except for `key`. \n //\n // If using LaunchDarkly, these will be sent as custom attributes.\n override val attributes = Attributes()\n .with(\"region\", region.toString())\n\n // `returnType` need to match the generic type provided to `JsonFeatureFlag \n override val returnType = DomainObject::class.java \n}\nCalling get(FeatureFlagThatReturnsJson(...)) will return a DomainObject
Want to get on the strongly-typed hype train? Fantastic! Here\u2019s what you need to do:
getString/getBoolean/getX.getString/getBoolean/getX with a call to get using the flagoverride(String)/override(Boolean)/override(X) with override<MyStrongFlag>For example, consider this existing legacy implementation:
// FILE: ApplicationFeatureFlags.kt\nval MY_FEATURE_FLAG = Feature(\"my-feature-flag\")\n\n// FILE: MyService.kt\nclass MyService(private val featureFlags: FeatureFlags) {\n // Business logic function that uses feature flags\n fun getInstructions(customerId: String): String {\n val myFeatureFlagEnabled = featureFlags.getBoolean(\n feature = MY_FEATURE_FLAG,\n key = customerId,\n attributes = Attributes(\n mapOf(\n \"region\" to Region.Australia.toString()\n )\n )\n )\n\n return if (myFeatureFlagEnabled) {\n \"my feature is enabled\"\n } else {\n \"my feature is disabled\"\n }\n }\n}\n\n// FILE: MyServiceTest.kt\nclass MyServiceTest() {\n @Test fun `my service should say the feature is enabled for mary, but disabled otherwise`() {\n val featureFlags = FakeFeatureFlags()\n .override(MY_FEATURE_FLAG, false)\n .override(MY_FEATURE_FLAG, \"mary\", true)\n\n val service = MyService(featureFlags)\n service.getInstruction(\"bob\").shouldBe(false)\n service.getInstruction(\"mary\").shouldBe(true)\n }\n}\nLooking at MyService we can see that this is a Boolean flag (since we are using getBoolean), the key is customerId and we have one attribute called region. Now we can migrate:
// FILE: ApplicationFeatureFlags.kt\ndata class MyFeatureFlag(\n // We include the key and attributes we identified before\n customerId: String,\n region: Region\n): BooleanFeatureFlag { \n // `feature` should be whatever `MY_FEATURE_FLAG` was before\n override val feature = Feature(\"my-feature-flag\")\n\n // `key` should be the field we identified as the key from before\n override val key = customerId\n\n // `attributes` should contain all the other fields we identified\n // before\n override val attributes = Attributes()\n .with(\"region\", region.toString())\n}\n\n// FILE: MyService.kt\nclass MyService(private val featureFlags: FeatureFlags) {\n // Business logic function that uses feature flags\n fun getInstructions(customerId: String): String {\n val myFeatureFlagEnabled = featureFlags.get( // <-- `get` instead of `getBoolean`\n MyFeatureFlag(customerId, Region.Australia)\n )\n\n return if (myFeatureFlagEnabled) {\n \"my feature is enabled\"\n } else {\n \"my feature is disabled\"\n }\n }\n}\n\n// FILE: MyServiceTest.kt\nclass MyServiceTest() {\n @Test fun `my service should say the feature is enabled for mary, but disabled otherwise`() {\n val featureFlags = FakeFeatureFlags()\n .override<MyFeatureFlag>(false)\n .override<MyFeatureFlag>(true) { it.customerId == \"mary\" }\n\n val service = MyService(featureFlags)\n service.getInstruction(\"bob\").shouldBe(false)\n service.getInstruction(\"mary\").shouldBe(true)\n }\n}\n// TODO - usages...\nFake implementation of FeatureFlags.
See wisp-feature for more details on feature flags.
"},{"location":"wisp/wisp-feature-testing/#usage-strongly-typed","title":"Usage - Strongly Typed","text":""},{"location":"wisp/wisp-feature-testing/#step-1-define-a-feature-flag-as-described-in-wisp-feature","title":"Step 1: Define a feature flag as described in wisp-feature","text":""},{"location":"wisp/wisp-feature-testing/#step-2-use-the-feature-flag-in-your-code","title":"Step 2: Use the feature flag in your code:","text":"For example, you might have a service like this:
class ThingToTest(private val featureFlags: FeatureFlags) {\n fun getInstructions(customerId: String): String {\n val missileButtonEnabled = featureFlags.get(\n MissileButtonShouldBeEnabled(\n customerId = customerId,\n region = Region.Australia,\n cardBin = CardBIN(\"451213\") \n ) \n ) \n\n return if (missleButtonEnabled) {\n \"Press the missile button\" \n } else {\n \"Panic!\" \n }\n } \n}\nFakeFeatureFlags to test ThingToTest:","text":"class ThingToTestTests {\n @Test \n fun `it should tell me to press the button if the missile button is enabled`() {\n val featureFlags = FakeFeatureFlags()\n .override<MissileButtonShouldBeEnabled>(true)\n\n val thing = ThingToTest(featureFlags) \n\n thing.getInstructions(customerId = \"fred\").shouldBe(\"Press the missile button\")\n }\n\n @Test \n fun `it should tell me to panic if the missile button is not enabled`() {\n val featureFlags = FakeFeatureFlags()\n .override<MissileButtonShouldBeEnabled>(false)\n\n val thing = ThingToTest(featureFlags)\n\n thing.getInstructions(customerId = \"alice\").shouldBe(\"Panic!\")\n }\n}\nSometimes you want to say \u201conly enable the missile button for Mary\u201d. The override function has an optional matcher value that must be true for the override to match.
class ThingToTestTests {\n @Test\n fun `it should tell mary to press the button`() {\n val featureFlags = FakeFeatureFlags()\n .override<MissileButtonShouldBeEnabled>(true) { it.customerId == \"mary\" }\n\n val thing = ThingToTest(featureFlags)\n\n thing.getInstructions(customerId = \"mary\").shouldBe(\"Press the missile button\")\n }\n}\n// TODO - usages...\nFeatureFlags implementation using LaunchDarkly.
See wisp-feature for more details on feature flags.
See wisp-feature-testing for details on a Fake implementation for use in tests.
"},{"location":"wisp/wisp-launchdarkly/#usage","title":"Usage","text":"// create your LaunchDarkly config (or load it using wisp-config)\nval config = LaunchDarklyConfig(sdk_key = \"...\", base_uri = \"...\")\n\nval sslLoader = SslLoader(ResourceLoader.SYSTEM)\nval sslContextFactory = SslContextFactory(sslLoader)\n\n// create the LaunchDarkly client\nval ldClient = LaunchDarklyClient.createLaunchDarklyClient(\n config = config,\n sslLoader = sslLoader,\n sslContextFactory = sslContextFactory,\n resourceLoader = ResourceLoader.SYSTEM\n)\n\nval moshi = DEFAULT_KOTLIN_MOSHI\n\nval ldFeatureFlags = LaunchDarklyFeatureFlags(\n ldClient = ldClient,\n moshi = moshi\n)\n\n// TODO - usages...\nThis module contains the interfaces for leases. A lease can be used to fence code to ensure it is run only in the application holding the lease.
Also in this module is a lease pool implementation. Only one lease from a lease pool can be acquired on each application instance. It delegates as required to a real implementation for the lease operations.
TODO: Link to real implementation of wisp-lease\u2026
See wisp-lease-testing for a Fake lease implementation for use in tests.
"},{"location":"wisp/wisp-lease/#usage","title":"Usage","text":""},{"location":"wisp/wisp-lease/#general-lease-usage","title":"General Lease Usage","text":"val leaseManager: LeaseManager = SomeLeaseManagerImplementation()\n\n// request a lease\nval lease = leaseManager.requestLease(\"MY LEASE\")\n\n// acquire the lease\nif (lease.acquire()) {\n // got the lease....\n}\n\n// check if the lease is held (might have timed out, etc)\nif (lease.checkHeld()) {\n // lease is held\n}\n\n// add a listener and test if the lease is held...\nval leaseHeld = AtomicBoolean()\nlease.addListener(object : Lease.StateChangeListener {\n override fun afterAcquire(lease: Lease) {\n // lease should be held at this point, but it's best to check\n if (lease.checkHeld()) {\n leaseHeld.set(true)\n }\n }\n\n override fun beforeRelease(lease: Lease) {}\n})\n\nassertThat(leaseHeld.get()).isTrue()\n\n// release the lease explicitly\nlease.release()\nval deployment: Deployment = Deployment.getDeploymentFromEnvironmentVariable()\nval leaseManager: LeaseManager = SomeLeaseManagerImplementation()\n\nval poolLeaseConfig = PoolLeaseConfig(POOL_NAME, listOf(LEASE_NAME, ANOTHER_LEASE_NAME))\nval poolLeaseManager = PoolLeaseManager(leaseManager, deployment, listOf(poolLeaseConfig))\n\n// use as normal - only LEASE_NAME or ANOTHER_LEASE_NAME can ever be acquired, not both at the same time\nProvides a FakeLeaseManager as an implement of the LeaseManager for testing.
"},{"location":"wisp/wisp-lease-testing/#usage","title":"Usage","text":"val fakeLeaseManager = FakeLeaseManager()\n\n// use in tests instead of a real implementation of LeaseManager\nval myRealAppClass = MyRealAppClass(leaseManager = fakeLeaseManager)\n\n// requesting a lease gives a FakeLease (just use the interface in most cases)\nval lease: Lease = fakeLeaseManager.requestLease(\"YourLeaseName\")\nval fakeLease: FakeLease = lease as FakeLease\n\n// by default leases are held unless marked otherwise, so this would change nothing at this point\nfakeLeaseManager.markLeaseHeld(\"YourLeaseName\")\n\n// to mark the lease held somewhere else\nfakeLeaseManager.markLeaseHeldElsewhere(\"YourLeaseName\")\nassertThat(lease.checkHeld()).isFalse()\nassertThat(lease.acquire()).isFalse()\n\n// add a listener and test if the lease is held...\nval leaseHeld = AtomicBoolean()\nlease.addListener(object : Lease.StateChangeListener {\n override fun afterAcquire(lease: Lease) {\n if (lease.checkHeld()) {\n leaseHeld.set(true)\n }\n }\n\n override fun beforeRelease(lease: Lease) {}\n})\n\nassertThat(leaseHeld.get()).isTrue()\nConvenience functions on top of kotlin-logging.
"},{"location":"wisp/wisp-logging/#usage","title":"Usage","text":""},{"location":"wisp/wisp-logging/#mdc","title":"MDC","text":"Use this library to easily set MDC per log entry:
private val logger = getLogger<LoggingTest>()\n\nlogger.info(\n \"user-id\" to \"blerb\", \n \"alias-id\" to \"d6F1EF53\"\n) { \"tagged info\" }\nOtherwise, this library falls back to kotlin-logging:
logger.info { \"some logs\" }\nUse this library to sample down the volume of logs produced the logger:
private val logger = getLogger<LoggingTest>().sampled()\nBy default, this will logger will be rate limited to 1 log per second, but a custom Sampler can be provided if a different rate or policy is required:
private val logger = getLogger<LoggingTest>().sampled(Sampler.rateLimiting(500L))\nCaptures Logback logs to make it possible to do assertions on them.
"},{"location":"wisp/wisp-logging-testing/#usage","title":"Usage","text":"The sample code block below assumes AssertJ, but this library is not tied to a particular test framework or assertions library.
class MyClass {\n fun log() {\n val logger = getLogger<MyClass>()\n logger.info(\"this is a log message!\")\n }\n}\n\nfun `test that logs are captured`() {\n val logCollector = WispQueuedLogCollector()\n\n // Usually put this in a Before block.\n logCollector.startUp()\n\n // Test messages:\n MyClass().log()\n // takeMessages and takeEvents consume log entries.\n assertThat(logCollector.takeMessages()).containsExactly(\"this is a log message!\")\n\n // Test other log data, e.g. MDC:\n MyClass().log()\n // Because the first log() call was consumed, takeEvents only returns one event.\n assertThat(logCollector.takeEvents())\n .extracting(Function { it.mdcPropertyMap })\n .containsExactly(mapOf())\n\n // It's also possible to test that nothing is logged.\n assertThat(logCollector.takeMessages()).isEmpty()\n\n // Usually put this in an After block.\n logCollector.shutDown()\n}\nThis module provides Moshi related features, including a kotlin extension for JSON adapters and a default Moshi build that includes the KotlinJsonAdapterFactory
"},{"location":"wisp/wisp-resource-loader/","title":"wisp-resource-loader","text":"A testable way to load resources. See ResourceLoader for documentation.
Also see wisp-resource-loader-testing .
"},{"location":"wisp/wisp-resource-loader/#usage","title":"Usage","text":"val resourceLoader: ResourceLoader = ResourceLoader(\n mapOf(\n \"classpath:\" to ClasspathResourceLoaderBackend,\n \"memory:\" to MemoryResourceLoaderBackend(),\n \"filesystem:\" to FilesystemLoaderBackend,\n \"environment:\" to EnvironmentLoaderBackend,\n )\n)\n\nval resource = resourceLoader.utf8(\"classpath:/wisp/resources/ResourceLoaderTest.txt\")\nIncludes a way to fake filesystem resources loaded via wisp-resource-loader.
"},{"location":"wisp/wisp-resource-loader-testing/#usage","title":"Usage","text":"val loader = ResourceLoader(\n mapOf(\n \"filesystem:\" to FakeFilesystemLoaderBackend(\n mapOf(\n \"/some/test/file\" to \"test data!\"\n )\n )\n )\n)\n\n// This will load from the in-memory map rather than the filesystem.\nval data = loader.utf8(\"filesystem:/some/test/file\")\nUtilities for sampling and rate limiting actions.
"},{"location":"wisp/wisp-sampling/#usage","title":"Usage","text":"A Sampler can be used to test if an action is allowed based on a particular policy.
The rate limiting sampler allows a given number of samples per second:
val sampler = Sampler.rateLimiting(1L);\n\nif (sampler.sample()) {\n performAction()\n}\nThe percentage sampler allows the given percentage of samples:
val sampler = Sampler.percentage(50);\n\nif (sampler.sample()) {\n performAction()\n}\nThe always sampler allows all samples:
val sampler = Sampler.always();\n\nif (sampler.sample()) {\n performAction()\n}\nLoads and parses SSL certificates into a KeyStore . See SslLoader for a complete API.
This library is mostly only useful for other libraries that want to use ResourceLoader under the hood.
"},{"location":"wisp/wisp-ssl/#usage","title":"Usage","text":"val sslLoader: SslLoader = SslLoader(ResourceLoader.SYSTEM)\n\nval certStore = sslLoader.loadCertStore(\n \"classpath:/ssl/client_cert_key_combo.pem\",\n SslLoader.Companion.FORMAT_PEM,\n \"password\"\n)\nThis module contains code to assist with running tasks.
RepeatedTask runs a repeated task at the user controlled rate based on the kotlin-retry library. For convenience a RepeatedTaskManager is available to help manage the RepeatedTasks.
It\u2019s possible to specify your own retry policy for the task. See kotlin-retry library for more details and examples. The default retry policy instructions are to retry on all exceptions with a Binary Exponential backoff delay - which itself is configured from the supplied RepeatedTaskConfig .
"},{"location":"wisp/wisp-task/#usage","title":"Usage","text":"Create a repeated task and start it running.
val repeatedTaskConfig = RepeatedTaskConfig(\n timeBetweenRunsMs = 10000L // 10 sec delay between task runs or retries\n)\n\nval manager = RepeatedTaskManager()\n\nval newTask = manager.createTask(\n name = \"taskName\",\n repeatedTaskConfig = repeatedTaskConfig,\n) { name: String, taskConfig: TaskConfig ->\n // do task stuff\n // ...\n\n // if the task completes correctly, return OK.\n Status.OK\n}\n\nnewTask.startUp()\nYou can shutdown a task or the manager which will shutdown all tasks. Using the above code:
// shut down the repeated task.\nnewTask.shutDown()\n\n// shut down all repeated tasks known by the manager.\nmanager.shutDown()\nThe task to be run takes a TaskConfig (which could be loaded using wisp-config).
class MyTaskConfig(\n val foo: String,\n val allResults: MutableList<String> = mutableListOf()\n): TaskConfig()\n\nval taskName = \"myTask\"\nval anotherTask = manager.createTask(\n name = taskName,\n repeatedTaskConfig = repeatedTaskConfig,\n taskConfig = MyTaskConfig(\"fooString\")\n) { name: String, taskConfig: TaskConfig ->\n val config = taskConfig as MyTaskConfig\n\n // access the taskConfig\n println(\"Foo is ${config.foo}\")\n\n // do task stuff\n // ...\n config.allResults.add(\"another result\")\n\n // if the task completes correctly, return OK.\n Status.OK\n}\nProvides a FakeClock, an implementation of java.time.Clock that can be manipulated for testing components with logic that relies on clocks.
val clock = FakeClock()\n\nval foo = ThingThatNeedsClock(clock)\nfoo.doSomething()\nclock.add(2, TimeUnit.SECOND)\nfoo.doSomething()\nThis module contains code to do token generation.
For details on the generation used, see TokenGenerator
"},{"location":"wisp/wisp-token/#usage","title":"Usage","text":"val tokenGenerator = RealTokenGenerator() \nval label = \"some label\"\nval length = 7 // 4 to 25\nval token = tokenGenerator.generate(label, length)\nThis module contains code to do token generation for testing.
For details on the generation used, see TokenGenerator
"},{"location":"wisp/wisp-token-testing/#usage","title":"Usage","text":"val tokenGenerator = FakeTokenGenerator() \nval label = \"some label\"\nval length = 7 // 4 to 25\nval token = tokenGenerator.generate(label, length)\nConvenience functions on top of opentracing Java APIs.
"},{"location":"wisp/wisp-tracing/#usage","title":"Usage","text":"Use this library to easily set up and manipulate traces.
import wisp.tracing.trace\n\ntracer.trace(\"span-name\") {\n // This block is instrumented with a scope and span.\n doSomething()\n // They are automatically closed and finished at the end.\n}\nThis module provides a concurrency-safe io.opentracing.mock.MockTracer as a testFixture. Use it with:
testImplementation(testFixtures(\"app.cash.wisp:wisp-tracing:$version\"))\nScopes are not thread-safe, so you need to set up a new scope before switching threads.
import wisp.tracing.traceWithSpan\nimport wisp.tracing.withNewScope\n\ntracer.traceWithSpan(\"multiple-threads\") { span ->\n thread { \n // withNewScope() gives you a new Scope with the same span.\n // the scope is closed at the end of the block. \n tracer.withNewScope(span) {\n doSomething()\n } \n }\n}\nEasily create child spans. Nested calls to trace/traceWithSpan implicitly create parent-child span relationships.
import wisp.tracing.trace\n\ntracer.trace(\"parent-span\") {\n // Create a new child span and finish it as soon as block finishes.\n tracer.trace(\"child-span\") {\n doSomething()\n }\n}\nNew root spans can be created from inside parent spans. These will show up independent of the parent context.
import wisp.tracing.trace\nimport wisp.tracing.traceWithNewRootSpan\n\ntracer.trace(\"universe\") {\n tracer.traceWithNewRootSpan(\"root\") {\n // Not a child.\n }\n}\nAdd all your tags at once, instead of processing and adding them one tag at a time. All primitive type tags are supported.
import wisp.tracing.traceWithSpan\nimport wisp.tracing.setTags\nimport wisp.tracing.Tag\n\n// Use typed tags.\ntracer.traceWithSpan(\"tags-example\") {\n span.setTags(listOf(\n Tag(\"string-tag\", \"string-value\"),\n Tag(\"int-tag\", 9999),\n Tag(\"bool-tag\", true)\n ))\n}\n\n// Or just use string tags.\ntracer.trace(\"tags-example\", tags = mapOf(\"a\" to \"b\")) {\n doSomething()\n}\nAdd all your baggage at once, instead of processing and adding it one piece at a time. This information will be available in downstream traces. Baggage can be anything, but will always be converted to a String.
import wisp.tracing.setBaggageItems\nimport wisp.tracing.traceWithSpan\n\ntracer.traceWithSpan(\"baggage-example\") { span ->\n span.setBaggageItems(\n mapOf(\n \"string-baggage\" to \"foo\",\n \"int-baggage\" to 9999,\n \"json-baggage\" to moshi.adapter(Dinosaur::class.java).toJson(trex)\n )\n )\n\n doSomething()\n}\nSometimes you may want to retain baggage from a parent context on smaller, independent traces.
import wisp.tracing.setBaggageItems\nimport wisp.tracing.traceWithSpan\nimport wisp.tracing.traceWithNewRootSpan\n\ntracer.traceWithSpan(\"has-baggage-context\") { span ->\n span.setBaggageItems(mapOf(\"string-baggage\" to \"foo\"))\n tracer.traceWithNewRootSpan(\"new-root-span\", retainBaggage = true) { newSpan ->\n assert(span.context().baggageItems().first() == newSpan.context().baggageItems().first())\n }\n}\n